Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.43
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 11: <div class="titlepage">
12: <div>
13: <div><h1 class="title">
14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
16: <div><div class="authorgroup">
17: <div class="author">
18: <h3 class="author">
19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
20: </h3>
1.10 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.4 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
82: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
83: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
84: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
85: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
86: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
87: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
88: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
89: </dl></dd>
90: </dl></dd>
91: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
92: <dd><dl>
93: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
94: <dd><dl>
95: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
96: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
97: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
98: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
99: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
100: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
101: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
102: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
103: </dl></dd>
104: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
105: <dd><dl>
106: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
107: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
108: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
109: </dl></dd>
110: </dl></dd>
111: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
112: <dd><dl>
113: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
114: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 115: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 116: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 117: <dd><dl>
1.4 rillig 118: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 119: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
120: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 121: </dl></dd>
1.4 rillig 122: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
123: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 124: </dl></dd>
125: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
126: <dd><dl>
127: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
128: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 129: </dl></dd>
130: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
131: builds)</a></span></dt>
1.1 dsieger 132: <dd><dl>
1.6 rillig 133: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
134: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
135: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
136: <dd><dl>
137: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
138: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
139: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
140: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
141: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
142: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
143: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
144: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
145: </dl></dd>
146: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 147: <dd><dl>
148: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
149: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
150: </dl></dd>
1.6 rillig 151: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
152: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
153: </dl></dd>
154: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
155: <dd><dl>
1.23 wiz 156: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
157: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 158: </dl></dd>
159: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
160: <dd><dl>
161: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
162: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
163: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
164: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
165: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
166: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
167: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23 wiz 168: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6 rillig 169: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23 wiz 170: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
171: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
172: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.6 rillig 173: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
174: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
175: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23 wiz 176: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6 rillig 177: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.23 wiz 178: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 179: </dl></dd>
180: </dl></dd>
181: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
182: <dd><dl>
1.6 rillig 183: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 184: <dd><dl>
1.6 rillig 185: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 186: <dd><dl>
1.6 rillig 187: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
188: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17 imil 189: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 190: </dl></dd>
1.6 rillig 191: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
192: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
193: </dl></dd>
194: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
195: <dd><dl>
1.23 wiz 196: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
197: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 198: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
199: <dd><dl>
200: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
201: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
202: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
203: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
205: </dl></dd>
206: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
207: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
208: <dd><dl>
209: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
210: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
211: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
212: </dl></dd>
1.23 wiz 213: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
214: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 215: </dl></dd>
1.23 wiz 216: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 217: <dd><dl>
218: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 219: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 220: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
221: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
222: <dd><dl>
223: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
224: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
225: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
226: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
227: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
228: </dl></dd>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 233: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
234: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 235: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
236: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 237: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 238: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
239: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
240: </dl></dd>
241: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 244: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 245: <dd><dl>
246: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 247: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
248: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
249: and
250: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
251: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 252: </dl></dd>
1.23 wiz 253: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 254: <dd><dl>
1.23 wiz 255: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 256: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
257: </dl></dd>
258: </dl></dd>
259: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
262: <dd><dl>
263: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
264: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
265: </dl></dd>
266: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
267: <dd><dl>
1.23 wiz 268: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 269: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
270: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
271: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
272: </dl></dd>
273: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
274: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
275: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
276: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
277: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
278: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
279: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
280: </dl></dd>
281: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
282: <dd><dl>
283: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 284: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 285: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 286: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 287: </dl></dd>
288: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
289: <dd><dl>
290: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
291: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
292: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
293: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 294: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 295: <dd><dl>
296: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
297: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
298: </dl></dd>
1.23 wiz 299: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
304: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
305: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
306: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
307: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
308: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 309: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
310: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
311: </dl></dd>
312: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
315: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
316: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
317: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
318: </dl></dd>
319: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
320: <dd><dl>
321: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
322: <dd><dl>
323: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 324: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6 rillig 325: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
326: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
327: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
328: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
329: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
330: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
331: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
332: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
333: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
334: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
335: </dl></dd>
1.23 wiz 336: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 337: <dd><dl>
338: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
339: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
340: </dl></dd>
1.23 wiz 341: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 342: <dd><dl>
343: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
344: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
345: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
346: </dl></dd>
347: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
348: <dd><dl>
349: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
350: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
351: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 352: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
353: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 354: </dl></dd>
1.23 wiz 355: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 356: <dd><dl>
357: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
358: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 359: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 360: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
361: </dl></dd>
1.23 wiz 362: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 363: <dd><dl>
364: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
365: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
366: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
367: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
368: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
369: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
370: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
371: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 372: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 373: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 374: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
375: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
376: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
377: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
378: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
379: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
380: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
381: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 382: emulation</a></span></dt>
1.6 rillig 383: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
384: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 385: </dl></dd>
1.6 rillig 386: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 387: </dl></dd>
1.6 rillig 388: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
389: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 390: <dd><dl>
1.6 rillig 391: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
392: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
393: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 394: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 395: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 396: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
397: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 398: </dl></dd>
399: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
400: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
401: <dd><dl>
402: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
403: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
404: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
405: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 406: </dl></dd>
407: </dl></dd>
408: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
409: <dd><dl>
1.6 rillig 410: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 411: <dd><dl>
1.6 rillig 412: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
413: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
414: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 415: <dd><dl>
1.6 rillig 416: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
417: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 418: </dl></dd>
1.6 rillig 419: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
420: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 421: <dd><dl>
1.6 rillig 422: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
423: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 424: </dl></dd>
1.6 rillig 425: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 426: <dd><dl>
1.23 wiz 427: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
428: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 429: </dl></dd>
430: </dl></dd>
1.6 rillig 431: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 432: <dd><dl>
1.6 rillig 433: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
434: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
435: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 436: <dd><dl>
1.6 rillig 437: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
438: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 439: </dl></dd>
440: </dl></dd>
1.6 rillig 441: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 442: <dd><dl>
1.6 rillig 443: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
444: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 445: </dl></dd>
446: </dl></dd>
447: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
448: <dd><dl>
449: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
452: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
453: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 454: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 455: </dl></dd>
456: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
457: </dl></dd>
458: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
459: <dd><dl>
460: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
461: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
462: </dl></dd>
463: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
464: <dd><dl>
1.23 wiz 465: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
466: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
467: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
468: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
469: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
470: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 471: source packages</a></span></dt>
472: </dl></dd>
473: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
474: <dd><dl>
475: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
476: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
477: </dl></dd>
478: </dl>
479: </div>
480: <div class="list-of-tables">
481: <p><b>List of Tables</b></p>
482: <dl>
483: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
484: </dt>
1.6 rillig 485: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 486: </dt>
1.6 rillig 487: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 488: </dt>
489: </dl>
490: </div>
1.41 asau 491: <div class="chapter">
492: <div class="titlepage"><div><div><h1 class="title">
493: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 494: <div class="toc">
495: <p><b>Table of Contents</b></p>
496: <dl>
497: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
498: <dd><dl>
499: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
500: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
501: </dl></dd>
502: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
503: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
504: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
505: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
506: </dl>
507: </div>
1.41 asau 508: <div class="sect1">
1.1 dsieger 509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
510: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
511: <p>There is a lot of software freely available for Unix-based
512: systems, which is usually available in form of the source code. Before
513: such software can be used, it needs to be configured to the local
514: system, compiled and installed, and this is exactly what The NetBSD
515: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
516: to handle binary packages, so that not every user has to build the
517: packages for himself, which is a time-costly task.</p>
518: <p>pkgsrc currently contains several thousand packages,
519: including:</p>
1.41 asau 520: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 521: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.1 dsieger 522: web server</p></li>
1.23 wiz 523: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1 dsieger 524: web browser</p></li>
1.23 wiz 525: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1 dsieger 526: Desktop Environment</p></li>
1.23 wiz 527: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.1 dsieger 528: Desktop Environment</p></li>
529: </ul></div>
530: <p>...just to name a few.</p>
531: <p>pkgsrc has built-in support for handling varying dependencies,
532: such as pthreads and X11, and extended features such as IPv6 support on
533: a range of platforms.</p>
1.41 asau 534: <div class="sect2">
1.1 dsieger 535: <div class="titlepage"><div><div><h3 class="title">
536: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
537: <p>
538: pkgsrc provides the following key features:
539: </p>
1.41 asau 540: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 541: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 542: and installation of binary packages. The source and latest
543: patches are retrieved from a master or mirror download site, checksum
544: verified, then built on your system. Support for binary-only
545: distributions is available for both native platforms and NetBSD
546: emulated platforms.</p></li>
1.23 wiz 547: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 548: including binaries, libraries, man pages and other
549: documentation.</p></li>
1.23 wiz 550: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1 dsieger 551: are handled automatically. The configuration files of various
552: packages are handled automatically during updates, so local changes
553: are preserved.</p></li>
1.23 wiz 554: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 555: consists of highly portable code. This allows the greatest speed of
1.25 spz 556: development when porting to a new platform. This portability also
1.1 dsieger 557: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
558: platforms</em></span>.</p></li>
1.23 wiz 559: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 560: international encryption requirements and build-time options for a
561: large number of packages are all set in a simple, central
562: configuration file.</p></li>
1.23 wiz 563: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 564: freely available under a BSD license, so you may extend and adapt
565: pkgsrc to your needs. Support for local packages and patches is
566: available right out of the box, so you can configure it specifically
567: for your environment.</p></li>
568: </ul></div>
569: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 570: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 571: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 572: — That means, if a package contains bugs, it's better to find
1.1 dsieger 573: them and to complain about them rather than to just install the package
574: and hope that it works. There are numerous checks in pkgsrc that try to
575: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
576: of shell scripts), and post-installation checks (installed files,
577: references to shared libraries, script interpreters).</p></li>
1.23 wiz 578: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 579: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 580: pkgsrc has been ported to many operating systems. Care is taken that
581: packages behave the same on all platforms.</p></li>
582: </ul></div>
583: </div>
1.41 asau 584: <div class="sect2">
1.1 dsieger 585: <div class="titlepage"><div><div><h3 class="title">
586: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
587: <p>pkgsrc consists of both a source distribution and a binary
588: distribution for these operating systems. After retrieving the required
589: source or binaries, you can be up and running with pkgsrc in just
590: minutes!</p>
591: <p>pkgsrc was derived from FreeBSD's ports system, and
592: initially developed for NetBSD only. Since then, pkgsrc has
593: grown a lot, and now supports the following platforms:</p>
594: <div class="table">
595: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
596: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
597: <colgroup>
598: <col>
599: <col>
600: </colgroup>
601: <thead><tr>
602: <th>Platform</th>
603: <th>Date Support Added</th>
604: </tr></thead>
605: <tbody>
606: <tr>
1.10 hubertf 607: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 608: <td align="center">Aug 1997</td>
609: </tr>
610: <tr>
1.10 hubertf 611: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 612: <td align="center">Mar 1999</td>
613: </tr>
614: <tr>
1.10 hubertf 615: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 616: <td align="center">Jun 1999</td>
617: </tr>
618: <tr>
619: <td>
1.10 hubertf 620: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
621: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 622: </td>
623: <td align="center">Oct 2001</td>
624: </tr>
625: <tr>
1.10 hubertf 626: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 627: <td align="center">Nov 2002</td>
628: </tr>
629: <tr>
1.10 hubertf 630: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 631: <td align="center">Nov 2002</td>
632: </tr>
633: <tr>
1.10 hubertf 634: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 635: <td align="center">Dec 2002</td>
636: </tr>
637: <tr>
638: <td>BSD/OS</td>
639: <td align="center">Dec 2003</td>
640: </tr>
641: <tr>
1.10 hubertf 642: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 643: <td align="center">Dec 2003</td>
644: </tr>
645: <tr>
646: <td>
1.10 hubertf 647: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 648: (Microsoft Windows Services for Unix)
649: </td>
650: <td align="center">Mar 2004</td>
651: </tr>
652: <tr>
1.10 hubertf 653: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 654: <td align="center">Oct 2004</td>
655: </tr>
656: <tr>
1.10 hubertf 657: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 658: <td align="center">Nov 2004</td>
659: </tr>
660: <tr>
1.10 hubertf 661: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 662: <td align="center">Apr 2007</td>
663: </tr>
1.23 wiz 664: <tr>
665: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
666: <td align="center">Sep 2010</td>
667: </tr>
1.1 dsieger 668: </tbody>
669: </table></div>
670: </div>
671: <br class="table-break">
672: </div>
673: </div>
1.41 asau 674: <div class="sect1">
1.1 dsieger 675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
676: <a name="overview"></a>1.2. Overview</h2></div></div></div>
677: <p>This document is divided into three parts. The first,
1.10 hubertf 678: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 679: describes how one can use one of the packages in the Package
680: Collection, either by installing a precompiled binary package,
681: or by building one's own copy using the NetBSD package system.
1.10 hubertf 682: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1 dsieger 683: package so it can be easily built by other NetBSD users without
684: knowing about the package's building details. The third part,
1.10 hubertf 685: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 686: is intended for those who want to understand how pkgsrc is
687: implemented.</p>
688: <p>This document is available in various formats:
1.10 hubertf 689: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1 dsieger 690: </div>
1.41 asau 691: <div class="sect1">
1.1 dsieger 692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
693: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 694: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
695: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 696: terminology used within this document.</p>
1.41 asau 697: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 698: <dt><span class="term">Package</span></dt>
699: <dd><p>A set of files and building instructions
700: that describe what's necessary
701: to build a certain piece of software using
702: pkgsrc. Packages are traditionally stored under
703: <code class="filename">/usr/pkgsrc</code>.</p></dd>
704: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 705: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 706: is part of the NetBSD operating system and can be bootstrapped
707: to run on non-NetBSD operating systems as well. It handles
708: building (compiling), installing, and removing of
709: packages.</p></dd>
710: <dt><span class="term">Distfile</span></dt>
711: <dd><p>This term describes the file or files that are
712: provided by the author of the piece of software to
713: distribute his work. All the changes necessary to build on
714: NetBSD are reflected in the corresponding package. Usually
715: the distfile is in the form of a compressed tar-archive,
716: but other types are possible, too. Distfiles are usually
717: stored below
718: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
719: <dt><span class="term">Port</span></dt>
720: <dd><p>This is the term used by FreeBSD and OpenBSD people
721: for what we call a package.
1.23 wiz 722: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 723: architecture.</p></dd>
724: <dt><span class="term">Precompiled/binary package</span></dt>
725: <dd>
726: <p>A set of binaries built with pkgsrc from a distfile
727: and stuffed together in a single <code class="filename">.tgz</code>
728: file so it can be installed on machines of the same
729: machine architecture without the need to
730: recompile. Packages are usually generated in
731: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 732: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 733: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 734: especially in the context of precompiled packages.</p>
735: </dd>
736: <dt><span class="term">Program</span></dt>
737: <dd><p>The piece of software to be installed which will be
738: constructed from all the files in the distfile by the
739: actions defined in the corresponding package.</p></dd>
740: </dl></div>
1.41 asau 741: <div class="sect2">
1.1 dsieger 742: <div class="titlepage"><div><div><h3 class="title">
743: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 744: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 745: <dt><span class="term">pkgsrc users</span></dt>
746: <dd>
747: <p>The
748: pkgsrc users are people who use the packages provided by pkgsrc.
749: Typically they are system administrators. The people using the
1.23 wiz 750: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
751: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 752: <p>There are two kinds of pkgsrc users: Some only want to
753: install pre-built binary packages. Others build the pkgsrc
754: packages from source, either for installing them directly or for
1.10 hubertf 755: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.1 dsieger 756: documentation.</p>
757: </dd>
758: <dt><span class="term">package maintainers</span></dt>
759: <dd><p>A
1.10 hubertf 760: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.1 dsieger 761: <dt><span class="term">infrastructure developers</span></dt>
762: <dd><p>These people are involved in all those files
763: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 764: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.1 dsieger 765: too.</p></dd>
766: </dl></div>
767: </div>
768: </div>
1.41 asau 769: <div class="sect1">
1.1 dsieger 770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
771: <a name="typography"></a>1.4. Typography</h2></div></div></div>
772: <p>When giving examples for commands, shell prompts are used to
773: show if the command should/can be issued as root, or if
1.23 wiz 774: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 775: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
776: shell prompt, assuming they use the C-shell or tcsh.</p>
777: </div>
778: </div>
1.41 asau 779: <div class="part">
1.1 dsieger 780: <div class="titlepage"><div><div><h1 class="title">
781: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
782: <div class="toc">
783: <p><b>Table of Contents</b></p>
784: <dl>
785: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
786: <dd><dl>
787: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
788: <dd><dl>
789: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23 wiz 790: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 791: </dl></dd>
792: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
793: <dd><dl>
794: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
795: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
796: </dl></dd>
797: </dl></dd>
798: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
799: <dd><dl>
800: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
801: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
802: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
803: <dd><dl>
804: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
805: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
806: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
807: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
808: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
809: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
810: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
811: </dl></dd>
812: </dl></dd>
813: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
814: <dd><dl>
815: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
816: <dd><dl>
817: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
818: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
819: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
820: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
821: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
822: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
823: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
824: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
825: </dl></dd>
826: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
827: <dd><dl>
828: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
829: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
830: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
831: </dl></dd>
832: </dl></dd>
833: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
834: <dd><dl>
835: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
836: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 837: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 838: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 839: <dd><dl>
1.4 rillig 840: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 841: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
842: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 843: </dl></dd>
1.4 rillig 844: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
845: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 846: </dl></dd>
847: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
848: <dd><dl>
849: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
850: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 851: </dl></dd>
852: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
853: builds)</a></span></dt>
1.1 dsieger 854: <dd><dl>
1.6 rillig 855: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
856: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
857: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
858: <dd><dl>
859: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
860: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
861: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
862: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
863: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
864: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
865: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
866: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
867: </dl></dd>
868: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 869: <dd><dl>
870: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
871: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
872: </dl></dd>
1.6 rillig 873: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
874: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
875: </dl></dd>
876: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
877: <dd><dl>
1.23 wiz 878: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
879: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 880: </dl></dd>
881: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
882: <dd><dl>
883: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
884: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
885: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
886: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
887: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
888: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
889: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23 wiz 890: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6 rillig 891: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23 wiz 892: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
893: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
894: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.6 rillig 895: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
896: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
897: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23 wiz 898: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6 rillig 899: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.23 wiz 900: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 901: </dl></dd>
902: </dl>
903: </div>
1.41 asau 904: <div class="chapter">
1.1 dsieger 905: <div class="titlepage"><div><div><h2 class="title">
906: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
907: <div class="toc">
908: <p><b>Table of Contents</b></p>
909: <dl>
910: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
911: <dd><dl>
912: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
1.23 wiz 913: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 914: </dl></dd>
915: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
916: <dd><dl>
917: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
918: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
919: </dl></dd>
920: </dl>
921: </div>
922: <p>Before you download and extract the files, you need to decide
923: where you want to extract them. When using pkgsrc as root user, pkgsrc
924: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
925: free to install the sources and binary packages wherever you want in
926: your filesystem, provided that the pathname does not contain white-space
927: or other characters that are interpreted specially by the shell and some
928: other programs. A safe bet is to use only letters, digits, underscores
929: and dashes.</p>
1.41 asau 930: <div class="sect1">
1.1 dsieger 931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
932: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
933: <p>Before you download any pkgsrc files, you should decide
934: whether you want the <span class="emphasis"><em>current</em></span> branch or the
935: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
936: quarterly basis from the current branch and only gets modified
937: for security updates. The names of the stable branches are built
938: from the year and the quarter, for example
1.21 snj 939: <code class="literal">2009Q1</code>.</p>
1.1 dsieger 940: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 941: want to download pkgsrc. You can get it as a tar file or via CVS.
942: Both ways are described here.</p>
1.41 asau 943: <div class="sect2">
1.1 dsieger 944: <div class="titlepage"><div><div><h3 class="title">
945: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
946: <p>The primary download location for all pkgsrc files is
1.10 hubertf 947: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.1 dsieger 948: number of subdirectories for different purposes, which are
1.10 hubertf 949: 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>
1.1 dsieger 950: <p>The tar file for the current branch is in the directory
1.10 hubertf 951: <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1 dsieger 952: It is autogenerated daily.</p>
1.21 snj 953: <p>The tar file for the stable branch 2009Q1 is in the
954: directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.12 weinem 955: <p>To download a pkgsrc stable tarball, run:</p>
956: <pre class="screen">
1.22 jakllsch 957: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
958: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 959: stable branch to be downloaded, for example,
1.23 wiz 960: <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span>.</p>
1.12 weinem 961: <p>Then, extract it with:</p>
1.22 jakllsch 962: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.12 weinem 963: <p>This will create the directory <code class="filename">pkgsrc/</code>
964: in <code class="filename">/usr/</code> and all the package source will be
965: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
966: <p>To download pkgsrc-current, run:</p>
967: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1 dsieger 968: </div>
1.41 asau 969: <div class="sect2">
1.1 dsieger 970: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 971: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
972: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 973: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23 wiz 974: </pre>
975: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
976: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
977: <p>This will create the directory <code class="filename">pkgsrc/</code>
978: in your <code class="filename">/usr/</code> directory and all the package source
979: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
980: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 981: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 982: </pre>
1.29 dholland 983: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 984: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 985: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 986: </pre>
987: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
988: For Bourne shells, you can set it in your <code class="filename">.profile</code>
989: or better globally in <code class="filename">/etc/profile</code>:</p>
990: <pre class="programlisting">
991: # set CVS remote shell command
992: CVS_RSH=ssh
993: export CVS_RSH
994: </pre>
995: <p>By default, CVS doesn't do things like most people would expect it to do.
996: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
997: in your home directory and saving the following lines to it.
998: This file will save you lots of headache and some bug reports, so we strongly recommend it.
999: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1000: <pre class="programlisting">
1001: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1002: cvs -q -z2
1.2 rillig 1003: checkout -P
1.4 rillig 1004: update -dP
1005: diff -upN
1.2 rillig 1006: rdiff -u
1.23 wiz 1007: release -d
1.2 rillig 1008: </pre>
1.1 dsieger 1009: </div>
1010: </div>
1.41 asau 1011: <div class="sect1">
1.1 dsieger 1012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1013: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1014: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1015: (which also works if you have first installed it via a tar
1016: file). It saves bandwidth and hard disk activity, compared to
1017: downloading the tar file again.</p>
1.41 asau 1018: <div class="sect2">
1.1 dsieger 1019: <div class="titlepage"><div><div><h3 class="title">
1020: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1021: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1022: <h3 class="title">Warning</h3>
1023: <p>When updating from a tar file, you first need to
1024: completely remove the old pkgsrc directory. Otherwise those
1025: files that have been removed from pkgsrc in the mean time will
1026: not be removed on your local disk, resulting in inconsistencies.
1027: When removing the old files, any changes that you have done to
1028: the pkgsrc files will be lost after updating. Therefore updating
1029: via CVS is strongly recommended.</p>
1030: </div>
1031: <p>Note that by default the distfiles and the binary packages
1032: are saved in the pkgsrc tree, so don't forget to rescue them
1033: before updating. You can also configure pkgsrc to use other than
1034: the default directories by setting the
1035: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1036: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1037: <p>To update pkgsrc from a tar file, download the tar file as
1038: explained above. Then, make sure that you have not made any
1039: changes to the files in the pkgsrc directory. Remove the pkgsrc
1040: directory and extract the new tar file. Done.</p>
1041: </div>
1.41 asau 1042: <div class="sect2">
1.1 dsieger 1043: <div class="titlepage"><div><div><h3 class="title">
1044: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1045: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1046: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1047: </pre>
1048: <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>
1049: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1050: </pre>
1.41 asau 1051: <div class="sect3">
1.1 dsieger 1052: <div class="titlepage"><div><div><h4 class="title">
1053: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1054: <p>When updating pkgsrc, the CVS program keeps track of the
1055: branch you selected. But if you, for whatever reason, want to
1056: switch from the stable branch to the current one, you can do it
1.23 wiz 1057: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1058: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1059: back to the stable branch, add the
1.23 wiz 1060: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.1 dsieger 1061: </div>
1.41 asau 1062: <div class="sect3">
1.1 dsieger 1063: <div class="titlepage"><div><div><h4 class="title">
1064: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1065: <p>When you update pkgsrc, the CVS program will only touch
1066: those files that are registered in the CVS repository. That
1067: means that any packages that you created on your own will stay
1068: unmodified. If you change files that are managed by CVS, later
1069: updates will try to merge your changes with those that have been
1070: done by others. See the CVS manual, chapter
1.23 wiz 1071: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1072: </div>
1073: </div>
1074: </div>
1075: </div>
1.41 asau 1076: <div class="chapter">
1.1 dsieger 1077: <div class="titlepage"><div><div><h2 class="title">
1078: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1079: <div class="toc">
1080: <p><b>Table of Contents</b></p>
1081: <dl>
1082: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1083: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1084: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1085: <dd><dl>
1086: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1087: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1088: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1089: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1090: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1091: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1092: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1093: </dl></dd>
1094: </dl>
1095: </div>
1.41 asau 1096: <div class="sect1">
1.1 dsieger 1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1098: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1099: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1100: </div>
1.41 asau 1101: <div class="sect1">
1.1 dsieger 1102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1103: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 ! asau 1104: <p>pkgsrc can be bootstrapped for use in two different modes:
! 1105: privileged and unprivileged one. In unprivileged mode in contrast
! 1106: to privileged one all programs are install under one particular user
! 1107: and cannot utilise privileged operations (packages don't create
! 1108: special users and all special file permissions like setuid are ignored).
! 1109: </p>
1.1 dsieger 1110: <p>Installing the bootstrap kit from source should be as simple as:</p>
1111: <pre class="screen">
1112: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1113: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1114: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1115: </pre>
1.43 ! asau 1116: <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>
! 1117: <p>By default, in privileged mode pkgsrc uses
! 1118: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
! 1119: where programs will be installed in,
1.1 dsieger 1120: and <code class="filename">/var/db/pkg</code> for the package database
1.43 ! asau 1121: directory where pkgsrc will do its internal bookkeeping,
! 1122: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
! 1123: where packages install their persistent data.
! 1124: In unprivileged mode pkgsrc uses
! 1125: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
! 1126: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
! 1127: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
! 1128: </p>
! 1129: <p>You can change default layout using command-line arguments.
! 1130: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
! 1131: </p>
1.41 asau 1132: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1133: <h3 class="title">Note</h3>
1.10 hubertf 1134: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1135: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1136: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1137: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1138: </div>
1.43 ! asau 1139: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
! 1140: <h3 class="title">Note</h3>
! 1141: <p>It is possible to bootstrap multiple instances of pkgsrc
! 1142: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
! 1143: corresponding to the installation you're working with to build
! 1144: and install packages.
! 1145: </p>
! 1146: </div>
1.1 dsieger 1147: </div>
1.41 asau 1148: <div class="sect1">
1.1 dsieger 1149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1150: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1151: <p>Here are some platform-specific notes you should be aware of.</p>
1.41 asau 1152: <div class="sect2">
1.1 dsieger 1153: <div class="titlepage"><div><div><h3 class="title">
1154: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.41 asau 1155: <p>Darwin 5.x and up are supported.</p>
1156: <p>Before you start, you need to download and install
1157: the Mac OS X Developer Tools from Apple's Developer Connection.
1158: This requires (free) membership. See
1.22 jakllsch 1159: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1160: for details. Also, make sure you install X11 (an optional
1161: package included with the Developer Tools) if you intend
1162: to build packages that use the X11 Window System.
1163: (If you don't want or need the full Xcode GUI,
1164: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1165: </div>
1.41 asau 1166: <div class="sect2">
1.1 dsieger 1167: <div class="titlepage"><div><div><h3 class="title">
1168: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.29 dholland 1169: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1170: other versions may work.</p>
1171: <p>Care should be taken so that the tools that this kit installs do not conflict
1172: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1173: <div class="orderedlist"><ol class="orderedlist" type="1">
1174: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1175: <code class="filename">/var/db/pkg</code>. It is therefore
1176: recommended that you choose a different location (e.g.
1177: <code class="filename">/usr/pkgdb</code>) by
1178: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1179: <li class="listitem">
1.1 dsieger 1180: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1181: good idea to move them out of the way to avoid confusion, e.g.</p>
1182: <pre class="screen">
1183: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1184: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1185: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1186: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1187: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1188: </pre>
1189: </li>
1.23 wiz 1190: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1191: <code class="filename">/etc/mk.conf.example</code> file
1192: when you use the bootstrap script.</p></li>
1193: </ol></div>
1194: </div>
1.41 asau 1195: <div class="sect2">
1.1 dsieger 1196: <div class="titlepage"><div><div><h3 class="title">
1197: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1198: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1199: providing a Unix-like environment with a tighter kernel integration than
1200: available with Cygwin. It is part of the Windows Services for Unix
1201: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1202: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.1 dsieger 1203: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1204: are not officially supported. (The main difference in 3.0/3.1 is lack
1205: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1206: <p>Services for Unix Applications (aka SUA) is an integrated
1207: component of Windows Server 2003 R2 (5.2), Windows Vista and
1208: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1209: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1210: 6.1 (64bit) subsystems have been tested. Other versions may
1211: work as well. The Interix 5.x subsystem has not yet been tested
1212: with pkgsrc.</p>
1.41 asau 1213: <div class="sect3">
1.1 dsieger 1214: <div class="titlepage"><div><div><h4 class="title">
1215: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1216: <p>At an absolute minimum, the following packages must be installed from
1217: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1218: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1219: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1220: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1221: <li class="listitem"><p>Remote Connectivity</p></li>
1222: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1223: </ul></div>
1224: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1225: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1226: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1227: pkgsrc (or from a binary package).</p>
1228: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1229: not need to be installed, but Remote Connectivity itself should be
1230: installed in order to have a working inetd.</p>
1231: <p>During installation you may be asked whether to enable setuid
1232: behavior for Interix programs, and whether to make pathnames default to
1233: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1234: enabled. (Without case-sensitivity, a large number of packages including
1235: perl will not build.)</p>
1236: <p>NOTE: Newer Windows service packs change the way binary execution
1237: works (via the Data Execution Prevention feature). In order to use
1238: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1239: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1240: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1241: support contract; however, Debian Interix Port has made most Interix
1242: hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1 dsieger 1243: <p>In addition to the hotfix noted above, it may be necessary to
1244: disable Data Execution Prevention entirely to make Interix functional.
1245: This may happen only with certain types of CPUs; the cause is not fully
1246: understood at this time. If gcc or other applications still segfault
1247: repeatedly after installing one of the hotfixes note above, the
1248: following option can be added to the appropriate "boot.ini" line on the
1249: Windows boot drive: /NoExecute=AlwaysOff
1250: (WARNING, this will disable DEP completely, which may be a security
1251: risk if applications are often run as a user in the Administrators
1252: group!)</p>
1253: </div>
1.41 asau 1254: <div class="sect3">
1.1 dsieger 1255: <div class="titlepage"><div><div><h4 class="title">
1256: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1257: <p>If SFU is already installed and you wish to alter these settings to work
1258: with pkgsrc, note the following things.</p>
1.41 asau 1259: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1260: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1261: Windows Services for UNIX, then click Change. In the installer, choose
1262: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1263: <li class="listitem">
1.1 dsieger 1264: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1265: change the following registry key:</p>
1266: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1267: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1268: </li>
1.23 wiz 1269: <li class="listitem">
1.1 dsieger 1270: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1271: following registry key:</p>
1272: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1273: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1274: </li>
1275: </ul></div>
1276: </div>
1.41 asau 1277: <div class="sect3">
1.1 dsieger 1278: <div class="titlepage"><div><div><h4 class="title">
1279: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1280: <p>The package manager (either the pkgsrc "su" user, or the user
1281: running "pkg_add") must be a member of the local Administrators
1282: group. Such a user must also be used to run the bootstrap. This is
1283: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1284: <p>The package manager should use a umask of 002. "make install" will
1285: automatically complain if this is not the case. This ensures that
1286: directories written in /var/db/pkg are Administrators-group writeable.</p>
1287: <p>The popular Interix binary packages from http://www.interopsystems.com/
1288: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1289: NOT be used in conjunction with pkgsrc. If you choose to use them at
1290: the same time as the pkgsrc packages, ensure that you use the proper
1291: pkg_* tools for each type of binary package.</p>
1292: <p>The TERM setting used for DOS-type console windows (including those
1293: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1294: don't have a termcap/terminfo entry for it, but the following .termcap
1295: entry provides adequate emulation in most cases:</p>
1296: <pre class="programlisting">
1297: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1298: </pre>
1299: </div>
1.41 asau 1300: <div class="sect3">
1.1 dsieger 1301: <div class="titlepage"><div><div><h4 class="title">
1302: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1303: <p>Though Interix suffices as a familiar and flexible substitute
1304: for a full Unix-like platform, it has some drawbacks that should
1305: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1306: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1307: <li class="listitem">
1.1 dsieger 1308: <p><span class="strong"><strong>X11:</strong></span></p>
1309: <p>Interix comes with the standard set of X11R6 client libraries,
1310: and can run X11 based applications, but it does
1311: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1312: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1313: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1314: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1315: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1316: and the free X11 server included with
1.10 hubertf 1317: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1318: </li>
1.23 wiz 1319: <li class="listitem">
1.1 dsieger 1320: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1321: <p>Because Interix runs in a completely different NT subsystem from
1322: Win32 applications, it does not currently support various X11
1323: protocol extensions for acceleration (such as MIT-SHM or DGA).
1324: Most interactive applications to a local X server will run
1325: reasonably fast, but full motion video and other graphics
1326: intensive applications may require a faster-than-expected CPU.</p>
1327: </li>
1.23 wiz 1328: <li class="listitem">
1.1 dsieger 1329: <p><span class="strong"><strong>Audio:</strong></span></p>
1330: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1331: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1332: audio system on Interix. Unlike on most platforms, the
1333: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.10 hubertf 1334: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1335: server component. To output audio via an Interix host, the
1336: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1337: must also be installed.</p>
1338: </li>
1.23 wiz 1339: <li class="listitem">
1.1 dsieger 1340: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1341: <p>Direct device access is not currently supported in Interix, so it
1342: is not currently possible to access CD/DVD drives, USB devices,
1343: or SCSI devices through non-filesystem means. Among other things,
1344: this makes it impossible to use Interix directly for CD/DVD
1345: burning.</p>
1346: </li>
1.23 wiz 1347: <li class="listitem">
1.1 dsieger 1348: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1349: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1350: drives are also not directly accessible in Interix. However,
1351: support is in work to make tape drive access possible by using
1352: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1353: esound server).</p>
1354: </li>
1355: </ul></div>
1356: </div>
1.41 asau 1357: <div class="sect3">
1.1 dsieger 1358: <div class="titlepage"><div><div><h4 class="title">
1359: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1360: <p>It is not necessary, in general, to have a "root" user on the
1361: Windows system; any member of the local Administrators group will
1362: suffice. However, some packages currently assume that the user
1363: named "root" is the privileged user. To accommodate these, you
1364: may create such a user; make sure it is in the local group
1365: Administrators (or your language equivalent).</p>
1.10 hubertf 1366: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1367: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1368: time being, install packages as the local Administrator (or
1369: your language equivalent), or run the following command after
1370: installing a package to work around the issue:</p>
1371: <pre class="screen">
1372: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1373: </pre>
1374: </div>
1375: </div>
1.41 asau 1376: <div class="sect2">
1.1 dsieger 1377: <div class="titlepage"><div><div><h3 class="title">
1378: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1379: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1380: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1381: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1382: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.1 dsieger 1383: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29 dholland 1384: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1 dsieger 1385: etc.</p>
1386: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1387: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1388: you start out using "abi=n32", that's what all your packages will be built
1389: with.</p>
1390: <p>Therefore, please make sure that you have no conflicting
1391: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1392: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1393: try to link n32 object files with lib64 or vice versa. Check your
1394: <code class="filename">/etc/compiler.defaults</code>!</p>
1395: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1396: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1397: as it appears that IRIX linker occasionally runs into issues when trying to
1398: link over a network-mounted file system.</p>
1399: <p>The bootstrapping process should set all the right options for programs such
1400: as imake(1), but you may want to set some options depending on your local
1401: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1402: course, your compiler's man pages for details.</p>
1403: <p>If you are using SGI's MIPSPro compiler, please set
1404:
1405: </p>
1406: <pre class="programlisting">
1407: PKGSRC_COMPILER= mipspro
1408: </pre>
1409: <p>
1410:
1.10 hubertf 1411: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1412: are using gcc and may end up passing invalid flags to the compiler. Note that
1413: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1414: default.</p>
1415: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1416: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1417: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1418: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1419: '--preserve-path' flag.</p>
1420: </div>
1.41 asau 1421: <div class="sect2">
1.1 dsieger 1422: <div class="titlepage"><div><div><h3 class="title">
1423: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1424: <p>Some versions of Linux (for example Debian GNU/Linux) need
1425: either libtermcap or libcurses (libncurses). Installing the
1426: distributions libncurses-dev package (or equivalent) should fix
1427: the problem.</p>
1428: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1429: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1430: i386 have been tested.</p>
1431: <p>To bootstrap using icc, assuming the default icc installation
1432: directory:</p>
1433: <pre class="programlisting">
1.31 wiz 1434: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1435: </pre>
1.41 asau 1436: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1437: <h3 class="title">Note</h3>
1.31 wiz 1438: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1439: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1440: <p>For icc 10.1 neither of these appears to be necessary.</p>
1441: </div>
1442: <p>Use a value for ICCBASE that corresponds to the directory
1443: where icc is installed. After bootstrapping, set
1444: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1445: <pre class="programlisting">
1.31 wiz 1446: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1447: </pre>
1.31 wiz 1448: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1449: <code class="filename">/opt/intel_cc_80</code>. This is the default
1450: install directory for icc 8.0. If you are using a more recent
1451: version, be sure to set the correct path explicitly.
1452: </p>
1.1 dsieger 1453: <p>pkgsrc uses the static linking method of the runtime libraries
1454: provided by icc, so binaries can be run on other systems which do not
1455: have the shared libraries installed.</p>
1456: <p>Libtool, however, extracts a list of libraries from the
1.29 dholland 1457: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1 dsieger 1458: records it, throwing away the -Bstatic and -Bdynamic options
1459: interspersed between the libraries. This means that
1460: libtool-linked C++ shared libraries will have a runtime
1461: dependency on the icc libraries until this is fixed in
1462: libtool.</p>
1463: </div>
1.41 asau 1464: <div class="sect2">
1.1 dsieger 1465: <div class="titlepage"><div><div><h3 class="title">
1466: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.29 dholland 1467: <p>OpenBSD 5.1 has been tested and supported,
1468: other versions may work.</p>
1.1 dsieger 1469: <p>Care should be taken so that the tools that this kit installs do not conflict
1470: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1471: <div class="orderedlist"><ol class="orderedlist" type="1">
1472: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1473: <code class="filename">/var/db/pkg</code>. It is therefore
1474: recommended that you choose a different location (e.g.
1475: <code class="filename">/usr/pkgdb</code>) by
1476: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1477: <li class="listitem">
1.1 dsieger 1478: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1479: good idea to move them out of the way to avoid confusion, e.g.</p>
1480: <pre class="screen">
1481: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1482: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1483: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1484: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1485: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1486: </pre>
1487: </li>
1.23 wiz 1488: <li class="listitem">
1.10 hubertf 1489: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1490: <code class="filename">/etc/mk.conf.example</code> file
1491: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1492: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1493: as well. You can work around this by enclosing all the pkgsrc-specific parts
1494: of the file with:</p>
1495: <pre class="programlisting">
1496: .ifdef BSD_PKG_MK
1497: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1498: .else
1499: # OpenBSD stuff
1500: .endif
1501: </pre>
1502: </li>
1503: </ol></div>
1504: </div>
1.41 asau 1505: <div class="sect2">
1.1 dsieger 1506: <div class="titlepage"><div><div><h3 class="title">
1507: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.35 wiz 1508: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1509: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1510: Sun WorkShop 5 have been tested.</p>
1511: <p>The following packages are required on Solaris 8 for the bootstrap
1512: process and to build packages.</p>
1.41 asau 1513: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1514: <li class="listitem"><p>SUNWsprot</p></li>
1515: <li class="listitem"><p>SUNWarc</p></li>
1516: <li class="listitem"><p>SUNWbtool</p></li>
1517: <li class="listitem"><p>SUNWtoo</p></li>
1518: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1519: </ul></div>
1520: <p>Please note that the use of GNU binutils on Solaris is
1521: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1522: <p>Whichever compiler you use, please ensure the compiler tools and
1523: your $prefix are in your <code class="varname">PATH</code>. This includes
1524: <code class="filename">/usr/ccs/{bin,lib}</code>
1525: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1526: <div class="sect3">
1.1 dsieger 1527: <div class="titlepage"><div><div><h4 class="title">
1528: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1529: <p>It makes life much simpler if you only use the same gcc consistently
1530: for building all packages.</p>
1531: <p>It is recommended that an external gcc be used only for bootstrapping,
1532: then either build gcc from
1.35 wiz 1533: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.1 dsieger 1534: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1535: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.1 dsieger 1536: </div>
1.41 asau 1537: <div class="sect3">
1.1 dsieger 1538: <div class="titlepage"><div><div><h4 class="title">
1539: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1540: <p>You will need at least the following packages installed (from WorkShop
1541: 5.0)</p>
1.41 asau 1542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1543: <li class="listitem"><p>SPROcc
1.1 dsieger 1544: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1545: <li class="listitem"><p>SPROcpl
1.1 dsieger 1546: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1547: <li class="listitem"><p>SPROild
1.1 dsieger 1548: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1549: <li class="listitem"><p>SPROlang
1.1 dsieger 1550: - Sun WorkShop Compilers common components</p></li>
1551: </ul></div>
1552: <p>You should set the following variables in your
1.10 hubertf 1553: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1554: <pre class="programlisting">
1555: CC= cc
1556: CXX= CC
1557: CPP= cc -E
1558: CXXCPP= CC -E
1559: </pre>
1.41 asau 1560: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1561: <h3 class="title">Note</h3>
1562: <p>The <code class="varname">CPP</code> setting might break some
1563: packages that use the C preprocessor for processing things other
1564: than C source code.</p>
1565: </div>
1566: </div>
1.41 asau 1567: <div class="sect3">
1.1 dsieger 1568: <div class="titlepage"><div><div><h4 class="title">
1569: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1570: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1571: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1572: <pre class="programlisting">
1573: PKGSRC_COMPILER= sunpro
1574: ABI= 64
1575: </pre>
1.41 asau 1576: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1577: <h3 class="title">Note</h3>
1578: <p>This setting has been tested for the SPARC
1579: architecture. Intel and AMD machines need some more
1580: work.</p>
1581: </div>
1582: </div>
1.41 asau 1583: <div class="sect3">
1.1 dsieger 1584: <div class="titlepage"><div><div><h4 class="title">
1585: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.10 hubertf 1586: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1587: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1588: The workaround is to use another shell for the configure
1589: scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.10 hubertf 1590: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1591: <pre class="programlisting">
1592: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1593: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1594: </pre>
1595: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1596: </div>
1597: </div>
1598: </div>
1599: </div>
1.41 asau 1600: <div class="chapter">
1.1 dsieger 1601: <div class="titlepage"><div><div><h2 class="title">
1602: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1603: <div class="toc">
1604: <p><b>Table of Contents</b></p>
1605: <dl>
1606: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1607: <dd><dl>
1608: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1609: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1610: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1611: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1612: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1613: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
1614: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1615: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1616: </dl></dd>
1617: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1618: <dd><dl>
1619: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1620: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1621: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1622: </dl></dd>
1623: </dl>
1624: </div>
1625: <p>Basically, there are two ways of using pkgsrc. The first
1626: is to only install the package tools and to use binary packages
1.23 wiz 1627: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1628: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1629: of pkgsrc, too. Then you are able to build your own packages,
1630: and you can still use binary packages from someone else.</p>
1.41 asau 1631: <div class="sect1">
1.1 dsieger 1632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1633: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1634: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1635: server and its mirrors, there are collections of binary packages,
1636: ready to be installed. These binary packages have been built using the
1637: default settings for the directories, that is:</p>
1.41 asau 1638: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1639: <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>
1640: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1641: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1642: </ul></div>
1643: <p>If you cannot use these directories for whatever reasons (maybe
1644: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1645: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.41 asau 1646: <div class="sect2">
1.1 dsieger 1647: <div class="titlepage"><div><div><h3 class="title">
1648: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1649: <p>To install binary packages, you first need to know from where
1650: to get them. The first place where you should look is on the main
1.10 hubertf 1651: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5 weinem 1652: <p>This directory contains binary packages for multiple
1653: platforms. First, select your operating system. (Ignore the
1654: directories with version numbers attached to it, they just exist for
1655: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1656: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1657: <p>In this directory, you often find a file called
1658: <code class="filename">bootstrap.tar.gz</code> which contains the package
1659: management tools. If the file is missing, it is likely that your
1660: operating system already provides those tools. Download the file and
1661: extract it in the <code class="filename">/</code> directory. It will create
1662: the directories <code class="filename">/usr/pkg</code> (containing the tools
1663: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1664: (the database of installed packages).</p>
1.1 dsieger 1665: </div>
1.41 asau 1666: <div class="sect2">
1.1 dsieger 1667: <div class="titlepage"><div><div><h3 class="title">
1668: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1669: <p>In the directory from the last section, there is a
1670: subdirectory called <code class="filename">All</code>, which contains all the
1671: binary packages that are available for the platform, excluding those
1672: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1673: medium you are using).</p>
1.9 rillig 1674: <p>To install packages directly from an FTP or HTTP server, run
1675: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1676: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1677: <pre class="screen">
1678: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1679: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.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>
1680: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1681: </pre>
1682: <p>Instead of URLs, you can also use local paths, for example if
1683: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1684: repository. If you want to install packages from multiple sources,
1685: you can separate them by a semicolon in
1686: <code class="varname">PKG_PATH</code>.</p>
1687: <p>After these preparations, installing a package is very
1688: easy:</p>
1689: <pre class="screen">
1690: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1691: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1692: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1693: </pre>
1.1 dsieger 1694: <p>Note that any prerequisite packages needed to run the
1695: package in question will be installed, too, assuming they are
1696: present where you install from.</p>
1.23 wiz 1697: <p>Adding packages might install vulnerable packages.
1698: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1699: regularly, especially after installing new packages, and verify
1700: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1701: <p>After you've installed packages, be sure to have
1702: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1703: <code class="varname">PATH</code> so you can actually start the just
1704: installed program.</p>
1705: </div>
1.41 asau 1706: <div class="sect2">
1.1 dsieger 1707: <div class="titlepage"><div><div><h3 class="title">
1708: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1709: <p>To deinstall a package, it does not matter whether it was
1710: installed from source code or from a binary package. The
1.10 hubertf 1711: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1712: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1713: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1714: name can be given with or without version number. Wildcards can
1715: also be used to deinstall a set of packages, for example
1716: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1717: so that the shell does not expand them before
1718: <code class="literal">pkg_delete</code> sees them.</p>
1719: <p>The <code class="option">-r</code> option is very powerful: it
1720: removes all the packages that require the package in question
1721: and then removes the package itself. For example:
1722:
1723: </p>
1724: <pre class="screen">
1725: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1726: </pre>
1727: <p>
1728:
1729: will remove jpeg and all the packages that used it; this allows
1730: upgrading the jpeg package.</p>
1731: </div>
1.41 asau 1732: <div class="sect2">
1.1 dsieger 1733: <div class="titlepage"><div><div><h3 class="title">
1734: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1735: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1736: installed packages or binary package files.</p>
1737: </div>
1.41 asau 1738: <div class="sect2">
1.1 dsieger 1739: <div class="titlepage"><div><div><h3 class="title">
1740: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1741: <p>
1742: The NetBSD Security-Officer and Packages Groups maintain a list of
1743: known security vulnerabilities to packages which are (or have been)
1744: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1745: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1 dsieger 1746: </p>
1747: <p>
1.22 jakllsch 1748: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1749: this list can be downloaded
1750: automatically, and a security audit of all packages installed on a system
1751: can take place.
1752: </p>
1753: <p>
1.22 jakllsch 1754: There are two components to auditing. The first
1755: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1756: is for downloading
1.1 dsieger 1757: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1758: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1759: installed packages are vulnerable. If a package is vulnerable, you
1760: will see output similar to the following:
1761: </p>
1762: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1763: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1764: <p>
1.22 jakllsch 1765: You may wish to have the
1.10 hubertf 1766: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1767: file downloaded daily so that
1768: it remains current. This may be done by adding an appropriate entry
1.29 dholland 1769: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1770: </p>
1771: <pre class="screen">
1772: # download vulnerabilities file
1773: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1774: </pre>
1775: <p>
1776: will update the vulnerability list every day at 3AM. You may wish to do
1777: this more often than once a day.
1778:
1779: In addition, you may wish to run the package audit from the daily
1780: security script. This may be accomplished by adding the following
1781: line to <code class="filename">/etc/security.local</code>:
1782: </p>
1783: <pre class="screen">
1784: /usr/sbin/pkg_admin audit
1785: </pre>
1786: <p>
1.1 dsieger 1787: </p>
1788: </div>
1.41 asau 1789: <div class="sect2">
1.1 dsieger 1790: <div class="titlepage"><div><div><h3 class="title">
1791: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1792: <p>
1.12 weinem 1793: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23 wiz 1794: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1795: argument to check if your packages are up-to-date, e.g.
1796: </p>
1797: <pre class="screen">
1798: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1799: ...
1800: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1801: </pre>
1.10 hubertf 1802: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1803: package on your system and rebuild any dependencies.
1804: </p>
1805: </div>
1.41 asau 1806: <div class="sect2">
1.1 dsieger 1807: <div class="titlepage"><div><div><h3 class="title">
1808: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1809: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1810: administrative functions on the package system.</p>
1811: </div>
1.41 asau 1812: <div class="sect2">
1.1 dsieger 1813: <div class="titlepage"><div><div><h3 class="title">
1814: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1815: <p>Please pay very careful attention to the warnings
1.29 dholland 1816: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1 dsieger 1817: inherent dangers of installing binary packages which you did
1818: not create yourself, and the security holes that can be
1819: introduced onto your system by indiscriminate adding of such
1820: files.</p>
1821: <p>The same warning of course applies to every package you
1822: install from source when you haven't completely read and
1823: understood the source code of the package, the compiler that
1824: is used to build the package and all the other tools that are
1825: involved.</p>
1826: </div>
1827: </div>
1.41 asau 1828: <div class="sect1">
1.1 dsieger 1829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1830: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1831: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1832: directory now contains a set of packages, organized into
1833: categories. You can browse the online index of packages, or run
1.10 hubertf 1834: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1835: directory to build local <code class="filename">README.html</code> files for
1836: all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1837: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1838: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1839: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1840: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1841: different <code class="varname">LOCALBASE</code> definitions on the same
1842: system (inside a chroot is an exception). </p>
1843: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1844: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.1 dsieger 1845: instructions how to create your own packages.</p>
1.41 asau 1846: <div class="sect2">
1.1 dsieger 1847: <div class="titlepage"><div><div><h3 class="title">
1848: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1849: <p>To build packages from source, you need a working C
1850: compiler. On NetBSD, you need to install the
1.23 wiz 1851: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1852: sets. If you want to build X11-related packages, the
1.23 wiz 1853: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1854: sets are required, too.</p>
1855: </div>
1.41 asau 1856: <div class="sect2">
1.1 dsieger 1857: <div class="titlepage"><div><div><h3 class="title">
1858: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1859: <p>The first step for building a package is downloading the
1860: distfiles (i.e. the unmodified source). If they have not yet been
1861: downloaded, pkgsrc will fetch them automatically.</p>
1862: <p>If you have all files that you need in the
1863: <code class="filename">distfiles</code> directory,
1864: you don't need to connect. If the distfiles are on CD-ROM, you can
1865: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1866: </p>
1867: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1868: <p>
1.10 hubertf 1869: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1870: <p>By default a list of distribution sites will be randomly
1871: intermixed to prevent huge load on servers which holding popular
1872: packages (for example, SourceForge.net mirrors). Thus, every
1873: time when you need to fetch yet another distfile all the mirrors
1874: will be tried in new (random) order. You can turn this feature
1875: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1876: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1877: <p>You can overwrite some of the major distribution sites to
1878: fit to sites that are close to your own. By setting one or two
1879: variables you can modify the order in which the master sites are
1880: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1881: delimited list of domain suffixes.
1882: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1883: contains a whitespace delimited list of regular expressions. It
1884: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1885: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1886: some examples. This may save some of your bandwidth and
1887: time.</p>
1888: <p>You can change these settings either in your shell's environment, or,
1889: if you want to keep the settings, by editing the
1.10 hubertf 1890: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1891: and adding the definitions there.</p>
1892: <p>
1893: If a package depends on many other packages (such as
1894: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1895: alternate between periods of
1896: downloading source, and compiling. To ensure you have all the source
1897: downloaded initially you can run the command:
1898: </p>
1899: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1900: <p>
1901: which will output and run a set of shell commands to fetch the
1902: necessary files into the <code class="filename">distfiles</code> directory. You can
1903: also choose to download the files manually.
1904: </p>
1905: </div>
1.41 asau 1906: <div class="sect2">
1.1 dsieger 1907: <div class="titlepage"><div><div><h3 class="title">
1908: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1909: <p>
1910: Once the software has downloaded, any patches will be applied, then it
1911: will be compiled for you. This may take some time depending on your
1912: computer, and how many other packages the software depends on and their
1913: compile time.
1914: </p>
1.41 asau 1915: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1916: <h3 class="title">Note</h3>
1917: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1918: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1919: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1920: </div>
1921: <p>For example, type</p>
1922: <pre class="screen">
1923: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1924: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1925: </pre>
1926: <p>at the shell prompt to build the various components of the
1927: package.</p>
1928: <p>The next stage is to actually install the newly compiled
1929: program onto your system. Do this by entering:
1930:
1931: </p>
1932: <pre class="screen">
1933: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1934: </pre>
1935: <p>
1936:
1937: while you are still in the directory for whatever package you
1938: are installing.</p>
1939: <p>Installing the package on your system may require you to
1940: be root. However, pkgsrc has a
1941: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1942: to only become root for the actual installation step.</p>
1943: <p>That's it, the software should now be installed and setup for use.
1944: You can now enter:
1945:
1946: </p>
1947: <pre class="screen">
1948: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1949: </pre>
1950: <p>
1951:
1952: to remove the compiled files in the work directory, as you shouldn't need
1953: them any more. If other packages were also added to your system
1954: (dependencies) to allow your program to compile, you can tidy these up
1955: also with the command:</p>
1956: <pre class="screen">
1957: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1958: </pre>
1959: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1960: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1 dsieger 1961: <p>The program is installed under the default root of the
1962: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1963: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1964: variable in your environment, and it will use that value as the
1965: root of your packages tree. So, to use
1966: <code class="filename">/usr/local</code>, set
1967: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1968: Please note that you should use a directory which is dedicated to
1969: packages and not shared with other programs (i.e., do not try and
1970: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
1971: to add any of your own files or directories (such as
1972: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1973: <code class="filename">pkgsrc/</code>) below the
1974: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
1975: conflicts between programs and other files installed by the
1976: package system and whatever else may have been installed
1977: there.</p>
1.10 hubertf 1978: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 1979: alter some configuration options at build time. Have a look at
1980: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1981: of what will be set there by default. Environment variables such
1982: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 1983: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 1984: set them each time you want to use pkgsrc.</p>
1.23 wiz 1985: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
1986: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 1987: or being installed. This may be for debugging purposes, or out of
1988: simple curiosity. A number of utility values have been added to
1989: help with this.</p>
1.23 wiz 1990: <div class="orderedlist"><ol class="orderedlist" type="1">
1991: <li class="listitem">
1.29 dholland 1992: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 1993: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1994: information will be displayed. For example,</p>
1995: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1996: <p>will show all the commands that are invoked, up to and
1.23 wiz 1997: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 1998: </li>
1.23 wiz 1999: <li class="listitem">
1.29 dholland 2000: <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+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2001: definition, then the <code class="varname">VARNAME</code> definition
2002: should be used, in conjunction with the show-var
1.29 dholland 2003: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2004: variable <code class="varname">LOCALBASE</code>:</p>
2005: <pre class="screen">
2006: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2007: /usr/pkg
2008: <code class="prompt">%</code>
2009: </pre>
2010: </li>
2011: </ol></div>
2012: <p>If you want to install a binary package that you've either
2013: created yourself (see next section), that you put into
2014: pkgsrc/packages manually or that is located on a remote FTP
2015: server, you can use the "bin-install" target. This target will
1.29 dholland 2016: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 2017: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2018: sites searched is kept in the variable
2019: <code class="varname">BINPKG_SITES</code>, which defaults to
1.29 dholland 2020: 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+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 2021: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2022: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2023: details.</p>
2024: <p>A final word of warning: If you set up a system that has a
2025: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2026: set that before any packages are installed, as you cannot use
2027: several directories for the same purpose. Doing so will result in
2028: pkgsrc not being able to properly detect your installed packages,
2029: and fail miserably. Note also that precompiled binary packages are
2030: usually built with the default <code class="varname">LOCALBASE</code> of
2031: <code class="filename">/usr/pkg</code>, and that you should
2032: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2033: <code class="varname">LOCALBASE</code>.</p>
2034: </div>
2035: </div>
2036: </div>
1.41 asau 2037: <div class="chapter">
1.1 dsieger 2038: <div class="titlepage"><div><div><h2 class="title">
2039: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2040: <div class="toc">
2041: <p><b>Table of Contents</b></p>
2042: <dl>
2043: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2044: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2045: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2046: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2047: <dd><dl>
1.4 rillig 2048: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2049: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2050: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 2051: </dl></dd>
1.4 rillig 2052: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2053: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2054: </dl>
2055: </div>
1.4 rillig 2056: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2057: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2058: that file depends on the installation. On NetBSD, when you use
1.29 dholland 2059: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 2060: <code class="filename">/etc/</code>. In all other cases the default location is
2061: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2062: bootstrap program to install the binary packages.</p>
2063: <p>During the bootstrap, an example configuration file is created. To
2064: use that, you have to create the directory
2065: <code class="filename">${PREFIX}/etc</code> and copy the example file
2066: there.</p>
2067: <p>The format of the configuration file is that of the usual
2068: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2069: is done by setting variables in this file. Note that you can define all
2070: kinds of variables, and no special error checking (for example for
2071: spelling mistakes) takes place, so you have to try it out to see if it
2072: works.</p>
1.41 asau 2073: <div class="sect1">
1.1 dsieger 2074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2075: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2076: <p>In this section, you can find some variables that apply to all
2077: pkgsrc packages. A complete list of the variables that can be
2078: configured by the user is available in
2079: <code class="filename">mk/defaults/mk.conf</code>, together with some
2080: comments that describe each variable's intent.</p>
1.41 asau 2081: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2082: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2083: packages will be installed. The default is
2084: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2085: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2086: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2087: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2088: installed. The default is
2089: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2090: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2091: X11 is installed on the system. The default is
2092: <code class="filename">/usr/X11R6</code>.</p></li>
1.23 wiz 2093: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2094: downloaded copies of the original source distributions used
2095: for building pkgsrc packages. The default is
2096: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2097: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2098: database about installed packages is stored. The default is
2099: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2100: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2101: If set, override the packages'
2102: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2103: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2104: Backup location(s) for distribution files and patch files
2105: if not found locally or in
2106: <code class="filename">${MASTER_SITES}</code> or
2107: <code class="filename">${PATCH_SITES}</code> respectively.
2108: The defaults are
1.25 spz 2109: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2110: and
2111: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2112: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2113: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2114: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2115: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2116: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2117: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2118: List of acceptable licenses. License names are case-sensitive.
2119: Whenever you try to build a package whose license is not in this
2120: list, you will get an error message. If the license condition is
2121: simple enough, the error message will include specific
2122: instructions on how to change this variable.</p></li>
1.1 dsieger 2123: </ul></div>
2124: </div>
1.41 asau 2125: <div class="sect1">
1.1 dsieger 2126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2127: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2128: <p>XXX
2129: </p>
1.41 asau 2130: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2131: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2132: directory for the binary packages. The default is
2133: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2134: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2135: The top level directory where, if defined, the separate
2136: working directories will get created, and symbolically
2137: linked to from <code class="filename">${WRKDIR}</code> (see below).
2138: This is useful for building packages on several
2139: architectures, then <code class="filename">${PKGSRCDIR}</code>
2140: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2141: is local to every architecture. (It should be noted that
2142: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2143: — it is an internal definition which refers to the
1.1 dsieger 2144: root of the pkgsrc tree. It is possible to have many
2145: pkgsrc tree instances.)</p></li>
1.23 wiz 2146: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2147: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2148: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2149: information.</p></li>
1.23 wiz 2150: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2151: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2152: BSD-style Makefile. If this is not set,
2153: <code class="varname">MAKECONF</code> is set to
2154: <code class="filename">/dev/null</code> to avoid picking up
2155: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2156: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2157: By default, dependencies are only installed, and no binary
2158: package is created for them. You can set this variable to
2159: <code class="literal">package</code> to automatically create binary
2160: packages after installing dependencies.</p></li>
2161: </ul></div>
2162: </div>
1.41 asau 2163: <div class="sect1">
1.1 dsieger 2164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2165: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24 wiz 2166: <p>Most packages support installation into a
1.4 rillig 2167: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2168: to be built, before the actual filesystem is touched. DESTDIR
2169: support exists in two variations:</p>
1.41 asau 2170: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2171: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2172: installation and packaging is still run as root.</p></li>
2173: <li class="listitem"><p>Full DESTDIR support can run the complete
2174: build, installation and packaging as normal user. Root
2175: privileges are only needed to add packages.</p></li>
2176: </ul></div>
2177: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2178: you can set
2179: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2180: so it's preferable to convert a package to DESTDIR instead.</p>
1.4 rillig 2181: <p>DESTDIR support changes the behaviour of various targets
2182: slightly. To install a package after building it, use
2183: <code class="literal">package-install</code>. <code class="literal">package</code> and
2184: <code class="literal">install</code> don't do that any
2185: longer. <code class="literal">package-install</code> can be used as
2186: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2187: will ask for the root password to install the package and fail,
2188: <code class="literal">package-install</code> will ask again.</p>
2189: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2190: clean</code></strong> needs to be run as root.</p>
1.17 imil 2191: <p>Considering the <code class="filename">foo/bar</code> package,
2192: DESTDIR full support can be tested using the following commands
2193:
2194: </p>
2195: <pre class="programlisting">
2196: <code class="prompt">$</code> id
2197: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2198: <code class="prompt">$</code> mkdir $HOME/packages
2199: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2200: </pre>
2201: <p>
2202:
2203: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2204: should be needed
2205:
2206: </p>
2207: <pre class="programlisting">
1.20 snj 2208: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.17 imil 2209: </pre>
2210: <p>
2211:
2212: Create a package without root privileges
2213:
2214: </p>
2215: <pre class="programlisting">
1.20 snj 2216: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.17 imil 2217: </pre>
2218: <p>
2219:
2220: For the following command, you must be able to gain root
1.29 dholland 2221: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 2222:
2223: </p>
2224: <pre class="programlisting">
1.20 snj 2225: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.17 imil 2226: </pre>
2227: <p>
2228:
2229: Then, as a simple user
2230:
2231: </p>
2232: <pre class="programlisting">
2233: <code class="prompt">$</code> make clean
2234: </pre>
2235: <p>
2236:
2237: </p>
1.4 rillig 2238: </div>
1.41 asau 2239: <div class="sect1">
1.4 rillig 2240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2241: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2242: <div class="sect2">
1.1 dsieger 2243: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2244: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2245: <p>By default, pkgsrc will use GCC to build packages. This may be
2246: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2247: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2248: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2249: <dd>
2250: <p>This is a list of values specifying the chain of
2251: compilers to invoke when building packages. Valid values
2252: are:</p>
1.41 asau 2253: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2254: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2255: distributed C/C++ (chainable)</p></li>
1.23 wiz 2256: <li class="listitem"><p><code class="varname">ccache</code>:
1.1 dsieger 2257: compiler cache (chainable)</p></li>
1.23 wiz 2258: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2259: GNU C/C++ Compiler</p></li>
1.23 wiz 2260: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2261: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.23 wiz 2262: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2263: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2264: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2265: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2266: </ul></div>
2267: <p>The default is
1.23 wiz 2268: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2269: <code class="varname">ccache</code> and/or
2270: <code class="varname">distcc</code> with an appropriate
2271: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2272: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2273: variable should always be terminated with a value for
2274: a real compiler. Note that only one real compiler
1.23 wiz 2275: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2276: is not allowed).</p>
2277: </dd>
2278: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2279: <dd><p>This specifies the minimum version of GCC to use
2280: when building packages. If the system GCC doesn't
2281: satisfy this requirement, then pkgsrc will build and
2282: install one of the GCC packages to use instead.</p></dd>
2283: </dl></div>
2284: </div>
1.41 asau 2285: <div class="sect2">
1.1 dsieger 2286: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2287: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2288: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2289: please make sure to use the <code class="literal">+=</code> operator
2290: instead of the <code class="literal">=</code> operator:</p>
2291: <pre class="programlisting">
2292: CFLAGS+= -your -flags
2293: </pre>
2294: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2295: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2296: need to add their own flags. You may want to take a look
2297: at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 2298: package if you're interested in optimization specifically
2299: for the current CPU. </p>
1.1 dsieger 2300: </div>
1.41 asau 2301: <div class="sect2">
1.1 dsieger 2302: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2303: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2304: <p>If you want to pass flags to the linker, both in the configure
2305: step and the build step, you can do this in two ways. Either set
2306: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2307: between the two is that <code class="varname">LIBS</code> will be appended to
2308: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2309: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2310: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2311: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2312: <code class="varname">CFLAGS</code>, if you do not wish to override these
2313: settings, use the <code class="literal">+=</code> operator:</p>
2314: <pre class="programlisting">
2315: LDFLAGS+= -your -linkerflags
2316: </pre>
2317: </div>
2318: </div>
1.41 asau 2319: <div class="sect1">
1.1 dsieger 2320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2321: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2322: <p>XXX
2323: </p>
1.41 asau 2324: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2325: <li class="listitem">
1.1 dsieger 2326: <p><code class="varname">PKG_DEVELOPER</code>:
2327: Run some sanity checks that package developers want:
2328: </p>
1.41 asau 2329: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2330: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2331: fuzz</p></li>
1.23 wiz 2332: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2333: binaries will find their shared libs.</p></li>
2334: </ul></div>
2335: <p>
2336: </p>
2337: </li>
1.23 wiz 2338: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2339: of debugging output which is displayed whilst making and
2340: installing the package. The default value for this is 0,
2341: which will not display the commands as they are executed
2342: (normal, default, quiet operation); the value 1 will display
2343: all shell commands before their invocation, and the value 2
2344: will display both the shell commands before their invocation,
1.10 hubertf 2345: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2346: -x</strong></span> will be displayed.</p></li>
2347: </ul></div>
2348: <p>
2349: </p>
2350: </div>
1.41 asau 2351: <div class="sect1">
1.1 dsieger 2352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2353: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2354: <p>Some packages have build time options, usually to select
2355: between different dependencies, enable optional support for big
2356: dependencies or enable experimental features.</p>
2357: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2358: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2359: show-options</strong></span>, for example:</p>
2360: <pre class="programlisting">
2361: The following options are supported by this package:
2362: ssl Enable SSL support.
2363: Exactly one of the following gecko options is required:
2364: firefox Use firefox as gecko rendering engine.
2365: mozilla Use mozilla as gecko rendering engine.
2366: At most one of the following database options may be selected:
2367: mysql Enable support for MySQL database.
2368: pgsql Enable support for PostgreSQL database.
2369:
2370: These options are enabled by default: firefox
2371: These options are currently enabled: mozilla ssl
2372: </pre>
2373: <p>The following variables can be defined in
1.10 hubertf 2374: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2375: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2376: which can be used to select or disable options for all packages
2377: that support them, and
2378: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2379: which can be used to select or disable options specifically for
2380: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2381: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2382: are disabled. A few examples:</p>
2383: <pre class="screen">
1.10 hubertf 2384: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2385: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2386: PKG_OPTIONS.kdebase= debug -sasl
2387: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2388: <p>It is important to note that options that were specifically
1.18 snj 2389: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2390: you do not wish to include the option. If you are unsure you can view
2391: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2392: <p>The following settings are consulted in the order given, and
2393: the last setting that selects or disables an option is
2394: used:</p>
1.23 wiz 2395: <div class="orderedlist"><ol class="orderedlist" type="1">
2396: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2397: maintainer</p></li>
1.23 wiz 2398: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2399: variables (see below)</p></li>
1.23 wiz 2400: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2401: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2402: </ol></div>
2403: <p>For groups of mutually exclusive options, the last option
2404: selected is used, all others are automatically disabled. If an
2405: option of the group is explicitly disabled, the previously
2406: selected option, if any, is used. It is an error if no option
2407: from a required group of options is selected, and building the
2408: package will fail.</p>
2409: <p>Before the options framework was introduced, build options
2410: were selected by setting a variable (often named
2411: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2412: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2413: transition to the options framework for the user, these legacy
2414: variables are converted to the appropriate options setting
2415: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2416: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2417: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2418: directly. Support for the legacy variables will be removed
2419: eventually.</p>
2420: </div>
2421: </div>
1.41 asau 2422: <div class="chapter">
1.1 dsieger 2423: <div class="titlepage"><div><div><h2 class="title">
2424: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2425: <div class="toc">
2426: <p><b>Table of Contents</b></p>
2427: <dl>
2428: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2429: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2430: </dl>
2431: </div>
1.41 asau 2432: <div class="sect1">
1.1 dsieger 2433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2434: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2435: <p>Once you have built and installed a package, you can create
2436: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29 dholland 2437: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2438: the same package on a group of hosts and wasting CPU time. It also
2439: provides a simple means for others to install your package, should
2440: you distribute it.</p>
2441: <p>To create a binary package, change into the appropriate
1.10 hubertf 2442: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2443: package</strong></span>:</p>
2444: <pre class="screen">
2445: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2446: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2447: </pre>
2448: <p>This will build and install your package (if not already done),
2449: and then build a binary package from what was installed. You can
1.10 hubertf 2450: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2451: it. Binary packages are created by default in
2452: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2453: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.1 dsieger 2454: continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10 hubertf 2455: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1 dsieger 2456: such a binary package.</p>
2457: </div>
1.41 asau 2458: <div class="sect1">
1.1 dsieger 2459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2460: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2461: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2462: </div>
2463: </div>
1.41 asau 2464: <div class="chapter">
1.6 rillig 2465: <div class="titlepage"><div><div><h2 class="title">
2466: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2467: builds)</h2></div></div></div>
2468: <div class="toc">
2469: <p><b>Table of Contents</b></p>
2470: <dl>
2471: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2472: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2473: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2474: <dd><dl>
2475: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2476: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2477: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2478: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2479: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2480: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2481: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2482: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2483: </dl></dd>
2484: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 2485: <dd><dl>
2486: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2487: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2488: </dl></dd>
1.6 rillig 2489: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2490: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2491: </dl>
2492: </div>
2493: <p>When you have multiple machines that should run the same packages,
2494: it is wasted time if they all build their packages themselves from
2495: source. There are two ways of getting a set of binary packages: The old
2496: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2497: system. This chapter describes how to set them up so that the packages
2498: are most likely to be usable later.</p>
1.41 asau 2499: <div class="sect1">
1.6 rillig 2500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2501: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2502: <p>Since a bulk build takes several days or even weeks to finish, you
2503: should think about the setup before you start everything. Pay attention
2504: to at least the following points:</p>
1.41 asau 2505: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2506: <li class="listitem">
1.6 rillig 2507: <p>If you want to upload the binary packages to
2508: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2509: packages:</p>
1.41 asau 2510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2511: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6 rillig 2512: by a NetBSD developer on a trusted machine (that is, where you and only
2513: you have root access).</p></li>
1.23 wiz 2514: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21 snj 2515: the stable branches (like 2009Q1), so that users browsing the available
1.6 rillig 2516: collections can see at a glance how old the packages
2517: are.</p></li>
1.23 wiz 2518: <li class="listitem"><p>The packages must be built as root, since some packages
1.6 rillig 2519: require set-uid binaries at runtime, and creating those packages as
2520: unprivileged user doesn't work well at the moment.</p></li>
2521: </ul></div>
2522: </li>
1.23 wiz 2523: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6 rillig 2524: your system. Most bulk builds run as root, so they should be run at least
2525: in a chroot environment or something even more restrictive, depending on
2526: what the operating system provides. There have been numerous cases where
2527: certain packages tried to install files outside the
2528: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2529: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2530: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2531: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2532: that you don't need any package during the build.</p></li>
2533: </ul></div>
2534: </div>
1.41 asau 2535: <div class="sect1">
1.6 rillig 2536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2537: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2538: <p>A complete bulk build requires lots of disk space. Some of the
2539: disk space can be read-only, some other must be writable. Some can be on
2540: remote filesystems (such as NFS) and some should be local. Some can be
2541: temporary filesystems, others must survive a sudden reboot.</p>
1.41 asau 2542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2543: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2544: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2545: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2546: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2547: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2548: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6 rillig 2549: </ul></div>
1.1 dsieger 2550: </div>
1.41 asau 2551: <div class="sect1">
1.1 dsieger 2552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2553: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.41 asau 2554: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.15 rillig 2555: <h3 class="title">Note</h3>
2556: <p>There are two ways of doing a bulk build. The old-style
1.23 wiz 2557: one and the new-style <span class="quote">“<span class="quote">pbulk</span>”</span>. The latter is the recommended
1.15 rillig 2558: way.</p>
1.6 rillig 2559: </div>
1.41 asau 2560: <div class="sect2">
1.1 dsieger 2561: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2562: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.41 asau 2563: <div class="sect3">
1.1 dsieger 2564: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2565: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1 dsieger 2566: </h4></div></div></div>
2567: <p>The <code class="filename">build.conf</code> file is the main
2568: configuration file for bulk builds. You can configure how your
2569: copy of pkgsrc is kept up to date, how the distfiles are
2570: downloaded, how the packages are built and how the report is
2571: generated. You can find an annotated example file in
2572: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2573: it, copy <code class="filename">build.conf-example</code> to
2574: <code class="filename">build.conf</code> and edit it, following the
2575: comments in that file.</p>
2576: </div>
1.41 asau 2577: <div class="sect3">
1.1 dsieger 2578: <div class="titlepage"><div><div><h4 class="title">
1.10 hubertf 2579: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4 rillig 2580: </h4></div></div></div>
1.10 hubertf 2581: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1 dsieger 2582: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2583: details of the default settings. You will want to ensure that
2584: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.22 jakllsch 2585: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.4 rillig 2586: completely bypasses the license check.</p>
1.1 dsieger 2587: <pre class="programlisting">
2588: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2589: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2590: BSDSRCDIR= /usr/src
2591: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2592: OBJHOSTNAME?= yes # use work.`hostname`
2593: FAILOVER_FETCH= yes # insist on the correct checksum
2594: PKG_DEVELOPER?= yes
1.22 jakllsch 2595: SKIP_LICENSE_CHECK= yes
1.1 dsieger 2596: </pre>
2597: <p>Some options that are especially useful for bulk builds
2598: can be found at the top lines of the file
2599: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2600: options of these are briefly described here.</p>
1.41 asau 2601: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2602: <li class="listitem"><p>If you are on a slow machine, you may want to
1.1 dsieger 2603: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.23 wiz 2604: <span class="quote">“<span class="quote">no</span>”</span>.</p></li>
2605: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.1 dsieger 2606: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2607: to the directory where all log files are created. Otherwise the
2608: log files are created in the pkgsrc directory.</p></li>
1.23 wiz 2609: <li class="listitem"><p>Another important variable is
1.1 dsieger 2610: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2611: should be always available while building other
2612: packages.</p></li>
2613: </ul></div>
2614: <p>Some other options are scattered in the pkgsrc
2615: infrastructure:</p>
1.41 asau 2616: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2617: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2618: should be set to <code class="literal">yes</code>. The purpose of the
2619: bulk builds is creating binary packages, no matter if they
2620: are vulnerable or not. Leaving this variable unset would
2621: prevent the bulk build system from even trying to build
2622: them, so possible building errors would not show
2623: up.</p></li>
2624: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.1 dsieger 2625: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.23 wiz 2626: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed set of files
1.1 dsieger 2627: matches the <code class="filename">PLIST</code>.</p></li>
1.23 wiz 2628: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.1 dsieger 2629: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.23 wiz 2630: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed
2631: <span class="quote">“<span class="quote">#!</span>”</span>-scripts will find their
1.1 dsieger 2632: interpreter.</p></li>
1.23 wiz 2633: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2634: set to <span class="quote">“<span class="quote"><code class="literal">yes</code></span>”</span> to run each
1.1 dsieger 2635: package's self-test before installing it. Note that some
1.23 wiz 2636: packages make heavy use of <span class="quote">“<span class="quote">good</span>”</span> random
1.1 dsieger 2637: numbers, so you need to assure that the machine on which you
2638: are doing the bulk builds is not completely idle. Otherwise
2639: some test programs will seem to hang, while they are just
2640: waiting for new random data to be
2641: available.</p></li>
2642: </ul></div>
2643: </div>
1.41 asau 2644: <div class="sect3">
1.1 dsieger 2645: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2646: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1 dsieger 2647: </h4></div></div></div>
2648: <p>It is possible to configure the bulk build to perform
2649: certain site-specific tasks at the end of the pre-build
2650: stage. If the file
2651: <code class="filename">pre-build.local</code> exists in
2652: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.29 dholland 2653: (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.1 dsieger 2654: stage. An example use of
2655: <code class="filename">pre-build.local</code> is to have the line:</p>
2656: <pre class="screen">echo "I do not have enough disk space to build this pig." \
2657: > misc/openoffice/$BROKENF</pre>
2658: <p>to prevent the system from trying to build a particular package
2659: which requires nearly 3 GB of disk space.</p>
2660: </div>
2661: </div>
1.41 asau 2662: <div class="sect2">
1.1 dsieger 2663: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2664: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1 dsieger 2665: <p>As <code class="filename">/usr/pkg</code> will be completely
2666: deleted at the start of bulk builds, make sure your login
2667: shell is placed somewhere else. Either drop it into
2668: <code class="filename">/usr/local/bin</code> (and adjust your login
2669: shell in the passwd file), or (re-)install it via
1.29 dholland 2670: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.1 dsieger 2671: you can login after a reboot (remember that your current
2672: process won't die if the package is removed, you just can't
2673: start any new instances of the shell any more). Also, if you
2674: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2675: version of ssh for some reason, be sure to install ssh before
2676: starting it from <code class="filename">rc.local</code>:</p>
2677: <pre class="programlisting">
2678: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2679: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2680: /usr/pkg/etc/rc.d/sshd
2681: fi
2682: </pre>
2683: <p>Not doing so will result in you being not able to log in
2684: via ssh after the bulk build is finished or if the machine
2685: gets rebooted or crashes. You have been warned! :)</p>
2686: </div>
1.41 asau 2687: <div class="sect2">
1.1 dsieger 2688: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2689: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1 dsieger 2690: <p>Make sure you don't need any of the packages still
2691: installed.</p>
1.41 asau 2692: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2693: <h3 class="title">Warning</h3>
2694: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2695: configuration files and some more files from
2696: <code class="filename">/var</code>, <code class="filename">/home</code> and
2697: possibly other locations will be removed! So don't run a bulk
2698: build with privileges that might harm your
2699: system.</em></span></p>
2700: </div>
2701: <p>Be sure to remove all other things that might
2702: interfere with builds, like some libs installed in
2703: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2704: <pre class="screen">
2705: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2706: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2707: </pre>
2708: <p>If for some reason your last build didn't complete (power
2709: failure, system panic, ...), you can continue it by
2710: running:</p>
2711: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2712: <p>At the end of the bulk build, you will get a summary via mail,
2713: and find build logs in the directory specified by
2714: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2715: file.</p>
2716: </div>
1.41 asau 2717: <div class="sect2">
1.1 dsieger 2718: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2719: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1 dsieger 2720: <p>The bulk builds consist of three steps:</p>
1.41 asau 2721: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2722: <dt><span class="term">1. pre-build</span></dt>
2723: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2724: cleans out any broken distfiles, and removes all
2725: packages installed.</p></dd>
2726: <dt><span class="term">2. the bulk build</span></dt>
1.23 wiz 2727: <dd><p>This is basically <span class="quote">“<span class="quote">make bulk-package</span>”</span> with
1.1 dsieger 2728: an optimised order in which packages will be
2729: built. Packages that don't require other packages will
2730: be built first, and packages with many dependencies will
2731: be built later.</p></dd>
2732: <dt><span class="term">3. post-build</span></dt>
2733: <dd><p>Generates a report that's placed in the directory
2734: specified in the <code class="filename">build.conf</code> file
2735: named <code class="filename">broken.html</code>, a short version
2736: of that report will also be mailed to the build's
2737: admin.</p></dd>
2738: </dl></div>
2739: <p>During the build, a list of broken packages will be compiled
2740: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2741: <code class="filename">.../.broken.${MACHINE}</code> if
2742: <code class="varname">OBJMACHINE</code> is set), individual build logs
2743: of broken builds can be found in the package's
2744: directory. These files are used by the bulk-targets to mark
2745: broken builds to not waste time trying to rebuild them, and
2746: they can be used to debug these broken package builds
2747: later.</p>
2748: </div>
1.41 asau 2749: <div class="sect2">
1.1 dsieger 2750: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2751: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1 dsieger 2752: <p>Currently, roughly the following requirements are valid for
2753: NetBSD 2.0/i386:</p>
1.41 asau 2754: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2755: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
2756: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
2757: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.1 dsieger 2758: </ul></div>
2759: <p>Note that all pkgs will be de-installed as soon as they are
2760: turned into a binary package, and that sources are removed,
2761: so there is no excessively huge demand to disk
2762: space. Afterwards, if the package is needed again, it will
1.29 dholland 2763: be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.1 dsieger 2764: there are no cycles wasted by recompiling.</p>
2765: </div>
1.41 asau 2766: <div class="sect2">
1.1 dsieger 2767: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2768: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1 dsieger 2769: <p>If you don't want all the packages nuked from a machine
2770: (rendering it useless for anything but pkg compiling), there
2771: is the possibility of doing the package bulk build inside a
2772: chroot environment.</p>
2773: <p>The first step is to set up a chroot sandbox,
2774: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2775: using null mounts, or manually.</p>
2776: <p>There is a shell script called
1.36 wiz 2777: <code class="filename">mksandbox</code> installed by the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mksandbox/README.html" target="_top"><code class="filename">pkgtools/mksandbox</code></a> package, which will set
1.1 dsieger 2778: up the sandbox environment using null mounts. It will also
2779: create a script called <code class="filename">sandbox</code> in the
2780: root of the sandbox environment, which will allow the null
1.10 hubertf 2781: mounts to be activated using the <span class="command"><strong>sandbox
1.1 dsieger 2782: mount</strong></span> command and deactivated using the
1.10 hubertf 2783: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1 dsieger 2784: <p>To set up a sandbox environment by hand, after extracting all
1.10 hubertf 2785: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1 dsieger 2786: distribution DESTDIR=/usr/sandbox</strong></span> in
2787: <code class="filename">/usr/src/etc</code>, be sure the following items
2788: are present and properly configured:</p>
1.23 wiz 2789: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2790: <li class="step">
1.1 dsieger 2791: <p>Kernel</p>
2792: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2793: </li>
1.41 asau 2794: <li class="step">
1.1 dsieger 2795: <p><code class="filename">/dev/*</code></p>
2796: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2797: </li>
1.41 asau 2798: <li class="step">
1.1 dsieger 2799: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
2800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2801: </li>
1.41 asau 2802: <li class="step">
1.1 dsieger 2803: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2805: </li>
1.41 asau 2806: <li class="step">
1.1 dsieger 2807: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
2808: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2809: </li>
1.41 asau 2810: <li class="step">
1.1 dsieger 2811: <p><code class="filename">/usr/src</code> (system sources,
1.14 jmcneill 2812: e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.1 dsieger 2813: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2814: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2815: </li>
1.41 asau 2816: <li class="step">
1.1 dsieger 2817: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2818: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2819: </li>
1.41 asau 2820: <li class="step">
1.1 dsieger 2821: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
2822: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2823: </li>
1.41 asau 2824: <li class="step">
1.1 dsieger 2825: <p>Checkout pkgsrc via cvs into
2826: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2827: <pre class="screen">
2828: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2829: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2830: </pre>
2831: <p>Do not mount/link this to the copy of your pkgsrc tree
2832: you do development in, as this will likely cause problems!</p>
2833: </li>
1.41 asau 2834: <li class="step"><p>Make
1.1 dsieger 2835: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2836: <code class="filename">.../distfiles</code> point somewhere
2837: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.41 asau 2838: <li class="step"><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, “<code class="filename">mk.conf</code>”</a>.</p></li>
2839: <li class="step"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.1 dsieger 2840: </ol></div>
2841: <p>When the chroot sandbox is set up, you can start
2842: the build with the following steps:</p>
2843: <pre class="screen">
2844: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2845: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2846: </pre>
2847: <p>This will just jump inside the sandbox and start building. At
2848: the end of the build, mail will be sent with the results of
2849: the build. Created binary pkgs will be in
2850: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2851: (wherever that points/mounts to/from).</p>
2852: </div>
1.41 asau 2853: <div class="sect2">
1.1 dsieger 2854: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2855: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1 dsieger 2856: <p>In addition to building a complete set of all packages in
2857: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2858: may be used to build a subset of the packages contained in
2859: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.10 hubertf 2860: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.41 asau 2861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2862: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2863: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2864: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2865: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.1 dsieger 2866: </ul></div>
2867: <p>will define the set of packages which should be built.
2868: The bulk build code will also include any packages which are
2869: needed as dependencies for the explicitly listed packages.</p>
2870: <p>One use of this is to do a bulk build with
2871: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2872: periodically to have a complete set of the binary packages
2873: needed for your site available without the overhead of
2874: building extra packages that are not needed.</p>
2875: </div>
1.41 asau 2876: <div class="sect2">
1.1 dsieger 2877: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2878: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1 dsieger 2879: <p>This section describes how pkgsrc developers can upload binary
2880: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2881: <p>If you would like to automatically create checksum files for the
2882: binary packages you intend to upload, remember to set
2883: <code class="varname">MKSUMS=yes</code> in your
2884: <code class="filename">mk/bulk/build.conf</code>.</p>
2885: <p>If you would like to PGP sign the checksum files (highly
2886: recommended!), remember to set
2887: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2888: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2889: your GPG password to sign the files before uploading everything.</p>
2890: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2891: set properly in your <code class="filename">mk/bulk/build.conf</code>
2892: file, i.e. adjust it to something like one of the following:</p>
1.25 spz 2893: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
2894: <p>Please use appropriate values for "20xxQy" (the branch),
2895: "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.1 dsieger 2896: is different from your local login, write your login directly
2897: into the variable, e.g. my local account is "feyrer", but for my
2898: login "hubertf", I use:</p>
1.25 spz 2899: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.1 dsieger 2900: <p>A separate <code class="filename">upload</code> directory is used
2901: here to allow "closing" the directory during upload. To do
2902: so, run the following command on ftp.NetBSD.org next:</p>
1.25 spz 2903: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</code></strong></pre>
1.1 dsieger 2904: <p>Before uploading the binary pkgs, ssh authentication needs
2905: to be set up. This example shows how to set up temporary keys
2906: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2907: (assuming that no keys should be present there usually):</p>
2908: <pre class="screen">
2909: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
2910: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.25 spz 2911: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
2912: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.1 dsieger 2913: </pre>
1.25 spz 2914: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.1 dsieger 2915: append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.25 spz 2916: file on ftp.NetBSD.org. You should remove the key after the
1.1 dsieger 2917: upload is done!</p>
2918: <p>Next, test if your ssh connection really works:</p>
2919: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
2920: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2921: <p>Now after all this works, you can exit the sandbox and start
2922: the upload:</p>
2923: <pre class="screen">
2924: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
2925: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2926: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2927: </pre>
1.29 dholland 2928: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
2929: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.1 dsieger 2930: upload. The upload script will take care of not uploading
1.23 wiz 2931: restricted packages.</p>
1.1 dsieger 2932: <p>After the upload has ended, first thing is to revoke ssh access:</p>
2933: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
2934: Gdd:x! </pre>
2935: <p>Use whatever is needed to remove the key you've entered
2936: before! Last, move the uploaded packages out of the
2937: <code class="filename">upload</code> directory to have them accessible
2938: to everyone:</p>
2939: <pre class="screen">
1.25 spz 2940: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.1 dsieger 2941: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2942: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.25 spz 2943: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
2944: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.1 dsieger 2945: </pre>
2946: </div>
2947: </div>
1.41 asau 2948: <div class="sect1">
1.1 dsieger 2949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2950: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 2951: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 2952: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2953: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2954: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 2955: </ul></div>
1.41 asau 2956: <div class="sect2">
1.15 rillig 2957: <div class="titlepage"><div><div><h3 class="title">
2958: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
2959: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
2960: <pre class="screen">
2961: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2962: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2963: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2964: </pre>
2965: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.41 asau 2966: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2967: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2968: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
2969: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
2970: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
2971: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.15 rillig 2972: </ul></div>
2973: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2974: <pre class="screen">
2975: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2976: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2977: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2978: </pre>
2979: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
2980: </div>
1.41 asau 2981: <div class="sect2">
1.6 rillig 2982: <div class="titlepage"><div><div><h3 class="title">
1.15 rillig 2983: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14 jmcneill 2984: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15 rillig 2985: <p>TODO: continue writing</p>
1.6 rillig 2986: </div>
2987: </div>
1.41 asau 2988: <div class="sect1">
1.6 rillig 2989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2990: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2991: <p>After your pkgsrc bulk-build has completed, you may wish to
2992: create a CD-ROM set of the resulting binary packages to assist
2993: in installing packages on other machines. The
2994: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
2995: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2996: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2997: way that keeps all the dependencies for a given package on the same
2998: CD as that package.</p>
1.41 asau 2999: <div class="sect2">
1.1 dsieger 3000: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3001: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 3002: <p>Complete documentation for cdpack is found in the cdpack(1)
3003: man page. The following short example assumes that the binary
3004: packages are left in
3005: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3006: sufficient disk space exists in <code class="filename">/u2</code> to
3007: hold the ISO 9660 images.</p>
3008: <pre class="screen">
3009: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
3010: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
3011: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3012: </pre>
3013: <p>If you wish to include a common set of files
3014: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3015: etc.) on each CD in the collection, then you need to create a
3016: directory which contains these files. e.g.</p>
3017: <pre class="screen">
3018: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
3019: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3020: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3021: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3022: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3023: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
3024: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3025: </pre>
3026: <p>Now create the images:</p>
3027: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3028: <p>Each image will contain <code class="filename">README</code>,
3029: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3030: in their root directories.</p>
3031: </div>
3032: </div>
3033: </div>
1.41 asau 3034: <div class="chapter">
1.1 dsieger 3035: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3036: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 3037: <div class="toc">
3038: <p><b>Table of Contents</b></p>
3039: <dl>
1.23 wiz 3040: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3041: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 3042: </dl>
3043: </div>
3044: <p>The files that are installed by pkgsrc are organized in a way that
3045: is similar to what you find in the <code class="filename">/usr</code> directory
3046: of the base system. But some details are different. This is because
3047: pkgsrc initially came from FreeBSD and had adopted its file system
3048: hierarchy. Later it was largely influenced by NetBSD. But no matter
3049: which operating system you are using pkgsrc with, you can expect the
3050: same layout for pkgsrc.</p>
3051: <p>There are mainly four root directories for pkgsrc, which are all
3052: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3053: When pkgsrc has been installed as root, the default locations
3054: are:</p>
3055: <pre class="programlisting">
3056: LOCALBASE= /usr/pkg
3057: PKG_SYSCONFBASE= /usr/pkg/etc
3058: VARBASE= /var
3059: PKG_DBDIR= /var/db/pkg
3060: </pre>
3061: <p>In unprivileged mode (when pkgsrc has been installed as any other
3062: user), the default locations are:</p>
3063: <pre class="programlisting">
3064: LOCALBASE= ${HOME}/pkg
3065: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3066: VARBASE= ${HOME}/pkg/var
3067: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
3068: </pre>
3069: <p>What these four directories are for, and what they look like is
3070: explained below.</p>
1.41 asau 3071: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3072: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 3073: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 3074: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 3075: the well-known subdirectories like <code class="filename">bin</code>,
3076: <code class="filename">include</code>, <code class="filename">lib</code>,
3077: <code class="filename">share</code> and
3078: <code class="filename">sbin</code>.</p></li>
1.23 wiz 3079: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 3080: <code class="filename">/var</code> in the base system. Some programs (especially
3081: games, network daemons) need write access to it during normal
3082: operation.</p></li>
1.23 wiz 3083: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 3084: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 3085: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 3086: itself.</p></li>
3087: </ul></div>
1.41 asau 3088: <div class="sect1">
1.1 dsieger 3089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3090: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 3091: </h2></div></div></div>
3092: <p>The following directories exist in a typical pkgsrc installation
3093: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 3094: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3095: <dt><span class="term"><code class="filename">bin</code></span></dt>
3096: <dd><p>Contains executable programs that are intended to be
3097: directly used by the end user.</p></dd>
3098: <dt><span class="term"><code class="filename">emul</code></span></dt>
3099: <dd><p>Contains files for the emulation layers of various other
3100: operating systems, especially for
3101: NetBSD.</p></dd>
3102: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3103: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3104: <dd><p>Contains
3105: the configuration files.</p></dd>
3106: <dt><span class="term"><code class="filename">include</code></span></dt>
3107: <dd><p>Contains headers for the C and C++ programming
3108: languages.</p></dd>
3109: <dt><span class="term"><code class="filename">info</code></span></dt>
3110: <dd><p>Contains GNU info files of various
3111: packages.</p></dd>
3112: <dt><span class="term"><code class="filename">lib</code></span></dt>
3113: <dd><p>Contains shared and static
3114: libraries.</p></dd>
3115: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3116: <dd><p>Contains data files that don't change after
3117: installation. Other data files belong into
3118: <code class="filename">${VARBASE}</code>.</p></dd>
3119: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3120: <dd><p>Contains programs that are not intended to be used by
3121: end users, such as helper programs or network
3122: daemons.</p></dd>
3123: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3124: <dd><p>Contains programs that are intended to be executed as
3125: CGI scripts by a web server.</p></dd>
3126: <dt><span class="term"><code class="filename">man</code> (the usual value of
3127: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3128: <dd><p>Contains brief
3129: documentation in form of manual pages.</p></dd>
3130: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3131: <dd><p>Contains programs that are intended to be used only by
3132: the super-user.</p></dd>
3133: <dt><span class="term"><code class="filename">share</code></span></dt>
3134: <dd><p>Contains platform-independent data files that don't
3135: change after installation.</p></dd>
3136: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3137: <dd><p>Contains documentation files provided by the
3138: packages.</p></dd>
3139: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3140: <dd><p>Contains example files provided by the packages. Among
3141: others, the original configuration files are saved here and copied to
3142: <code class="filename">${PKG_SYSCONFDIR}</code> during
3143: installation.</p></dd>
3144: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3145: <dd><p>Contains the original files for rc.d
3146: scripts.</p></dd>
3147: <dt><span class="term"><code class="filename">var</code> (the usual location of
3148: <code class="filename">${VARBASE}</code>)</span></dt>
3149: <dd><p>Contains files
3150: that may be modified after
3151: installation.</p></dd>
3152: </dl></div>
3153: </div>
1.41 asau 3154: <div class="sect1">
1.1 dsieger 3155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3156: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 3157: </h2></div></div></div>
1.41 asau 3158: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3159: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3160: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3161: <dd><p>Contains
3162: information about the currently installed
3163: packages.</p></dd>
3164: <dt><span class="term"><code class="filename">games</code></span></dt>
3165: <dd><p>Contains highscore
3166: files.</p></dd>
3167: <dt><span class="term"><code class="filename">log</code></span></dt>
3168: <dd><p>Contains log files.</p></dd>
3169: <dt><span class="term"><code class="filename">run</code></span></dt>
3170: <dd><p>Contains informational files about daemons that are
3171: currently running.</p></dd>
3172: </dl></div>
3173: </div>
3174: </div>
1.41 asau 3175: <div class="chapter">
1.1 dsieger 3176: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3177: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 3178: <div class="toc">
3179: <p><b>Table of Contents</b></p>
3180: <dl>
1.6 rillig 3181: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3182: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3183: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3184: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3185: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3186: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
3187: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23 wiz 3188: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.6 rillig 3189: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23 wiz 3190: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
3191: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
3192: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.6 rillig 3193: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3194: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3195: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23 wiz 3196: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6 rillig 3197: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.23 wiz 3198: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 3199: </dl>
3200: </div>
3201: <p>This section contains hints, tips & tricks on special things in
3202: pkgsrc that we didn't find a better place for in the previous chapters, and
3203: it contains items for both pkgsrc users and developers.</p>
1.41 asau 3204: <div class="sect1">
1.1 dsieger 3205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3206: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 3207: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 3208: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3209: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 3210: This is a general purpose list for most issues regarding
3211: pkgsrc, regardless of platform, e.g. soliciting user help
3212: for pkgsrc configuration, unexpected build failures, using
3213: particular packages, upgrading pkgsrc installations,
3214: questions regarding the pkgsrc release branches, etc. General announcements or
3215: proposals for changes that impact the pkgsrc user community,
3216: e.g. major infrastructure changes, new features, package
3217: removals, etc., may also be posted.</p></li>
1.23 wiz 3218: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 3219: A list where the results of pkgsrc bulk builds are sent and
3220: discussed.</p></li>
1.23 wiz 3221: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 3222: This list is for those who are interested in getting a
3223: commit message for every change committed to pkgsrc. It is
3224: also available in digest form, meaning one daily message
3225: containing all commit messages for changes to the package
3226: source tree in that 24 hour period.</p></li>
3227: </ul></div>
3228: <p>To subscribe, do:</p>
3229: <pre class="programlisting">
3230: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3231: </pre>
3232: <p>Archives for all these mailing lists are available from
1.10 hubertf 3233: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 3234: </div>
1.41 asau 3235: <div class="sect1">
1.1 dsieger 3236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3237: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 3238: <p>Pkgviews is tightly integrated with buildlink. You can find a
3239: pkgviews User's guide in
3240: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3241: </div>
1.41 asau 3242: <div class="sect1">
1.1 dsieger 3243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3244: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 3245: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3246: a number of useful utilities for both users and developers of pkgsrc. This
3247: section attempts only to make the reader aware of the utilities and when
3248: they might be useful, and not to duplicate the documentation that comes
3249: with each package.</p>
3250: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.41 asau 3251: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1 dsieger 3252: Symlinks for use by buildlink.</p></li></ul></div>
3253: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 3254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3255: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.1 dsieger 3256: Calculates various kinds of checksums (including SHA1).</p></li>
1.23 wiz 3257: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1 dsieger 3258: Compatibility library for pkgsrc tools.</p></li>
1.23 wiz 3259: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1 dsieger 3260: non-BSD systems due to lack of native mtree.</p></li>
1.23 wiz 3261: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1 dsieger 3262: Up-to-date replacement for
3263: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3264: systems where pkg_install is not present.</p></li>
3265: </ul></div>
3266: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 3267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3268: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1 dsieger 3269: Create a binary package from an
1.10 hubertf 3270: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 3271: save the old package.</p></li>
1.23 wiz 3272: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1 dsieger 3273: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3274: from multiple locations. It currently supports the following
3275: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23 wiz 3276: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.1 dsieger 3277: packages someplace else (enabled by default).</p></li>
1.23 wiz 3278: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16 jnemeth 3279: the best compiler flags to optimise code for your current
1.23 wiz 3280: CPU and compiler. </p></li>
1.1 dsieger 3281: </ul></div>
3282: <p>Utilities for keeping track of installed packages, being up to date,
3283: etc:</p>
1.41 asau 3284: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3285: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1 dsieger 3286: packages whose installed versions do not match the latest pkgsrc
3287: entries.</p></li>
1.23 wiz 3288: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1 dsieger 3289: dependency graphs of packages, to aid in choosing a strategy for
3290: updating.</p></li>
1.23 wiz 3291: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
1.1 dsieger 3292: graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
1.23 wiz 3293: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12 weinem 3294: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23 wiz 3295: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1 dsieger 3296: does various checks on the complete pkgsrc system.</p></li>
1.23 wiz 3297: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1 dsieger 3298: packages you have installed.</p></li>
3299: </ul></div>
3300: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 3301: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3302: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1 dsieger 3303: making and maintaining patches for a package (includes pkgdiff,
3304: pkgvi, mkpatches, etc.).</p></li>
1.23 wiz 3305: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
1.1 dsieger 3306: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
3307: converting to pkgsrc.</p></li>
1.23 wiz 3308: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.1 dsieger 3309: pkgsrc to a Solaris package.</p></li>
3310: </ul></div>
3311: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3312: utilities)</p>
1.41 asau 3313: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3314: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1 dsieger 3315: packages in a chrooted area.</p></li>
1.23 wiz 3316: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1 dsieger 3317: kernel version for chrooted cross builds.</p></li>
3318: </ul></div>
3319: </div>
1.41 asau 3320: <div class="sect1">
1.1 dsieger 3321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3322: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3323: <p>If you want to use pkgsrc as non-root user, you can set some
3324: variables to make pkgsrc work under these conditions. At the very least,
1.23 wiz 3325: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.1 dsieger 3326: will turn on unprivileged mode and set multiple related variables to allow
3327: installation of packages as non-root.</p>
3328: <p>In case the defaults are not enough, you may want to tune some other
3329: variables used. For example, if the automatic user/group detection leads
3330: to incorrect values (or not the ones you would like to use), you can change
3331: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3332: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3333: <p>As regards bootstrapping, please note that the
1.10 hubertf 3334: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23 wiz 3335: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.1 dsieger 3336: use multiple default directories under <code class="filename">~/pkg</code> as the
3337: installation targets. These directories can be overridden by the
1.23 wiz 3338: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.1 dsieger 3339: that allow finer tuning of the tree layout.</p>
3340: </div>
1.41 asau 3341: <div class="sect1">
1.1 dsieger 3342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3343: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3344: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3345: enable this feature by adding the option
3346: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3347: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3348: distfile is found, pkgsrc will try to resume it.</p>
3349: <p>You can also
1.29 dholland 3350: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.16 jnemeth 3351: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3352: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3353: by using the value manual. A value of custom disables the system defaults
3354: and dependency tracking for the fetch program. In that case you have to
3355: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3356: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3357: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3358: <p>For example, if you want to use
1.16 jnemeth 3359: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3360: like:</p>
3361: <pre class="programlisting">
1.16 jnemeth 3362: FETCH_USING= wget
1.1 dsieger 3363: </pre>
3364: </div>
1.41 asau 3365: <div class="sect1">
1.1 dsieger 3366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3367: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3368: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3369: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3370: you will have to add the following line into
1.10 hubertf 3371: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3372: <pre class="programlisting">
1.4 rillig 3373: X11_TYPE=modular
1.1 dsieger 3374: </pre>
1.41 asau 3375: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3376: <h3 class="title">Note</h3>
1.4 rillig 3377: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3378: </p>
1.1 dsieger 3379: </div>
3380: </div>
1.41 asau 3381: <div class="sect1">
1.1 dsieger 3382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3383: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3384: <p>If you are sitting behind a firewall which does not allow direct
3385: connections to Internet hosts (i.e. non-NAT), you may specify the
3386: relevant proxy hosts. This is done using an environment variable in the
3387: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3388: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3389: port 80 as the proxy port number. So the proxy environment variables
3390: are:</p>
3391: <pre class="programlisting">
3392: ftp_proxy=ftp://orpheus.amdahl.com:80/
3393: http_proxy=http://orpheus.amdahl.com:80/
3394: </pre>
3395: </div>
1.41 asau 3396: <div class="sect1">
1.1 dsieger 3397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 3398: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 3399: <p>This depends on which utility is used to retrieve distfiles. From
3400: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3401: the first available command from the following list:</p>
1.41 asau 3402: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3403: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3404: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3405: </ul></div>
3406: <p>On a default NetBSD installation, this will be
3407: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3408: connections first, and falls back to active connections if the server
3409: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3410: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3411: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3412: <p>Having that option present will prevent
3413: <code class="filename">/usr/bin/ftp</code> from falling back to active
3414: transfers.</p>
3415: </div>
1.41 asau 3416: <div class="sect1">
1.1 dsieger 3417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3418: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3419: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3420: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3421: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 3422: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3423: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3424: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3425: resulting list to your machine at work/school and use it there. If you
1.29 dholland 3426: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3427: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3428: URL:</p>
3429: <p>At home:</p>
3430: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3431: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3432: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3433: <p>At work:</p>
3434: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3435: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3436: home.</p>
3437: <p>If you have a machine running NetBSD, and you want to get
3438: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3439: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3440: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3441: directly by running:</p>
3442: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3443: <p>If you even decide to ignore
3444: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3445: by running:</p>
3446: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3447: </div>
1.41 asau 3448: <div class="sect1">
1.1 dsieger 3449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23 wiz 3450: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
3451: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3452: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
3453: package, you get the error from make that it doesn't know how to make
3454: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3455: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3456: the NetBSD base distribution on your machine. It is recommended to do
3457: that to format man pages.</p>
3458: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
3459: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3460: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3461: </div>
1.41 asau 3462: <div class="sect1">
1.1 dsieger 3463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23 wiz 3464: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3465: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3466: when you installed your NetBSD machine. Please get and install it, by
3467: extracting it in <code class="filename">/</code>:</p>
3468: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3469: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3470: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3471: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3472: -r</strong></span>).</p>
3473: </div>
1.41 asau 3474: <div class="sect1">
1.1 dsieger 3475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3476: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3477: <p>When installing packages as non-root user and using the just-in-time
1.29 dholland 3478: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1 dsieger 3479: password for each required package installed. To avoid this, the sudo
3480: package can be used, which does password caching over a limited time. To
3481: use it, install sudo (either as binary package or from
3482: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10 hubertf 3483: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3484: <span class="emphasis"><em>after</em></span> the definition of the
3485: <code class="varname">LOCALBASE</code> variable:</p>
3486: <pre class="programlisting">
3487: .if exists(${LOCALBASE}/bin/sudo)
3488: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3489: .endif
3490: </pre>
3491: </div>
1.41 asau 3492: <div class="sect1">
1.1 dsieger 3493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3494: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3495: <p>As the system administrator, you can choose where configuration files
3496: are installed. The default settings make all these files go into
3497: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3498: be suboptimal depending on your expectations (e.g., a read-only,
3499: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3500: configuration of the provided packages).</p>
3501: <p>In order to change the defaults, you can modify the
3502: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3503: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3504: directory; some common examples include <code class="filename">/etc</code> or
3505: <code class="filename">/etc/pkg</code>.</p>
3506: <p>Furthermore, you can change this value on a per-package basis by
3507: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3508: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3509: package you would like to modify, that is, the contents of
3510: <code class="varname">PKGBASE</code>.</p>
3511: <p>Note that after changing these settings, you must rebuild and
3512: reinstall any affected packages.</p>
3513: </div>
1.41 asau 3514: <div class="sect1">
1.1 dsieger 3515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3516: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3517: <p>Please be aware that there can often be bugs in third-party software,
3518: and some of these bugs can leave a machine vulnerable to exploitation by
3519: attackers. In an effort to lessen the exposure, the NetBSD packages team
3520: maintains a database of known-exploits to packages which have at one time
3521: been included in pkgsrc. The database can be downloaded automatically, and
3522: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3523: do this, refer to the following two tools (installed as part of the
3524: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23 wiz 3525: <div class="orderedlist"><ol class="orderedlist" type="1">
3526: <li class="listitem">
1.20 snj 3527: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3528: download a list of the security vulnerabilities information. This list
1.25 spz 3529: is kept up to date by the pkgsrc security team, and is distributed
3530: from the NetBSD ftp server:</p>
3531: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1 dsieger 3532: </li>
1.23 wiz 3533: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3534: current machine, checking each known vulnerability. If a
1.1 dsieger 3535: vulnerable package is installed, it will be shown by output to stdout,
3536: including a description of the type of vulnerability, and a URL
3537: containing more information.</p></li>
3538: </ol></div>
1.14 jmcneill 3539: <p>Use of these tools is strongly recommended! After
1.23 wiz 3540: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3541: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3542: pkg_install</code></strong>.</p>
1.1 dsieger 3543: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3544: perform a security check before building any package. See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, “Variables affecting the build process”</a> for ways to control this
1.1 dsieger 3545: check.</p>
3546: </div>
1.41 asau 3547: <div class="sect1">
1.1 dsieger 3548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3549: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3550: <p>When you add your own preferences to the
3551: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3552: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3553: environment variables to the <code class="filename">./configure</code>
1.29 dholland 3554: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3555: <code class="varname">CFLAGS</code> from the environment variable by
3556: overriding them in the <code class="filename">Makefile</code>s of their
3557: package.</p>
3558: <p>Currently there is no solution to this problem. If you
3559: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3560: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3561: directory and then inspect any <code class="filename">Makefile</code> and
3562: <code class="filename">Makefile.in</code> for whether they define
3563: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3564: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3565: programmers write so bad code that it only works for the
3566: specific combination of <code class="varname">CFLAGS</code> they have
3567: chosen.</p>
3568: </div>
1.41 asau 3569: <div class="sect1">
1.1 dsieger 3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3571: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3572: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3573: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3574: case that occurs often is that people only update pkgsrc in
3575: parts, because of performance reasons. Since pkgsrc is one large
3576: system, not a collection of many small systems, there are
3577: sometimes changes that only work when the whole pkgsrc tree is
3578: updated.</p></li>
1.41 asau 3579: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3580: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3581: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3582: files.</p></li>
1.41 asau 3583: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3584: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3585: verify this.</p></li>
1.41 asau 3586: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3587: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3588: </ol></div>
3589: </div>
1.41 asau 3590: <div class="sect1">
1.1 dsieger 3591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23 wiz 3592: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3593: <p>You have modified a file from pkgsrc, and someone else has
3594: modified that same file afterwards in the CVS repository. Both changes
3595: are in the same region of the file, so when you updated pkgsrc, the
3596: <code class="literal">cvs</code> command marked the conflicting changes in the
3597: file. Because of these markers, the file is no longer a valid
3598: <code class="filename">Makefile</code>.</p>
3599: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3600: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3601: -dP</strong></span> in that directory to download the current version.</p>
3602: </div>
3603: </div>
3604: </div>
1.41 asau 3605: <div class="part">
1.1 dsieger 3606: <div class="titlepage"><div><div><h1 class="title">
3607: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3608: <div class="partintro">
1.1 dsieger 3609: <div></div>
3610: <p>This part of the book deals with creating and
1.23 wiz 3611: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3612: guide on creating a new package. The remaining chapters are more
3613: like a reference manual for pkgsrc.</p>
3614: <div class="toc">
3615: <p><b>Table of Contents</b></p>
3616: <dl>
1.6 rillig 3617: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3618: <dd><dl>
1.6 rillig 3619: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3620: <dd><dl>
1.6 rillig 3621: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3622: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17 imil 3623: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3624: </dl></dd>
1.6 rillig 3625: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3626: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3627: </dl></dd>
3628: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3629: <dd><dl>
1.23 wiz 3630: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3631: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3632: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3633: <dd><dl>
3634: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3635: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3636: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3637: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3638: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3639: </dl></dd>
3640: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3641: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3642: <dd><dl>
3643: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3644: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3645: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3646: </dl></dd>
1.23 wiz 3647: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3648: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3649: </dl></dd>
1.23 wiz 3650: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3651: <dd><dl>
3652: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3653: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3654: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3655: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3656: <dd><dl>
3657: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3658: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3659: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3660: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3661: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3662: </dl></dd>
3663: </dl></dd>
3664: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3665: <dd><dl>
3666: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3667: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3668: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 3669: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3670: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3671: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 3672: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3673: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3674: </dl></dd>
3675: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3676: <dd><dl>
3677: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3678: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3679: <dd><dl>
3680: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3681: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3682: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3683: and
3684: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3685: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3686: </dl></dd>
1.23 wiz 3687: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 3688: <dd><dl>
1.23 wiz 3689: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 3690: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3691: </dl></dd>
3692: </dl></dd>
3693: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3694: <dd><dl>
3695: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3696: <dd><dl>
3697: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3698: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3699: </dl></dd>
3700: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3701: <dd><dl>
1.23 wiz 3702: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 3703: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3704: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3705: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3706: </dl></dd>
3707: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3708: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3709: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3710: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3711: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3712: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3713: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3714: </dl></dd>
3715: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3716: <dd><dl>
3717: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3718: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 3719: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3720: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3721: </dl></dd>
3722: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3723: <dd><dl>
3724: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3725: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3726: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3727: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3728: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3729: <dd><dl>
3730: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3731: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3732: </dl></dd>
1.23 wiz 3733: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3734: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3735: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3736: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3737: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3738: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3739: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3740: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3741: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3742: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 3743: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3744: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3745: </dl></dd>
3746: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3747: <dd><dl>
3748: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3749: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3750: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3751: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3752: </dl></dd>
3753: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3754: <dd><dl>
3755: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3756: <dd><dl>
3757: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 3758: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6 rillig 3759: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3760: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3761: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3762: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3763: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3764: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3765: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3766: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3767: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3768: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3769: </dl></dd>
1.23 wiz 3770: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3771: <dd><dl>
3772: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3773: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3774: </dl></dd>
1.23 wiz 3775: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 3776: <dd><dl>
3777: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3778: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3779: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3780: </dl></dd>
3781: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3782: <dd><dl>
3783: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3784: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3785: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3786: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3787: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3788: </dl></dd>
1.23 wiz 3789: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 3790: <dd><dl>
3791: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3792: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3793: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 3794: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3795: </dl></dd>
1.23 wiz 3796: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 3797: <dd><dl>
3798: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3799: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3800: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3801: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3802: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3803: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3804: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3805: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3806: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3807: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3808: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3809: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3810: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3811: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3812: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3813: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3814: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3815: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3816: emulation</a></span></dt>
1.6 rillig 3817: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3818: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3819: </dl></dd>
1.6 rillig 3820: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3821: </dl></dd>
1.6 rillig 3822: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3823: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3824: <dd><dl>
1.6 rillig 3825: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3826: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3827: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 3828: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3829: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3830: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3831: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3832: </dl></dd>
3833: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3834: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3835: <dd><dl>
3836: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3837: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3838: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3839: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3840: </dl></dd>
3841: </dl>
3842: </div>
3843: </div>
1.41 asau 3844: <div class="chapter">
1.1 dsieger 3845: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3846: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3847: <div class="toc">
3848: <p><b>Table of Contents</b></p>
3849: <dl>
1.6 rillig 3850: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3851: <dd><dl>
1.6 rillig 3852: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3853: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17 imil 3854: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3855: </dl></dd>
1.6 rillig 3856: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3857: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 3858: </dl>
3859: </div>
3860: <p>When you find a package that is not yet in pkgsrc, you
3861: most likely have a URL from where you can download the source
3862: code. Starting with this URL, creating a package involves only a
3863: few steps.</p>
1.23 wiz 3864: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3865: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
3866: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3867: category in which you want to place your package. You can also create a
3868: directory of your own (maybe called <code class="filename">local</code>). In that
3869: category directory, create another directory for your package and change
3870: into it.</p></li>
1.41 asau 3871: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3872: you for a URL. Enter the URL of the distribution file (in most cases a
3873: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3874: of your package are created automatically. The distribution file is
3875: extracted automatically to fill in some details in the
3876: <code class="filename">Makefile</code> that would otherwise have to be done
3877: manually.</p></li>
1.41 asau 3878: <li class="step">
1.1 dsieger 3879: <p>Examine the extracted files to determine the dependencies of
3880: your package. Ideally, this is mentioned in some
3881: <code class="filename">README</code> file, but things may differ. For each of
3882: these dependencies, look where it exists in pkgsrc, and if there is a
3883: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3884: line to your package <code class="filename">Makefile</code> which includes that
3885: file just before the last line. If the
1.25 spz 3886: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3887: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3888: <p>If you just need binaries from a package, add a
1.1 dsieger 3889: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3890: version of the dependency and where it can be found in pkgsrc. This line
3891: should be placed in the third paragraph. If the dependency is only
3892: needed for building the package, but not when using it, use
3893: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3894: Your package may then look like this:</p>
3895: <pre class="programlisting">
3896: [...]
3897:
3898: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3899: DEPENDS+= screen-[0-9]*:../../misc/screen
3900: DEPENDS+= screen>=4.0:../../misc/screen
3901:
3902: [...]
3903:
3904: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3905: .include "../../devel/glib2/buildlink3.mk"
3906: .include "../../mk/bsd.pkg.mk"
3907: </pre>
3908: </li>
1.41 asau 3909: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3910: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3911: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3912: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3913: -e</strong></span>, which outputs additional
3914: explanations.</p></li>
1.41 asau 3915: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3916: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.1 dsieger 3917: over there, you can hopefully continue here.</p></li>
1.41 asau 3918: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3919: directory from the extracted files. Besides these files, a lot of cache
3920: files and other system information has been saved in the working
3921: directory, which may become wrong after you edited the
3922: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3923: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 3924: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.41 asau 3925: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 3926: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3927: everything works.</p></li>
1.41 asau 3928: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 3929: contains a list of the files that are installed by the package, is
1.10 hubertf 3930: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3931: >PLIST</strong></span> to generate a probably correct list. Check
3932: the file using your preferred text editor to see if the list of
3933: files looks plausible.</p></li>
1.41 asau 3934: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3935: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 3936: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3937: has been registered in the database of installed files, but with an
1.10 hubertf 3938: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3939: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3940: registered with the list of files from
3941: <code class="filename">PLIST</code>.</p></li>
1.41 asau 3942: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3943: package from the set of installed files.</p></li>
3944: </ol></div>
1.41 asau 3945: <div class="sect1">
1.1 dsieger 3946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3947: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 3948: <div class="sect2">
1.1 dsieger 3949: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3950: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3951: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3952: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3953: </div>
1.41 asau 3954: <div class="sect2">
1.1 dsieger 3955: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3956: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1 dsieger 3957: <p>KDE applications should always include
3958: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3959: settings that are typical of KDE packages.</p>
3960: </div>
1.41 asau 3961: <div class="sect2">
1.17 imil 3962: <div class="titlepage"><div><div><h3 class="title">
3963: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3964: <p>Python modules and programs packages are easily created using a
3965: set of predefined variables.</p>
1.23 wiz 3966: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
3967: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
3968: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, set the
3969: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">“<span class="quote">yes</span>”</span> so
1.17 imil 3970: pkgsrc will make use of this framework.
1.23 wiz 3971: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
3972: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
1.17 imil 3973: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3974: to the name of the script.</p>
3975: <p>
3976: If the default Python versions are not supported by the software, set the
3977: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3978: the software is known to work with, from the most recent to the older
3979: one, e.g.
3980: </p>
3981: <pre class="programlisting">
1.39 wiz 3982: PYTHON_VERSIONS_ACCEPTED= 31 27 26
1.17 imil 3983: </pre>
3984: <p>
3985: If the packaged software is a Python module, include
1.23 wiz 3986: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.17 imil 3987: In this case, the package directory should be called
1.23 wiz 3988: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
3989: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 3990: </p>
3991: <pre class="programlisting">
3992: DISTNAME= foopymodule-1.2.10
3993: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
3994: </pre>
3995: <p>If it is an application, also include
1.23 wiz 3996: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>
3997: before <span class="quote">“<span class="quote">extension.mk</span>”</span>.</p>
1.17 imil 3998: <p>If the packaged software, either it is an application or a module, is
3999: egg-aware, you only need to include
1.23 wiz 4000: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
1.17 imil 4001: <p>In order to correctly set the path to the Python interpreter, use the
4002: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 4003: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
4004: For example :
1.17 imil 4005: </p>
4006: <pre class="programlisting">
1.35 wiz 4007: REPLACE_PYTHON= *.py
1.17 imil 4008: </pre>
4009: </div>
1.1 dsieger 4010: </div>
1.41 asau 4011: <div class="sect1">
1.1 dsieger 4012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4013: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 4014: <div class="sect2">
1.1 dsieger 4015: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4016: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 4017: <div class="sect3">
1.1 dsieger 4018: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4019: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 4020: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 4021: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 4022: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 4023: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 4024: <pre class="programlisting">
4025: <code class="prompt">$</code> mkdir www/nvu
4026: <code class="prompt">$</code> cd www/nvu
4027: </pre>
4028: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 4029: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 4030: <pre class="programlisting">
4031: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4032: </pre>
4033: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4034: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 4035: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 4036: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4037: <code class="varname">COMMENT</code> fields. Then the package
4038: <code class="filename">Makefile</code> looked like that:</p>
4039: <pre class="programlisting">
4040: # $NetBSD$
4041: #
4042:
4043: DISTNAME= nvu-1.0-sources
4044: PKGNAME= nvu-1.0
4045: CATEGORIES= www
4046: MASTER_SITES= http://cvs.nvu.com/download/
4047: EXTRACT_SUFX= .tar.bz2
4048:
4049: MAINTAINER= rillig@NetBSD.org
4050: HOMEPAGE= http://cvs.nvu.com/
4051: COMMENT= Web Authoring System
4052:
4053: # url2pkg-marker (please do not remove this line.)
4054: .include "../../mk/bsd.pkg.mk"
4055: </pre>
4056: <p>Then, I quit the editor and watched pkgsrc downloading a large
4057: source archive:</p>
4058: <pre class="programlisting">
4059: url2pkg> Running "make makesum" ...
4060: => Required installed package digest>=20010302: digest-20060826 found
4061: => Fetching nvu-1.0-sources.tar.bz2
4062: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4063: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4064: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4065: url2pkg> Running "make extract" ...
4066: => Required installed package digest>=20010302: digest-20060826 found
4067: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4068: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4069: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4070: ===> Installing dependencies for nvu-1.0
4071: ===> Overriding tools for nvu-1.0
4072: ===> Extracting for nvu-1.0
4073: url2pkg> Adjusting the Makefile.
4074:
4075: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4076:
4077: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4078: </pre>
4079: </div>
1.41 asau 4080: <div class="sect3">
1.1 dsieger 4081: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4082: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 4083: <p>Now that the package has been extracted, let's see what's inside
4084: it. The package has a <code class="filename">README.txt</code>, but that only
4085: says something about mozilla, so it's probably useless for seeing what
4086: dependencies this package has. But since there is a GNU configure script
4087: in the package, let's hope that it will complain about everything it
4088: needs.</p>
4089: <pre class="programlisting">
4090: <code class="prompt">$</code> bmake
4091: => Required installed package digest>=20010302: digest-20060826 found
4092: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4093: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4094: ===> Patching for nvu-1.0
4095: ===> Creating toolchain wrappers for nvu-1.0
4096: ===> Configuring for nvu-1.0
4097: [...]
4098: configure: error: Perl 5.004 or higher is required.
4099: [...]
4100: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4101: [...]
4102: </pre>
4103: <p>That worked quite well. So I opened the package Makefile in my
4104: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 4105: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 4106: package have changed now, and since a perl wrapper is automatically
1.23 wiz 4107: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 4108: from scratch.</p>
4109: <pre class="programlisting">
4110: <code class="prompt">$</code> bmake clean
4111: ===> Cleaning for nvu-1.0
4112: <code class="prompt">$</code> bmake
4113: [...]
4114: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4115: GNU Make. You will not be able to build Mozilla without GNU Make.
4116: [...]
4117: </pre>
1.23 wiz 4118: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 4119: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4120: <pre class="programlisting">
4121: [...]
4122: checking for GTK - version >= 1.2.0... no
4123: *** Could not run GTK test program, checking why...
4124: [...]
4125: </pre>
4126: <p>Now to the other dependencies. The first question is: Where is the
4127: GTK package hidden in pkgsrc?</p>
4128: <pre class="programlisting">
4129: <code class="prompt">$</code> echo ../../*/gtk*
4130: [many packages ...]
4131: <code class="prompt">$</code> echo ../../*/gtk
4132: ../../x11/gtk
4133: <code class="prompt">$</code> echo ../../*/gtk2
4134: ../../x11/gtk2
4135: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4136: ../../x11/gtk2/buildlink3.mk
4137: </pre>
4138: <p>The first try was definitely too broad. The second one had exactly
4139: one result, which is very good. But there is one pitfall with GNOME
4140: packages. Before GNOME 2 had been released, there were already many
4141: GNOME 1 packages in pkgsrc. To be able to continue to use these
4142: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 4143: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 4144: whether this was the case here, and indeed it was.</p>
4145: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4146: file, adding the dependency is very easy. I just inserted an
4147: <code class="literal">.include</code> line before the last line of the package
4148: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4149: <pre class="programlisting">
4150: [...]
4151: .include "../../x11/gtk2/buildlink3.mk"
4152: .include "../../mk/bsd.pkg.mk
4153: </pre>
1.10 hubertf 4154: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 4155: was:</p>
4156: <pre class="programlisting">
4157: [...]
4158: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4159: checking for GTK - version >= 1.2.0... no
4160: *** Could not run GTK test program, checking why...
4161: *** The test program failed to compile or link. See the file config.log for the
4162: *** exact error that occured. This usually means GTK was incorrectly installed
4163: *** or that you have moved GTK since it was installed. In the latter case, you
4164: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4165: configure: error: Test for GTK failed.
4166: [...]
4167: </pre>
1.23 wiz 4168: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
4169: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 4170: told me that this package really wanted to have the GNOME 1 version of
4171: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 4172: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 4173: So I changed the <code class="literal">x11/gtk2</code> to
4174: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4175: and tried again.</p>
4176: <pre class="programlisting">
4177: [...]
4178: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0 -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
4179: In file included from xpidl.c:42:
4180: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4181: In file included from xpidl.c:42:
4182: xpidl.h:132: error: parse error before "IDL_ns"
4183: [...]
4184: </pre>
4185: <p>The package still does not find all of its dependencies. Now the
4186: question is: Which package provides the
4187: <code class="filename">libIDL/IDL.h</code> header file?</p>
4188: <pre class="programlisting">
4189: <code class="prompt">$</code> echo ../../*/*idl*
4190: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4191: <code class="prompt">$</code> echo ../../*/*IDL*
4192: ../../net/libIDL
4193: </pre>
4194: <p>Let's take the one from the second try. So I included the
4195: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4196: again. But the error didn't change. After digging through some of the
4197: code, I concluded that the build process of the package was broken and
4198: couldn't have ever worked, but since the Mozilla source tree is quite
4199: large, I didn't want to fix it. So I added the following to the package
4200: <code class="filename">Makefile</code> and tried again:</p>
4201: <pre class="programlisting">
4202: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4203: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4204: </pre>
4205: <p>The latter line is needed because the package expects the library
4206: <code class="filename">libIDL.so</code>, but only
4207: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4208: wrapper to rewrite that on the fly.</p>
4209: <p>The next problem was related to a recent change of the FreeType
4210: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
4211: which patch files were relevant for this issue and copied them to the
4212: <code class="filename">patches</code> directory. Then I retried, fixed the
4213: patches so that they applied cleanly and retried again. This time,
4214: everything worked.</p>
4215: </div>
1.41 asau 4216: <div class="sect3">
1.1 dsieger 4217: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4218: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 4219: <pre class="programlisting">
4220: <code class="prompt">$</code> bmake CHECK_FILES=no install
4221: [...]
4222: <code class="prompt">$</code> bmake print-PLIST >PLIST
4223: <code class="prompt">$</code> bmake deinstall
4224: <code class="prompt">$</code> bmake install
4225: </pre>
4226: </div>
4227: </div>
4228: </div>
4229: </div>
1.41 asau 4230: <div class="chapter">
1.1 dsieger 4231: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4232: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 4233: <div class="toc">
4234: <p><b>Table of Contents</b></p>
4235: <dl>
1.23 wiz 4236: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4237: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 4238: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4239: <dd><dl>
4240: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4241: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4242: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4243: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4244: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4245: </dl></dd>
4246: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4247: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4248: <dd><dl>
4249: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4250: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4251: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 4252: </dl></dd>
1.23 wiz 4253: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4254: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 4255: </dl>
4256: </div>
4257: <p>Whenever you're preparing a package, there are a number of
4258: files involved which are described in the following
4259: sections.</p>
1.41 asau 4260: <div class="sect1">
1.1 dsieger 4261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4262: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 4263: </h2></div></div></div>
4264: <p>Building, installation and creation of a binary package are all
4265: controlled by the package's <code class="filename">Makefile</code>.
4266: The <code class="filename">Makefile</code> describes various things about
4267: a package, for example from where to get it, how to configure,
4268: build, and install it.</p>
4269: <p>A package <code class="filename">Makefile</code> contains several
4270: sections that describe the package.</p>
4271: <p>In the first section there are the following variables, which
4272: should appear exactly in the order given here. The order and
4273: grouping of the variables is mostly historical and has no further
4274: meaning.</p>
1.41 asau 4275: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4276: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 4277: distribution file to be downloaded from the package's
4278: website.</p></li>
1.23 wiz 4279: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.1 dsieger 4280: package, as used by pkgsrc. You only need to provide it if
4281: <code class="varname">DISTNAME</code> (which is the default) is not a good
4282: name for the package in pkgsrc. Usually it is the pkgsrc
4283: directory name together with the version number. It must match the
4284: regular expression
4285: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4286: starts with a letter or digit, and contains only letters, digits,
4287: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 4288: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1 dsieger 4289: the package file to create if the <code class="varname">PKGNAME</code>
4290: isn't unique on a SVR4 system. The default is
4291: <code class="varname">PKGNAME</code>, which may be shortened when you use
4292: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
4293: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4294: does not produce an unique package name on a SVR4 system.
4295: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4296: characters.</p></li>
1.23 wiz 4297: <li class="listitem">
1.1 dsieger 4298: <p><code class="varname">CATEGORIES</code> is a list of categories
4299: which the package fits in. You can choose any of the top-level
4300: directories of pkgsrc for it.</p>
4301: <p>Currently the following values are available for
4302: <code class="varname">CATEGORIES</code>. If more than
4303: one is used, they need to be separated by spaces:</p>
4304: <pre class="programlisting">
4305: archivers cross geography meta-pkgs security
4306: audio databases graphics misc shells
4307: benchmarks devel ham multimedia sysutils
4308: biology editors inputmethod net textproc
4309: cad emulators lang news time
4310: chat finance mail parallel wm
4311: comms fonts math pkgtools www
4312: converters games mbone print x11
4313: </pre>
4314: </li>
1.23 wiz 4315: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4316: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4317: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4318: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4319: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.1 dsieger 4320: </ul></div>
4321: <p>The second section contains information about separately
4322: downloaded patches, if any.
4323: </p>
1.41 asau 4324: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4325: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1 dsieger 4326: Name(s) of additional files that contain distribution patches.
4327: There is no default. pkgsrc will look for them at
4328: <code class="varname">PATCH_SITES</code>.
4329: They will automatically be uncompressed before patching if
4330: the names end with <code class="filename">.gz</code> or
4331: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4332: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4333: Primary location(s) for distribution patch files (see
4334: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4335: </ul></div>
4336: <p>The third section contains the following variables.
4337: </p>
1.41 asau 4338: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4339: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4340: address of the person who feels responsible for this package,
4341: and who is most likely to look at problems or questions regarding
1.29 dholland 4342: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 4343: Other developers may contact the <code class="varname">MAINTAINER</code>
4344: before making changes to the package, but are not required to
4345: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4346: to yourself. If you really can't maintain the package for future
4347: updates, set it to
1.10 hubertf 4348: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4349: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4350: of <code class="varname">MAINTAINER</code> when you do not want other
4351: developers to update or change the package without contacting
4352: you first. A package Makefile should contain one of
4353: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4354: not both. </p></li>
1.23 wiz 4355: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4356: find more information about the package.</p></li>
1.23 wiz 4357: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4358: description of the package (should not include the package
4359: name).</p></li>
4360: </ul></div>
4361: <p>Other variables that affect the build:
4362: </p>
1.41 asau 4363: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4364: <p><code class="varname">WRKSRC</code>: The directory where the
4365: interesting distribution files of the package are found. The
4366: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4367: works for most packages.</p>
4368: <p>If a package doesn't create a subdirectory for itself
4369: (most GNU software does, for instance), but extracts itself in
4370: the current directory, you should set
4371: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4372: <p>If a package doesn't create a subdirectory with the
4373: name of <code class="varname">DISTNAME</code> but some different name,
4374: set <code class="varname">WRKSRC</code> to point to the proper name in
4375: <code class="filename">${WRKDIR}</code>, for example
4376: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4377: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
4378: <p>The name of the working directory created by pkgsrc is
4379: taken from the <code class="varname">WRKDIR_BASENAME</code>
4380: variable. By default, its value is
4381: <code class="filename">work</code>. If you want to use the same
4382: pkgsrc tree for building different kinds of binary packages,
4383: you can change the variable according to your needs. Two
4384: other variables handle common cases of setting
4385: <code class="varname">WRKDIR_BASENAME</code> individually. If
4386: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4387: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4388: the host's name is attached to the directory name. If
4389: <code class="varname">OBJMACHINE</code> is defined, the platform name
4390: is attached, which might look like
4391: <code class="filename">work.i386</code> or
4392: <code class="filename">work.sparc</code>.</p>
4393: </li></ul></div>
4394: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4395: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4396: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4397: installed in compressed form by the package. For packages using
4398: BSD-style makefiles which honor MANZ, there is
4399: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4400: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4401: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4402: below).</p></li>
1.23 wiz 4403: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.1 dsieger 4404: </ul></div>
4405: </div>
1.41 asau 4406: <div class="sect1">
1.1 dsieger 4407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4408: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4409: </h2></div></div></div>
4410: <p>The <code class="filename">distinfo</code> file contains the message
4411: digest, or checksum, of each distfile needed for the package. This
4412: ensures that the distfiles retrieved from the Internet have not been
4413: corrupted during transfer or altered by a malign force to introduce
4414: a security hole. Due to recent rumor about weaknesses of digest
4415: algorithms, all distfiles are protected using both SHA1 and RMD160
4416: message digests, as well as the file size.</p>
4417: <p>The <code class="filename">distinfo</code> file also contains the
4418: checksums for all the patches found in the
1.10 hubertf 4419: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 4420: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4421: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4422: command.</p>
4423: <p>Some packages have different sets of distfiles depending on
1.23 wiz 4424: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1 dsieger 4425: <code class="filename">distinfo</code> file and care should be taken when
4426: upgrading such a package to ensure distfile information is not
4427: lost.</p>
4428: </div>
1.41 asau 4429: <div class="sect1">
1.1 dsieger 4430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4431: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4432: <p>Many packages still don't work out-of-the box on the various
4433: platforms that are supported by pkgsrc. Therefore, a number of custom
4434: patch files are needed to make the package work. These patch files are
4435: found in the <code class="filename">patches/</code> directory.</p>
4436: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4437: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4438: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.24 wiz 4439: order</a>.</p>
1.41 asau 4440: <div class="sect2">
1.1 dsieger 4441: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4442: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4443: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4444: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4445: problems. (To force patches to apply with fuzz you can set
4446: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4447: should contain only changes for a single file, and no file should be
4448: patched by more than one patch file. This helps to keep future
4449: modifications simple.</p>
4450: <p>Each patch file is structured as follows: In the first line,
4451: there is the RCS Id of the patch itself. The second line should be
4452: empty for aesthetic reasons. After that, there should be a comment for
4453: each change that the patch does. There are a number of standard
4454: cases:</p>
1.41 asau 4455: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4456: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4457: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4458: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4459: platform and other environment (for example, the compiler) that the
4460: patch is needed for.</p></li>
4461: </ul></div>
1.24 wiz 4462: <p>In all, the patch should be commented so that any
1.1 dsieger 4463: developer who knows the code of the application can make some use of
4464: the patch. Special care should be taken for the upstream developers,
4465: since we generally want that they accept our patches, so we have less
4466: work in the future.</p>
4467: </div>
1.41 asau 4468: <div class="sect2">
1.1 dsieger 4469: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4470: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4471: <p>One important thing to mention is to pay attention that no RCS
4472: IDs get stored in the patch files, as these will cause problems when
4473: later checked into the NetBSD CVS tree. Use the
1.10 hubertf 4474: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1 dsieger 4475: problems.</p>
4476: <p>For even more automation, we recommend using
1.10 hubertf 4477: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4478: whole set of patches. You just have to backup files before you
4479: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4480: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4481: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4482: you upgrade a package this way, you can easily compare the new
4483: set of patches with the previously existing one with
1.24 wiz 4484: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4485: are replaced by new files, so carefully check if you want to take all
4486: the changes.</p>
1.1 dsieger 4487: <p>When you have finished a package, remember to generate
1.10 hubertf 4488: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4489: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 4490: <p>When adding a patch that corrects a problem in the
4491: distfile (rather than e.g. enforcing pkgsrc's view of where
4492: man pages should go), send the patch as a bug report to the
4493: maintainer. This benefits non-pkgsrc users of the package,
4494: and usually makes it possible to remove the patch in future
4495: version.</p>
1.2 rillig 4496: <p>The file names of the patch files are usually of the form
1.24 wiz 4497: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4498: Many packages still use the previous convention
4499: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4500: but new patches should be of the form containing the filename.
4501: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
4502: automatically.</p>
1.1 dsieger 4503: </div>
1.41 asau 4504: <div class="sect2">
1.1 dsieger 4505: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4506: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4507: <p>If you want to share patches between multiple packages
4508: in pkgsrc, e.g. because they use the same distfiles, set
4509: <code class="varname">PATCHDIR</code> to the path where the patch files
4510: can be found, e.g.:</p>
4511: <pre class="programlisting">
4512: PATCHDIR= ${.CURDIR}/../xemacs/patches
4513: </pre>
4514: <p>Patch files that are distributed by the author or other
4515: maintainers can be listed in
4516: <code class="varname">PATCHFILES</code>.</p>
4517: <p>If it is desired to store any patches that should not be
4518: committed into pkgsrc, they can be kept outside the pkgsrc
4519: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4520: directory tree there is expected to have the same
1.23 wiz 4521: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4522: patches are expected to be stored inside these dirs (also
4523: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4524: example, if you want to keep a private patch for
4525: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4526: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4527: files in the named directory are expected to be patch files,
4528: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4529: applied</em></span>.</p>
4530: </div>
1.41 asau 4531: <div class="sect2">
1.1 dsieger 4532: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4533: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4534: <p>When fixing a portability issue in the code do not use
4535: preprocessor magic to check for the current operating system nor
4536: platform. Doing so hurts portability to other platforms because
4537: the OS-specific details are not abstracted appropriately.</p>
4538: <p>The general rule to follow is: instead of checking for the
4539: operating system the application is being built on, check for the
4540: specific <span class="emphasis"><em>features</em></span> you need. For example,
4541: instead of assuming that kqueue is available under NetBSD and
4542: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4543: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4544: yes, this generally involves patching the
1.10 hubertf 4545: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4546: that prevents some OSes from adopting interfaces from other OSes
4547: (e.g. Linux implementing kqueue), something that the above checks
4548: cannot take into account.</p>
4549: <p>Of course, checking for features generally involves more
4550: work on the developer's side, but the resulting changes are
4551: cleaner and there are chances they will work on many other
4552: platforms. Not to mention that there are higher chances of being
4553: later integrated into the mainstream sources. Remember:
4554: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4555: <p>Some typical examples:</p>
4556: <div class="table">
1.6 rillig 4557: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4558: <div class="table-contents"><table summary="Patching examples" border="1">
4559: <colgroup>
4560: <col>
4561: <col>
4562: <col>
4563: </colgroup>
4564: <thead><tr>
4565: <th>Where</th>
4566: <th>Incorrect</th>
4567: <th>Correct</th>
4568: </tr></thead>
4569: <tbody>
4570: <tr>
4571: <td>configure script</td>
4572: <td>
4573: <pre class="programlisting">
4574: case ${target_os} in
4575: netbsd*) have_kvm=yes ;;
4576: *) have_kvm=no ;;
4577: esac
4578: </pre>
4579: </td>
4580: <td>
4581: <pre class="programlisting">
4582: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4583: </pre>
4584: </td>
4585: </tr>
4586: <tr>
4587: <td>C source file</td>
4588: <td>
4589: <pre class="programlisting">
4590: #if defined(__NetBSD__)
4591: # include <sys/event.h>
4592: #endif
4593: </pre>
4594: </td>
4595: <td>
4596: <pre class="programlisting">
4597: #if defined(HAVE_SYS_EVENT_H)
4598: # include <sys/event.h>
4599: #endif
4600: </pre>
4601: </td>
4602: </tr>
4603: <tr>
4604: <td>C source file</td>
4605: <td>
4606: <pre class="programlisting">
4607: int
4608: monitor_file(...)
4609: {
4610: #if defined(__NetBSD__)
4611: int fd = kqueue();
4612: ...
4613: #else
4614: ...
4615: #endif
4616: }
4617: </pre>
4618: </td>
4619: <td>
4620: <pre class="programlisting">
4621: int
4622: monitor_file(...)
4623: {
4624: #if defined(HAVE_KQUEUE)
4625: int fd = kqueue();
4626: ...
4627: #else
4628: ...
4629: #endif
4630: }
4631: </pre>
4632: </td>
4633: </tr>
4634: </tbody>
4635: </table></div>
4636: </div>
4637: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4638: packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4639: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4640: 2</a>). It summarizes multiple details on how to make
4641: software easier to package; all the suggestions in it were
4642: collected from our experience in pkgsrc work, so they are possibly
4643: helpful when creating patches too.</p>
4644: </div>
1.41 asau 4645: <div class="sect2">
1.1 dsieger 4646: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4647: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4648: <p>Always, always, <span class="strong"><strong>always</strong></span>
4649: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4650: improvements you do to a package to the mainstream developers.
4651: This is the only way to get their attention on portability issues
4652: and to ensure that future versions can be built out-of-the box on
4653: NetBSD. Furthermore, any user that gets newer distfiles will get
4654: the fixes straight from the packaged code.</p>
4655: <p>This generally involves cleaning up the patches
4656: (because sometimes the patches that are
1.40 wiz 4657: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4658: appropriate trackers for the projects and working with the
4659: mainstream authors to accept your changes. It is
4660: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4661: the packages in pkgsrc are kept simple and thus further changes
4662: can be done without much hassle.</p>
1.24 wiz 4663: <p>When you have done this, please add a URL to the upstream
4664: bug report to the patch comment.</p>
1.1 dsieger 4665: <p>Support the idea of free software!</p>
4666: </div>
4667: </div>
1.41 asau 4668: <div class="sect1">
1.1 dsieger 4669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4670: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4671: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4672: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4673: <dd><p>A multi-line description of the piece of software. This should include
4674: any credits where they are due. Please bear in mind that others do not
4675: share your sense of humour (or spelling idiosyncrasies), and that others
4676: will read everything that you write here.</p></dd>
4677: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4678: <dd><p>This file governs the files that are installed on your
4679: system: all the binaries, manual pages, etc. There are other
4680: directives which may be entered in this file, to control the
4681: creation and deletion of directories, and the location of
1.10 hubertf 4682: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4683: information.</p></dd>
4684: </dl></div>
4685: </div>
1.41 asau 4686: <div class="sect1">
1.1 dsieger 4687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4688: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4689: <div class="sect2">
1.1 dsieger 4690: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4691: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4692: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4693: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4694: <dd>
1.29 dholland 4695: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 4696: First time after package extraction and before files are
4697: moved in place, the second time after the files to install
4698: are moved in place. This can be used to do any custom
4699: procedures not possible with @exec commands in
1.29 dholland 4700: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4701: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><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="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.
1.28 wiz 4702: Please note that you can modify variables in it easily by using
4703: <code class="varname">FILES_SUBST</code> in the package's
4704: <code class="filename">Makefile</code>:</p>
4705: <pre class="programlisting">
4706: FILES_SUBST+= SOMEVAR="somevalue"
4707: </pre>
4708: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4709: <code class="filename">INSTALL</code>. By default, substitution is
4710: performed for <code class="varname">PREFIX</code>,
4711: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4712: <code class="varname">VARBASE</code>, and a few others, type
4713: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4714: complete list.</p>
4715: </dd>
1.1 dsieger 4716: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4717: <dd><p>This script is executed before and after any files are removed. It is
4718: this script's responsibility to clean up any additional messy details
4719: around the package's installation, since all pkg_delete knows is how to
4720: delete the files created in the original distribution.
1.29 dholland 4721: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4722: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 4723: The same methods to replace variables can be used as for
4724: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4725: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4726: <dd>
4727: <p>This file is displayed after installation of the package.
4728: Useful for things like legal notices on almost-free
4729: software and hints for updating config files after
4730: installing modules for apache, PHP etc.
4731: Please note that you can modify variables in it easily by using
4732: <code class="varname">MESSAGE_SUBST</code> in the package's
4733: <code class="filename">Makefile</code>:</p>
4734: <pre class="programlisting">
4735: MESSAGE_SUBST+= SOMEVAR="somevalue"
4736: </pre>
1.23 wiz 4737: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4738: <code class="filename">MESSAGE</code>. By default, substitution is
4739: performed for <code class="varname">PKGNAME</code>,
4740: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4741: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4742: <code class="varname">X11BASE</code>,
4743: <code class="varname">PKG_SYSCONFDIR</code>,
4744: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4745: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4746: <p>You can display a different or additional files by
4747: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4748: default is <code class="filename">MESSAGE</code>, if the file
4749: exists.</p>
4750: </dd>
4751: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4752: <dd><p>FIXME: There is no documentation on the
4753: alternatives framework.</p></dd>
4754: </dl></div>
4755: </div>
1.41 asau 4756: <div class="sect2">
1.1 dsieger 4757: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4758: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4759: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4760: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4761: <dd><p>This file contains arbitrary things that could
4762: also go into a <code class="filename">Makefile</code>, but its purpose is
4763: to be used by more than one package. This file should only be
4764: used when the packages that will use the file are known in
4765: advance. For other purposes it is often better to write a
4766: <code class="filename">*.mk</code> file and give it a good name that
4767: describes what it does.</p></dd>
4768: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4769: <dd><p>This file contains the dependency information
1.10 hubertf 4770: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 4771: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4772: <dd><p>This file contains workarounds for compiler bugs
4773: and similar things. It is included automatically by the pkgsrc
4774: infrastructure, so you don't need an extra
4775: <code class="literal">.include</code> line for
4776: it.</p></dd>
4777: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4778: <dd><p>This file contains the code for the
1.10 hubertf 4779: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1 dsieger 4780: selected by the user. If a package has only one or two options,
4781: it is equally acceptable to put the code directly into the
4782: <code class="filename">Makefile</code>.</p></dd>
4783: </dl></div>
4784: </div>
1.41 asau 4785: <div class="sect2">
1.1 dsieger 4786: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4787: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4788: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4789: <dt><span class="term"><code class="filename">README*</code></span></dt>
4790: <dd><p>These files do not take place in the creation of
4791: a package and thus are purely informative to the package
4792: developer.</p></dd>
4793: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4794: <dd><p>This file contains things that need to be done
4795: to make the package even
4796: better.</p></dd>
4797: </dl></div>
4798: </div>
4799: </div>
1.41 asau 4800: <div class="sect1">
1.1 dsieger 4801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4802: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4803: </h2></div></div></div>
1.10 hubertf 4804: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4805: unpacked into the directory denoted by
4806: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4807: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4808: directory is also used to keep various timestamp files.
4809: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4810: The default is <code class="filename">${.CURDIR}/work</code>
4811: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4812: if <code class="varname">OBJMACHINE</code> is set.</p>
4813: </div>
1.41 asau 4814: <div class="sect1">
1.1 dsieger 4815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4816: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4817: </h2></div></div></div>
4818: <p>If you have any files that you wish to be placed in the package prior
4819: to configuration or building, you could place these files here and use
1.10 hubertf 4820: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4821: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4822: this. Alternatively, you could simply diff the file against
4823: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4824: the creation of this file.</p>
4825: <p>If you want to share files in this way with other
4826: packages, set the <code class="varname">FILESDIR</code> variable to point
4827: to the other package's <code class="filename">files</code> directory,
4828: e.g.:</p>
4829: <pre class="programlisting">
4830: FILESDIR=${.CURDIR}/../xemacs/files
4831: </pre>
4832: </div>
4833: </div>
1.41 asau 4834: <div class="chapter">
1.1 dsieger 4835: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4836: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4837: <div class="toc">
4838: <p><b>Table of Contents</b></p>
4839: <dl>
1.6 rillig 4840: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4841: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4842: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4843: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4844: <dd><dl>
4845: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4846: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4847: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4848: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4849: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1 dsieger 4850: </dl></dd>
4851: </dl>
4852: </div>
4853: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4854: each of which forms a well-defined part of the pkgsrc system. Using
1.29 dholland 4855: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4856: like pkgsrc requires some discipline to keep the code correct and
4857: understandable.</p>
4858: <p>The basic ingredients for <code class="filename">Makefile</code>
4859: programming are variables (which are actually macros) and shell
4860: commands. Among these shell commands may even be more complex ones
1.29 dholland 4861: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4862: as intended it is necessary to quote all variables correctly when they
4863: are used.</p>
4864: <p>This chapter describes some patterns, that appear quite often in
4865: <code class="filename">Makefile</code>s, including the pitfalls that come along
4866: with them.</p>
1.41 asau 4867: <div class="sect1">
1.1 dsieger 4868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4869: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4871: <p>When you are creating a file as a
4872: target of a rule, always write the data to a temporary file first
4873: and finally rename that file. Otherwise there might occur an error
4874: in the middle of generating the file, and when the user runs
1.29 dholland 4875: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1 dsieger 4876: regenerated properly. Example:</p>
4877: <pre class="programlisting">
4878: wrong:
4879: @echo "line 1" > ${.TARGET}
4880: @echo "line 2" >> ${.TARGET}
4881: @false
4882:
4883: correct:
4884: @echo "line 1" > ${.TARGET}.tmp
4885: @echo "line 2" >> ${.TARGET}.tmp
4886: @false
4887: @mv ${.TARGET}.tmp ${.TARGET}
4888: </pre>
1.10 hubertf 4889: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4890: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4891: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4892: correct</strong></span> gives an error message twice, as expected.</p>
1.29 dholland 4893: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4894: <code class="literal">${.TARGET}</code> in case of error, but this only
4895: happens when it is interrupted, for example by pressing
4896: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29 dholland 4897: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4898: </li></ul></div>
4899: </div>
1.41 asau 4900: <div class="sect1">
1.1 dsieger 4901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4902: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4903: <p><code class="filename">Makefile</code> variables contain strings that
4904: can be processed using the five operators ``='', ``+='', ``?='',
1.29 dholland 4905: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4906: page.</p>
4907: <p>When a variable's value is parsed from a
4908: <code class="filename">Makefile</code>, the hash character ``#'' and the
4909: backslash character ``\'' are handled specially. If a backslash is
4910: followed by a newline, any whitespace immediately in front of the
4911: backslash, the backslash, the newline, and any whitespace
4912: immediately behind the newline are replaced with a single space. A
4913: backslash character and an immediately following hash character are
4914: replaced with a single hash character. Otherwise, the backslash is
4915: passed as is. In a variable assignment, any hash character that is
4916: not preceded by a backslash starts a comment that continues upto the
4917: end of the logical line.</p>
4918: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4919: the only way to create a variable consisting of a single backslash
4920: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4921: <p>So far for defining variables. The other thing you can do with
4922: variables is evaluating them. A variable is evaluated when it is
4923: part of the right side of the ``:='' or the ``!='' operator, or
4924: directly before executing a shell command which the variable is part
1.29 dholland 4925: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.1 dsieger 4926: is, variables are not evaluated until there's no other way. The
4927: ``modifiers'' mentioned in the man page also evaluate the
4928: variable.</p>
4929: <p>Some of the modifiers split the string into words and then
4930: operate on the words, others operate on the string as a whole. When
4931: a string is split into words, it is split as you would expect
1.29 dholland 4932: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.14 jmcneill 4933: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 4934: loop does not follow the shell quoting rules but splits at sequences
4935: of whitespace.</p>
4936: <p>There are several types of variables that should be handled
4937: differently. Strings and two types of lists.</p>
1.41 asau 4938: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4939: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 4940: characters. Nevertheless, you should restrict yourself to only
4941: using printable characters. Examples are
4942: <code class="varname">PREFIX</code> and
4943: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 4944: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 4945: are never exported to any shell command. Their elements are
4946: separated by whitespace. Therefore, the elements themselves cannot
4947: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4948: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4949: Examples are <code class="varname">DEPENDS</code> and
4950: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 4951: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 4952: may be exported to a shell command. Their elements can contain any
4953: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4954: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4955: <code class="varname">DISTFILES</code> and
4956: <code class="varname">MASTER_SITES</code>.</p></li>
4957: </ul></div>
1.41 asau 4958: <div class="sect2">
1.1 dsieger 4959: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4960: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 4961: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4962: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 4963: are reserved for use by the pkgsrc infrastructure. They shall
4964: not be used by package
4965: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 4966: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4967: lowercase variable names for the iteration
4968: variables.</p></li>
1.23 wiz 4969: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 4970: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4971: <code class="varname">DISTFILES</code>.</p></li>
4972: </ul></div>
4973: </div>
4974: </div>
1.41 asau 4975: <div class="sect1">
1.1 dsieger 4976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4977: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 4978: <p>This section presents you with some code snippets you should
4979: use in your own code. If you don't find anything appropriate here,
4980: you should test your code and add it here.</p>
1.41 asau 4981: <div class="sect2">
1.1 dsieger 4982: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4983: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 4984: <pre class="programlisting">
4985: STRING= foo * bar `date`
4986: INT_LIST= # empty
4987: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4988: EXT_LIST= # empty
4989: ANOTHER_EXT_LIST= a=b c=d
4990:
4991: INT_LIST+= ${STRING} # 1
4992: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4993: EXT_LIST+= ${STRING:Q} # 3
4994: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4995: </pre>
4996: <p>When you add a string to an external list (example 3), it
4997: must be quoted. In all other cases, you must not add a quoting
4998: level. You must not merge internal and external lists, unless you
4999: are sure that all entries are correctly interpreted in both
5000: lists.</p>
5001: </div>
1.41 asau 5002: <div class="sect2">
1.1 dsieger 5003: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5004: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1 dsieger 5005: <pre class="programlisting">
5006: EXT_LIST= # empty
5007: .for i in ${INT_LIST}
5008: EXT_LIST+= ${i:Q}""
5009: .endfor
5010: </pre>
5011: <p>This code converts the internal list
5012: <code class="varname">INT_LIST</code> into the external list
5013: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5014: are unquoted they must be quoted here. The reason for appending
5015: <code class="varname">""</code> is explained below.</p>
5016: </div>
1.41 asau 5017: <div class="sect2">
1.1 dsieger 5018: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5019: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 5020: <p>Sometimes you may want to print an arbitrary string. There
5021: are many ways to get it wrong and only few that can handle every
5022: nastiness.</p>
5023: <pre class="programlisting">
5024: STRING= foo bar < > * `date` $$HOME ' "
5025: EXT_LIST= string=${STRING:Q} x=second\ item
5026:
5027: all:
5028: echo ${STRING} # 1
5029: echo "${STRING}" # 2
5030: echo "${STRING:Q}" # 3
5031: echo ${STRING:Q} # 4
5032: echo x${STRING:Q} | sed 1s,.,, # 5
5033: printf "%s\\n" ${STRING:Q}"" # 6
5034: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
5035: </pre>
5036: <p>Example 1 leads to a syntax error in the shell, as the
5037: characters are just copied.</p>
5038: <p>Example 2 leads to a syntax error too, and if you leave out
5039: the last " character from <code class="varname">${STRING}</code>,
1.29 dholland 5040: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.1 dsieger 5041: variable would be evaluated, too.</p>
5042: <p>Example 3 outputs each space character preceded by a
5043: backslash (or not), depending on the implementation of the
1.29 dholland 5044: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.1 dsieger 5045: <p>Example 4 handles correctly every string that does not start
5046: with a dash. In that case, the result depends on the
1.29 dholland 5047: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.1 dsieger 5048: guarantee that your input does not start with a dash, this form is
5049: appropriate.</p>
5050: <p>Example 5 handles even the case of a leading dash
5051: correctly.</p>
5052: <p>Example 6 also works with every string and is the
5053: light-weight solution, since it does not involve a pipe, which has
5054: its own problems.</p>
5055: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5056: because the quoting has already been done when adding elements to
5057: the list.</p>
5058: <p>As internal lists shall not be passed to the shell, there is
5059: no example for it.</p>
5060: </div>
1.41 asau 5061: <div class="sect2">
1.1 dsieger 5062: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5063: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 5064: <p>There are many possible sources of wrongly quoted variables.
5065: This section lists some of the commonly known ones.</p>
1.41 asau 5066: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5067: <li class="listitem">
1.1 dsieger 5068: <p>Whenever you use the value of a list, think
5069: about what happens to leading or trailing whitespace. If the
5070: list is a well-formed shell expression, you can apply the
5071: <code class="varname">:M*</code> modifier to strip leading and trailing
5072: whitespace from each word. The <code class="varname">:M</code> operator
5073: first splits its argument according to the rules of the shell,
5074: and then creates a new list consisting of all words that match
5075: the shell glob expression <code class="varname">*</code>, that is: all.
5076: One class of situations where this is needed is when adding a
5077: variable like <code class="varname">CPPFLAGS</code> to
5078: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5079: invokes other configure scripts, it strips the leading and
5080: trailing whitespace from the variable and then passes it to the
5081: other configure scripts. But these configure scripts expect the
5082: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5083: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5084: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5085: here is how we do it:</p>
5086: <pre class="programlisting">
5087: CPPFLAGS= # empty
5088: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5089: CPPFLAGS+= ${MY_CPPFLAGS}
5090:
5091: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5092:
5093: all:
5094: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5095: echo x${CONFIGURE_ARGS}x # properly trimmed
5096: </pre>
5097: </li>
1.23 wiz 5098: <li class="listitem"><p>The example above contains one bug: The
1.1 dsieger 5099: <code class="varname">${PREFIX}</code> is a properly quoted shell
5100: expression, but there is the C compiler after it, which also
5101: expects a properly quoted string (this time in C syntax). The
5102: version above is therefore only correct if
5103: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5104: or double quotes. If you want to allow these, you have to add
5105: another layer of quoting to each variable that is used as a C
5106: string literal. You cannot use the <code class="varname">:Q</code>
5107: operator for it, as this operator only works for the
5108: shell.</p></li>
1.23 wiz 5109: <li class="listitem">
1.1 dsieger 5110: <p>Whenever a variable can be empty, the
5111: <code class="varname">:Q</code> operator can have surprising results. Here
5112: are two completely different cases which can be solved with the
5113: same trick.</p>
5114: <pre class="programlisting">
5115: EMPTY= # empty
5116: empty_test:
5117: for i in a ${EMPTY:Q} c; do \
5118: echo "$$i"; \
5119: done
5120:
5121: for_test:
5122: .for i in a:\ a:\test.txt
5123: echo ${i:Q}
5124: echo "foo"
5125: .endfor
5126: </pre>
5127: <p>The first example will only print two of the three lines
5128: we might have expected. This is because
5129: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5130: the shell cannot see. The workaround is to write
5131: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5132: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5133: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5134: <p>The second example will only print three lines instead of
5135: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5136: This is because the backslash of the value
5137: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29 dholland 5138: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
5139: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.1 dsieger 5140: <code class="varname">${i:Q}""</code>.</p>
5141: </li>
5142: </ul></div>
5143: </div>
1.41 asau 5144: <div class="sect2">
1.1 dsieger 5145: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5146: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 5147: <p>The pkgsrc bmake program does not handle the following
5148: assignment correctly. In case <code class="varname">_othervar_</code>
5149: contains a ``-'' character, one of the closing braces is included
5150: in <code class="varname">${VAR}</code> after this code executes.</p>
5151: <pre class="programlisting">
5152: VAR:= ${VAR:N${_othervar_:C/-//}}
5153: </pre>
5154: <p>For a more complex code snippet and a workaround, see the
5155: package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
5156: <code class="varname">bug1</code>.</p>
5157: </div>
5158: </div>
5159: </div>
1.41 asau 5160: <div class="chapter">
1.1 dsieger 5161: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5162: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 5163: <div class="toc">
5164: <p><b>Table of Contents</b></p>
5165: <dl>
1.6 rillig 5166: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 5167: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5168: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.6 rillig 5169: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5170: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 5171: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 5172: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5173: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 5174: </dl>
5175: </div>
5176: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 5177: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 5178: the package (relative to the <code class="filename">${PREFIX}</code>
5179: directory it's been installed in) plus some additional statements
1.29 dholland 5180: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 5181: This chapter addresses some issues that need attention when
5182: dealing with the <code class="filename">PLIST</code> file (or files, see
5183: below!).</p>
1.41 asau 5184: <div class="sect1">
1.1 dsieger 5185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5186: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 5187: <p>Be sure to add a RCS ID line as the first thing in any
5188: <code class="filename">PLIST</code> file you write:</p>
5189: <pre class="programlisting">
5190: @comment $NetBSD$
5191: </pre>
5192: </div>
1.41 asau 5193: <div class="sect1">
1.1 dsieger 5194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5195: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 5196: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 5197: to output a PLIST that matches any new files since the package
1.10 hubertf 5198: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.1 dsieger 5199: more information on this target.</p>
5200: </div>
1.41 asau 5201: <div class="sect1">
1.1 dsieger 5202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 5203: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 5204: </h2></div></div></div>
5205: <p>If you have used any of the *-dirs packages, as explained in
1.10 hubertf 5206: <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
5207: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1 dsieger 5208: <code class="varname">@comment</code>s instead of real
5209: <code class="varname">@dirrm</code> lines. You can also do this for
5210: specific directories and files, so that the results of that
5211: command are very close to reality. This helps <span class="emphasis"><em>a
5212: lot</em></span> during the update of packages.</p>
5213: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5214: of AWK patterns and actions that are used to filter the output of
5215: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5216: scripting you like to it, but be careful with quoting.</p>
5217: <p>For example, to get all files inside the
5218: <code class="filename">libdata/foo</code> directory removed from the
5219: resulting PLIST:</p>
5220: <pre class="programlisting">
5221: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5222: </pre>
5223: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5224: to a specific (shared) directory converted to
5225: <code class="varname">@comment</code>s:</p>
5226: <pre class="programlisting">
5227: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5228: </pre>
5229: </div>
1.41 asau 5230: <div class="sect1">
1.1 dsieger 5231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5232: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 5233: <p>A number of variables are substituted automatically in
5234: PLISTs when a package is installed on a system. This includes the
5235: following variables:</p>
1.41 asau 5236: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5237: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5238: <dd>
5239: <p>Some packages like emacs and perl embed information
5240: about which architecture they were built on into the
5241: pathnames where they install their files. To handle this
5242: case, PLIST will be preprocessed before actually used, and
5243: the symbol
1.23 wiz 5244: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 5245: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 5246: same is done if the string
5247: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5248: PLIST somewhere - use this on packages that have GNU
5249: autoconf-created configure scripts.</p>
1.41 asau 5250: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 5251: <h3 class="title">Legacy note</h3>
5252: <p>There used to be a symbol
1.23 wiz 5253: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 5254: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 5255: -m</strong></span>, but that's no longer supported and has
5256: been removed.</p>
5257: </div>
5258: </dd>
5259: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5260: <dd>
5261: <p>Some packages want to embed the OS name and version
5262: into some paths. To do this, use these variables in the
5263: <code class="filename">PLIST</code>:
5264: </p>
1.41 asau 5265: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5266: <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>
5267: <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>
5268: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.1 dsieger 5269: </ul></div>
5270: </dd>
5271: </dl></div>
5272: <p>For a complete list of values which are replaced by
5273: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5274: search for <code class="varname">PLIST_SUBST</code>).</p>
5275: <p>If you want to change other variables not listed above, you
5276: can add variables and their expansions to this variable in the
1.10 hubertf 5277: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.1 dsieger 5278: <pre class="programlisting">
5279: PLIST_SUBST+= SOMEVAR="somevalue"
5280: </pre>
1.23 wiz 5281: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 5282: in the <code class="filename">PLIST</code> with
1.23 wiz 5283: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 5284: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
5285: the common case of conditionally including some
5286: <code class="filename">PLIST</code> entries. It can be done by adding
5287: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
5288: setting the corresponding <code class="varname">PLIST.foo</code> variable
5289: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 5290: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 5291: in the <code class="filename">PLIST</code> with either
1.23 wiz 5292: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5293: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 5294: For example, in <code class="filename">Makefile</code>:</p>
5295: <pre class="programlisting">
5296: PLIST_VARS+= foo
5297: .if <em class="replaceable"><code>condition</code></em>
5298: PLIST.foo= yes
5299: .else
5300: </pre>
5301: <p>And then in <code class="filename">PLIST</code>:</p>
5302: <pre class="programlisting">
5303: @comment $NetBSD$
5304: bin/bar
5305: man/man1/bar.1
5306: ${PLIST.foo}bin/foo
5307: ${PLIST.foo}man/man1/foo.1
5308: ${PLIST.foo}share/bar/foo.data
5309: ${PLIST.foo}@dirrm share/bar
5310: </pre>
1.1 dsieger 5311: </div>
1.41 asau 5312: <div class="sect1">
1.1 dsieger 5313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5314: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5315: <p>Man pages should be installed in compressed form if
5316: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5317: and uncompressed otherwise. To handle this in the
1.23 wiz 5318: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 5319: appended/removed automatically for man pages according to
5320: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5321: or not, see above for details. This modification of the
5322: <code class="filename">PLIST</code> file is done on a copy of it, not
5323: <code class="filename">PLIST</code> itself.</p>
5324: </div>
1.41 asau 5325: <div class="sect1">
1.1 dsieger 5326: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5327: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5328: </h2></div></div></div>
5329: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5330: in generating the binary package, set the variable
5331: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29 dholland 5332: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 5333: important. The default for <code class="varname">PLIST_SRC</code> is
5334: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5335: </div>
1.41 asau 5336: <div class="sect1">
1.1 dsieger 5337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5338: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5339: <p>Some packages decide to install a different set of files based on
5340: the operating system being used. These differences can be
5341: automatically handled by using the following files:</p>
1.41 asau 5342: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5343: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5344: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5345: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5346: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5347: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 5348: </ul></div>
5349: </div>
1.41 asau 5350: <div class="sect1">
1.1 dsieger 5351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5352: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23 wiz 5353: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 5354: multiple (and unrelated) packages install files. These
1.22 jakllsch 5355: directories were problematic because you had to add special
5356: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 5357: centralized package handle them.</p>
1.22 jakllsch 5358: <p>In pkgsrc, it is now easy: Each package should create
5359: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5360: will remove any directories left empty after uninstalling a
5361: package.</p>
5362: <p>If a package needs an empty directory to work, create
5363: the directory during installation as usual, and also add an
5364: entry to the PLIST:
5365: </p>
1.1 dsieger 5366: <pre class="programlisting">
1.22 jakllsch 5367: @pkgdir path/to/empty/directory
1.1 dsieger 5368: </pre>
1.22 jakllsch 5369: <p>
5370: </p>
1.1 dsieger 5371: </div>
5372: </div>
1.41 asau 5373: <div class="chapter">
1.1 dsieger 5374: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5375: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5376: <div class="toc">
5377: <p><b>Table of Contents</b></p>
5378: <dl>
1.6 rillig 5379: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 5380: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5381: <dd><dl>
1.6 rillig 5382: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5383: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5384: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5385: and
5386: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5387: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5388: </dl></dd>
1.23 wiz 5389: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 5390: <dd><dl>
1.23 wiz 5391: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
1.6 rillig 5392: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 5393: </dl></dd>
5394: </dl>
5395: </div>
5396: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5397: are seen by a package's configure and build processes. This is implemented
5398: in a two step process:</p>
1.23 wiz 5399: <div class="orderedlist"><ol class="orderedlist" type="1">
5400: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5401: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5402: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5403: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5404: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5405: <code class="option">-L${LOCALBASE}/lib</code> into references to
5406: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5407: native compiler on some operating systems look like GCC, so that
5408: packages that expect GCC won't require modifications to build with
5409: those native compilers.</p></li>
5410: </ol></div>
5411: <p>This normalizes the environment in which a package is built so that the
5412: package may be built consistently despite what other software may be
5413: installed. Please note that the normal system header and library paths,
5414: e.g. <code class="filename">/usr/include</code>,
5415: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5416: designed to insulate the package build from non-system-supplied
5417: software.</p>
1.41 asau 5418: <div class="sect1">
1.1 dsieger 5419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5420: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5421: <p>The process of converting packages to use the buildlink3
1.23 wiz 5422: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5423: The things to keep in mind are:</p>
1.23 wiz 5424: <div class="orderedlist"><ol class="orderedlist" type="1">
5425: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5426: instead of the actual toolchain. Some packages are tricky,
5427: and the only way to know for sure is the check
5428: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5429: wrappers are being invoked.</p></li>
1.23 wiz 5430: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5431: the package Makefile, e.g. Java VMs, standalone shells,
5432: etc., because the code to symlink files into
5433: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5434: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5435: </p></li>
1.23 wiz 5436: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5437: <code class="filename">buildlink3.mk</code> files that you list in a
5438: package's Makefile are added as dependencies for that package.
5439: </p></li>
5440: </ol></div>
5441: <p>If a dependency on a particular package is required for its libraries and
5442: headers, then we replace:</p>
5443: <pre class="programlisting">
5444: DEPENDS+= foo>=1.1.0:../../category/foo
5445: </pre>
5446: <p>with</p>
5447: <pre class="programlisting">
5448: .include "../../category/foo/buildlink3.mk"
5449: </pre>
5450: <p>The buildlink3.mk files usually define the required dependencies.
5451: If you need a newer version of the dependency when using buildlink3.mk
5452: files, then you can define it in your Makefile; for example:</p>
5453: <pre class="programlisting">
5454: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5455: .include "../../category/foo/buildlink3.mk"
5456: </pre>
5457: <p>There are several <code class="filename">buildlink3.mk</code>
5458: files in <code class="filename">pkgsrc/mk</code>
5459: that handle special package issues:</p>
1.41 asau 5460: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5461: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5462: the native or a pkgsrc Berkeley DB implementation based on
5463: the values of <code class="varname">BDB_ACCEPTED</code> and
5464: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5465: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5466: comes with neither Curses nor NCurses, this will take care
5467: to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.23 wiz 5468: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5469: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5470: adding a dependency on Heimdal or MIT-krb5 for packages that
5471: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5472: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5473: system-provided Motif installation or adds a dependency on
5474: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.23 wiz 5475: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
5476: <span class="quote">“<span class="quote">lesstif</span>”</span>, or <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5477: which Motif version will be used.</p></li>
1.23 wiz 5478: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5479: variables that may be used by packages that use the
5480: Open Sound System (OSS) API.</p></li>
1.23 wiz 5481: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5482: any of the Postgres versions in the variable
5483: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5484: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5485: the file for more information.</p></li>
1.23 wiz 5486: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5487: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5488: a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.23 wiz 5489: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5490: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5491: library.</p></li>
5492: </ul></div>
5493: <p>The comments in those <code class="filename">buildlink3.mk</code>
5494: files provide a more complete
5495: description of how to use them properly.</p>
5496: </div>
1.41 asau 5497: <div class="sect1">
1.1 dsieger 5498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5499: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5500: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5501: included by Makefiles to indicate the need to compile and link
5502: against header files and libraries provided by the package. A
5503: <code class="filename">buildlink3.mk</code> file should always provide
5504: enough information to add the correct type of dependency
5505: relationship and include any other
5506: <code class="filename">buildlink3.mk</code> files that it needs to find
5507: headers and libraries that it needs in turn.</p>
5508: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5509: file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
5510: package is highly recommended. For most packages, the following
5511: command will generate a good starting point for
5512: <code class="filename">buildlink3.mk</code> files:</p>
5513: <pre class="screen">
5514: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5515: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5516: </pre>
1.41 asau 5517: <div class="sect2">
1.1 dsieger 5518: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5519: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5520: <p>The following real-life example
5521: <code class="filename">buildlink3.mk</code> is taken
5522: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5523: <pre class="programlisting">
1.18 snj 5524: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5525:
1.18 snj 5526: BUILDLINK_TREE+= tiff
1.1 dsieger 5527:
1.18 snj 5528: .if !defined(TIFF_BUILDLINK3_MK)
5529: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5530:
1.18 snj 5531: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5532: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5533: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5534:
5535: .include "../../devel/zlib/buildlink3.mk"
5536: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5537: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5538:
1.18 snj 5539: BUILDLINK_TREE+= -tiff
1.1 dsieger 5540: </pre>
5541: <p>The header and footer manipulate
1.18 snj 5542: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5543: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5544: the dependency tree.</p>
5545: <p>The main section is protected from multiple inclusion
1.1 dsieger 5546: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5547: added. Several important variables are set in the section:</p>
1.41 asau 5548: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5549: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5550: is the actual dependency recorded in the installed
5551: package; this should always be set using
1.10 hubertf 5552: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5553: we're appending to any pre-existing list of values. This
5554: variable should be set to the first version of the
1.26 wiz 5555: package that had an backwards-incompatible API change.
1.1 dsieger 5556: </p></li>
1.23 wiz 5557: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5558: is the location of the <em class="replaceable"><code>pkg</code></em>
5559: pkgsrc directory.</p></li>
1.23 wiz 5560: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5561: (not shown above) controls whether we use
5562: <code class="varname">BUILD_DEPENDS</code> or
5563: <code class="varname">DEPENDS</code> to add the dependency on
5564: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5565: selected by setting
5566: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5567: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5568: used.</p></li>
1.23 wiz 5569: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5570: and
5571: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5572: (not shown above) are lists of subdirectories of
5573: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5574: to add to the header and library search paths. These
1.23 wiz 5575: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5576: respectively.</p></li>
1.23 wiz 5577: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5578: (not shown above) is the list of preprocessor flags to add
5579: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5580: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5581: should be avoided and instead be handled using
5582: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5583: above.</p></li>
5584: </ul></div>
5585: <p>The following variables are all optionally defined within
5586: this second section (protected against multiple inclusion) and
5587: control which package files are symlinked into
5588: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5589: transformed during the symlinking:</p>
1.41 asau 5590: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5591: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5592: (not shown above) is a shell glob pattern relative to
5593: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5594: to be symlinked into
5595: <code class="filename">${BUILDLINK_DIR}</code>,
5596: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5597: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5598: (not shown above) is a shell pipeline that
5599: outputs to stdout a list of files relative to
5600: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5601: The resulting files are to be symlinked
5602: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5603: this takes the <code class="filename">+CONTENTS</code> of a
5604: <em class="replaceable"><code>pkg</code></em> and filters it through
5605: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5606: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5607: (not shown above) is a filter command that filters
5608: <code class="filename">+CONTENTS</code> input into a list of files
5609: relative to
5610: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5611: on stdout. By default for overwrite packages,
5612: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5613: outputs the contents of the <code class="filename">include</code>
5614: and <code class="filename">lib</code> directories in the package
5615: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5616: it outputs any libtool archives in
5617: <code class="filename">lib</code> directories.</p></li>
1.23 wiz 5618: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5619: (not shown above) is a list of sed arguments used to
5620: transform the name of the source filename into a
1.10 hubertf 5621: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5622: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5623: </ul></div>
1.18 snj 5624: <p>This section can additionally include any
1.1 dsieger 5625: <code class="filename">buildlink3.mk</code> needed for
5626: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5627: Including these <code class="filename">buildlink3.mk</code> files
5628: means that the headers and libraries for these
5629: dependencies are also symlinked into
5630: <code class="filename">${BUILDLINK_DIR}</code>
5631: whenever the <em class="replaceable"><code>pkg</code></em>
5632: <code class="filename">buildlink3.mk</code>
1.18 snj 5633: file is included. Dependencies are only added for directly
5634: include <code class="filename">buildlink3.mk</code> files.</p>
1.1 dsieger 5635: </div>
1.41 asau 5636: <div class="sect2">
1.1 dsieger 5637: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5638: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5639: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5640: and
5641: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5642: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5643: <p>These two variables differ in that one describes source
5644: compatibility (API) and the other binary compatibility (ABI).
5645: The difference is that a change in the API breaks compilation of
5646: programs while changes in the ABI stop compiled programs from
5647: running.</p>
5648: <p>Changes to the
1.27 wiz 5649: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5650: variable in a <code class="filename">buildlink3.mk</code> file happen
5651: very rarely. One possible reason is that all packages depending
5652: on this already need a newer version. In case it is bumped see
5653: the description below.</p>
5654: <p>The most common example of an ABI change is that the major
5655: version of a shared library is increased. In this case,
5656: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5657: should be adjusted to require at least the new package version.
5658: Then the packages that depend on this package need their
5659: <code class="varname">PKGREVISION</code>s increased and, if they have
5660: <code class="filename">buildlink3.mk</code> files, their
5661: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5662: adjusted, too. This is needed so pkgsrc will require the correct
5663: package dependency and not settle for an older one when building
5664: the source.</p>
1.10 hubertf 5665: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.26 wiz 5666: more information about dependencies on other packages,
5667: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5668: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5669: <p>Please take careful consideration before adjusting
5670: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5671: or
5672: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5673: as we don't want to cause unneeded package deletions and
5674: rebuilds. In many cases, new versions of packages work just
5675: fine with older dependencies.</p>
5676: <p>Also it is not needed to set
1.26 wiz 5677: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5678: when it is identical to
1.1 dsieger 5679: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5680: </div>
5681: </div>
1.41 asau 5682: <div class="sect1">
1.1 dsieger 5683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5684: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5685: <p>Some packages in pkgsrc install headers and libraries that
5686: coincide with headers and libraries present in the base system.
5687: Aside from a <code class="filename">buildlink3.mk</code> file, these
5688: packages should also include a <code class="filename">builtin.mk</code>
5689: file that includes the necessary checks to decide whether using
5690: the built-in software or the pkgsrc software is
5691: appropriate.</p>
5692: <p>The only requirements of a builtin.mk file for
5693: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5694: <div class="orderedlist"><ol class="orderedlist" type="1">
5695: <li class="listitem"><p>It should set
1.1 dsieger 5696: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5697: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5698: after it is included.</p></li>
1.23 wiz 5699: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5700: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5701: which is already set before the
5702: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5703: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5704: is <span class="emphasis"><em>very</em></span> important and takes careful
5705: attention to <code class="filename">Makefile</code> coding.</p></li>
5706: </ol></div>
1.41 asau 5707: <div class="sect2">
1.1 dsieger 5708: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5709: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 5710: <p>The following is the recommended template for builtin.mk
5711: files:</p>
5712: <pre class="programlisting">
5713: .if !defined(IS_BUILTIN.foo)
5714: #
5715: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5716: # genuinely exists in the system or not.
5717: #
5718: IS_BUILTIN.foo?= no
5719:
5720: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5721: # version can be determined.
5722: #
5723: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5724: BUILTIN_PKG.foo?= foo-1.0
5725: . endif
5726: .endif # IS_BUILTIN.foo
5727:
5728: .if !defined(USE_BUILTIN.foo)
5729: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5730: . if defined(BUILTIN_PKG.foo)
5731: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5732: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5733: USE_BUILTIN.foo!= \
5734: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5735: && ${ECHO} "yes" || ${ECHO} "no"
5736: . endif
5737: . endfor
5738: . endif
5739: .endif # USE_BUILTIN.foo
5740:
5741: CHECK_BUILTIN.foo?= no
5742: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5743: #
5744: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5745: # "yes" or "no".
5746: #
5747: .endif # CHECK_BUILTIN.foo
5748: </pre>
5749: <p>The first section sets
5750: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5751: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5752: in the base system. This should not be a base system software
5753: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5754: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5755: included as part of the base system. This variable is only
5756: used internally within the <code class="filename">builtin.mk</code>
5757: file.</p>
5758: <p>The second section sets
5759: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5760: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5761: system if it exists (if
5762: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5763: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5764: within the <code class="filename">builtin.mk</code> file.</p>
5765: <p>The third section sets
5766: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5767: and is <span class="emphasis"><em>required</em></span> in all
5768: <code class="filename">builtin.mk</code> files. The code in this
5769: section must make the determination whether the built-in
5770: software is adequate to satisfy the dependencies listed in
5771: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5772: This is typically done by comparing
5773: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5774: against each of the dependencies in
5775: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5776: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5777: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5778: end of the <code class="filename">builtin.mk</code> file. Note that
5779: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5780: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5781: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5782: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5783: that the built-in version of the software is similar enough to
5784: be used as a replacement.</p>
5785: <p>The last section is guarded by
5786: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5787: and includes code that uses the value of
5788: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5789: set in the previous section. This typically includes, e.g.,
5790: adding additional dependency restrictions and listing additional
5791: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5792: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5793: </div>
1.41 asau 5794: <div class="sect2">
1.1 dsieger 5795: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5796: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5797: <p>When building packages, it's possible to choose whether to set
5798: a global preference for using either the built-in (native)
5799: version or the pkgsrc version of software to satisfy a
5800: dependency. This is controlled by setting
5801: <code class="varname">PREFER_PKGSRC</code> and
5802: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5803: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.1 dsieger 5804: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5805: use the pkgsrc versions of software, while
5806: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5807: built-in versions. Preferences are determined by the most
5808: specific instance of the package in either
5809: <code class="varname">PREFER_PKGSRC</code> or
5810: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5811: in neither or in both variables, then
5812: <code class="varname">PREFER_PKGSRC</code> has precedence over
5813: <code class="varname">PREFER_NATIVE</code>. For example, to require
5814: using pkgsrc versions of software for all but the most basic
5815: bits on a NetBSD system, you can set:</p>
5816: <pre class="programlisting">
5817: PREFER_PKGSRC= yes
5818: PREFER_NATIVE= getopt skey tcp_wrappers
5819: </pre>
5820: <p>A package <span class="emphasis"><em>must</em></span> have a
5821: <code class="filename">builtin.mk</code>
5822: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5823: otherwise it is simply ignored in that list.</p>
5824: </div>
5825: </div>
5826: </div>
1.41 asau 5827: <div class="chapter">
1.1 dsieger 5828: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5829: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5830: <div class="toc">
5831: <p><b>Table of Contents</b></p>
5832: <dl>
1.6 rillig 5833: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5834: <dd><dl>
1.6 rillig 5835: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5836: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5837: </dl></dd>
1.6 rillig 5838: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5839: <dd><dl>
1.23 wiz 5840: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 5841: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5842: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5843: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5844: </dl></dd>
5845: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5846: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5847: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5848: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5849: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5850: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5851: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 5852: </dl>
5853: </div>
5854: <p>This chapter describes the framework known as
5855: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5856: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5857: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5858: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5859: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5860: provided that packages are correctly designed.</p></li>
1.23 wiz 5861: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5862: <li class="listitem"><p>Registration of system users and groups.</p></li>
5863: <li class="listitem"><p>Registration of system shells.</p></li>
5864: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5865: </ul></div>
5866: <p>The following sections inspect each of the above points in detail.</p>
5867: <p>You may be thinking that many of the things described here could be
5868: easily done with simple code in the package's post-installation target
5869: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5870: as the code in them is only executed when building from source. Machines
5871: using binary packages could not benefit from it at all (as the code itself
5872: could be unavailable). Therefore, the only way to achieve any of the items
5873: described above is by means of the installation scripts, which are
5874: automatically generated by pkginstall.</p>
1.41 asau 5875: <div class="sect1">
1.1 dsieger 5876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5877: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5878: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5879: of files and directories that belong to a package. The names used in it
5880: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5881: which means that it cannot register files outside this directory (absolute
5882: path names are not allowed). Despite this restriction, some packages need
5883: to install files outside this location; e.g., under
5884: <code class="filename">${VARBASE}</code> or
5885: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5886: is to create such files during installation time by using
5887: installation scripts.</p>
5888: <p>The generic installation scripts are shell scripts that can
5889: contain arbitrary code. The list of scripts to execute is taken from
5890: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5891: <code class="filename">INSTALL</code>. A similar variable exists for package
5892: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5893: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5894: commands, so they have the potential to create and manage files
5895: anywhere in the file system.</p>
5896: <p>Using these general installation files is not recommended, but
5897: may be needed in some special cases. One reason for avoiding them is
5898: that the user has to trust the packager that there is no unwanted or
5899: simply erroneous code included in the installation script. Also,
5900: previously there were many similar scripts for the same functionality,
5901: and fixing a common error involved finding and changing all of
5902: them.</p>
5903: <p>The pkginstall framework offers another, standardized way. It
5904: provides generic scripts to abstract the manipulation of such files
5905: and directories based on variables set in the package's
5906: <code class="filename">Makefile</code>. The rest of this section describes
5907: these variables.</p>
1.41 asau 5908: <div class="sect2">
1.1 dsieger 5909: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5910: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5911: <p>The following variables can be set to request the creation of
5912: directories anywhere in the file system:</p>
1.41 asau 5913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5914: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 5915: contain a list of directories that should be created and should attempt
5916: to be destroyed by the installation scripts. The difference between
5917: the two is that the latter prompts the administrator to remove any
5918: directories that may be left after deinstallation (because they were
5919: not empty), while the former does not.</p></li>
1.23 wiz 5920: <li class="listitem">
1.1 dsieger 5921: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5922: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5923: which directories should be created and should attempt to be destroyed
5924: by the installation scripts. Each tuple holds the following values,
5925: separated by spaces: the directory name, its owner, its group and its
5926: numerical mode. For example:</p>
5927: <pre class="programlisting">
5928: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5929: </pre>
5930: <p>The difference between the two is exactly the same as their
5931: non-<code class="varname">PERMS</code> counterparts.</p>
5932: </li>
5933: </ul></div>
5934: </div>
1.41 asau 5935: <div class="sect2">
1.1 dsieger 5936: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5937: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5938: <p>Creating non-empty files outside the installation prefix is tricky
5939: because the <code class="filename">PLIST</code> forces all files to be inside it.
5940: To overcome this problem, the only solution is to extract the file in the
5941: known place (i.e., inside the installation prefix) and copy it to the
5942: appropriate location during installation (done by the installation scripts
5943: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5944: file</em></span> in the following paragraphs, which describe the variables
5945: that can be used to automatically and consistently handle files outside the
5946: installation prefix:</p>
1.41 asau 5947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5948: <li class="listitem">
1.1 dsieger 5949: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 5950: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 5951: During installation time, the master file is copied to the target one
5952: if and only if the latter does not exist. Upon deinstallation, the
5953: target file is removed provided that it was not modified by the
5954: installation.</p>
5955: <p>The difference between the two is that the latter prompts the
5956: administrator to remove any files that may be left after
5957: deinstallation (because they were not empty), while the former does
5958: not.</p>
5959: </li>
1.23 wiz 5960: <li class="listitem">
1.1 dsieger 5961: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 5962: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 5963: files as well as their target locations. For each of them, it also
5964: specifies their owner, their group and their numeric permissions, in
5965: this order. For example:</p>
5966: <pre class="programlisting">
1.30 wiz 5967: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 dsieger 5968: </pre>
5969: <p>The difference between the two is exactly the same as their
5970: non-<code class="varname">PERMS</code> counterparts.</p>
5971: </li>
5972: </ul></div>
5973: </div>
5974: </div>
1.41 asau 5975: <div class="sect1">
1.1 dsieger 5976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5977: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5978: <p>Configuration files are special in the sense that they are installed
5979: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5980: need special treatment during installation (most of which is automated by
5981: pkginstall). The main concept you must bear in mind is that files marked
5982: as configuration files are automatically copied to the right place (somewhere
5983: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5984: and only if</em></span> they didn't exist before. Similarly, they will not
5985: be removed if they have local modifications. This ensures that
5986: administrators never lose any custom changes they may have made.</p>
1.41 asau 5987: <div class="sect2">
1.1 dsieger 5988: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5989: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 5990: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5991: specifies where configuration files shall be installed. Its contents are
5992: set based upon the following variables:</p>
1.41 asau 5993: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5994: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 5995: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5996: be overridden by the user to point to his preferred location (e.g.,
5997: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5998: Packages must not use it directly.</p></li>
1.23 wiz 5999: <li class="listitem">
1.1 dsieger 6000: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6001: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6002: for the package being built shall be installed. The definition of this
6003: variable only makes sense in the package's
6004: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
6005: <p>As an example, consider the Apache package,
6006: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
6007: configuration files under the
6008: <code class="filename">httpd/</code> subdirectory of
6009: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6010: Makefile.</p>
6011: </li>
1.23 wiz 6012: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 6013: variable that holds this package's configuration directory (if
6014: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6015: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6016: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 6017: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 6018: directory where the configuration files for the package identified by
6019: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6020: </ul></div>
6021: <p>Based on the above variables, pkginstall determines the value of
6022: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6023: variable that can be used within a package to refer to its configuration
6024: directory. The algorithm used to set its value is basically the
6025: following:</p>
1.23 wiz 6026: <div class="orderedlist"><ol class="orderedlist" type="1">
6027: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 6028: its value is used.</p></li>
1.23 wiz 6029: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 6030: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
6031: <code class="filename">Makefile</code>, the resulting value is
6032: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 6033: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 6034: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
6035: </ol></div>
6036: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 6037: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, “Directory manipulation”</a> what this means. This does not apply to
6038: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
6039: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 6040: </div>
1.41 asau 6041: <div class="sect2">
1.1 dsieger 6042: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6043: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 6044: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6045: known place, you need to teach each package where it shall install its
6046: files. In some cases you will have to patch the package Makefiles to
6047: achieve it. If you are lucky, though, it may be as easy as passing an
6048: extra flag to the configuration script; this is the case of GNU Autoconf-
6049: generated files:</p>
6050: <pre class="programlisting">
6051: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
6052: </pre>
6053: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6054: for</em></span> its configuration files, not where they will be originally
6055: installed (although the difference is never explicit,
6056: unfortunately).</p>
6057: </div>
1.41 asau 6058: <div class="sect2">
1.1 dsieger 6059: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6060: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 6061: <p>As said before, pkginstall automatically handles configuration files.
6062: This means that <span class="strong"><strong>the packages themselves must not
6063: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6064: directly</strong></span>. Bad news is that many software installation scripts
6065: will, out of the box, mess with the contents of that directory. So what is
6066: the correct procedure to fix this issue?</p>
6067: <p>You must teach the package (usually by manually patching it) to
6068: install any configuration files under the examples hierarchy,
6069: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6070: <code class="filename">PLIST</code> registers them and the administrator always
6071: has the original copies available.</p>
6072: <p>Once the required configuration files are in place (i.e., under the
6073: examples hierarchy), the pkginstall framework can use them as master copies
6074: during the package installation to update what is in
6075: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
6076: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 6077: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.1 dsieger 6078: about their syntax and their purpose. Here is an example, taken from the
6079: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
6080: <pre class="programlisting">
6081: EGDIR= ${PREFIX}/share/doc/mutt/samples
6082: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6083: </pre>
6084: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6085: package and has no meaning outside it.</p>
6086: </div>
1.41 asau 6087: <div class="sect2">
1.1 dsieger 6088: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6089: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 6090: <p>The automatic copying of config files can be toggled by setting the
6091: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6092: installation.</p>
6093: </div>
6094: </div>
1.41 asau 6095: <div class="sect1">
1.1 dsieger 6096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6097: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 6098: <p>System startup scripts are special files because they must be
6099: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 6100: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.1 dsieger 6101: can be used. However, pkginstall provides a special mechanism to handle
6102: these files.</p>
6103: <p>In order to provide system startup scripts, the package has
6104: to:</p>
1.23 wiz 6105: <div class="orderedlist"><ol class="orderedlist" type="1">
6106: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 6107: the <code class="literal">.sh</code> suffix appended. Considering the
6108: <a href="ftp://ftp.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
6109: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 6110: <li class="listitem">
1.1 dsieger 6111: <p>Tell pkginstall to handle it, appending the name of the script,
6112: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6113: Continuing the previous example:</p>
6114: <pre class="programlisting">
6115: RCD_SCRIPTS+= cupsd
6116: </pre>
6117: </li>
6118: </ol></div>
6119: <p>Once this is done, pkginstall will do the following steps for each
6120: script in an automated fashion:</p>
1.23 wiz 6121: <div class="orderedlist"><ol class="orderedlist" type="1">
6122: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 6123: substitutions described in the <code class="filename">FILES_SUBST</code>
6124: variable.</p></li>
1.23 wiz 6125: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 6126: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
6127: that this master file must be explicitly registered in the
6128: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 6129: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 6130: from the examples hierarchy into the system-wide startup scripts
6131: directory.</p></li>
6132: </ol></div>
1.41 asau 6133: <div class="sect2">
1.1 dsieger 6134: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6135: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 6136: <p>The automatic copying of config files can be toggled by setting the
6137: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6138: installation. Note that the scripts will be always copied inside the
6139: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6140: matter what the value of this variable is.</p>
6141: </div>
6142: </div>
1.41 asau 6143: <div class="sect1">
1.1 dsieger 6144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6145: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 6146: <p>If a package needs to create special users and/or groups during
6147: installation, it can do so by using the pkginstall framework.</p>
6148: <p>Users can be created by adding entries to the
6149: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6150: syntax:</p>
6151: <pre class="programlisting">
6152: user:group
6153: </pre>
6154: <p>Further specification of user details may be done by setting
6155: per-user variables.
6156: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6157: numeric UID for the user.
6158: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6159: user's description or comment.
6160: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6161: user's home directory, and defaults to
6162: <code class="filename">/nonexistent</code> if not specified.
6163: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6164: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6165: not specified.</p>
6166: <p>Similarly, groups can be created by adding entries to the
6167: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6168: <pre class="programlisting">
6169: group
6170: </pre>
6171: <p>The numeric GID of the group may be set by defining
6172: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6173: <p>If a package needs to create the users and groups at an earlier
6174: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6175: either <code class="literal">configure</code> or <code class="literal">build</code> to
6176: indicate the phase before which the users and groups are created. In
6177: this case, the numeric UIDs and GIDs of the created users and groups
6178: are automatically hardcoded into the final installation scripts.</p>
6179: </div>
1.41 asau 6180: <div class="sect1">
1.1 dsieger 6181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6182: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 6183: <p>Packages that install system shells should register them in the shell
6184: database, <code class="filename">/etc/shells</code>, to make things easier to the
6185: administrator. This must be done from the installation scripts to keep
6186: binary packages working on any system. pkginstall provides an easy way to
6187: accomplish this task.</p>
6188: <p>When a package provides a shell interpreter, it has to set the
6189: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6190: add some hooks to the installation scripts to handle it. Consider the
6191: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
6192: <pre class="programlisting">
6193: PKG_SHELL= ${PREFIX}/bin/zsh
6194: </pre>
1.41 asau 6195: <div class="sect2">
1.1 dsieger 6196: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6197: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 6198: <p>The automatic registration of shell interpreters can be disabled by
6199: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6200: environment variable to <code class="literal">NO</code>.</p>
6201: </div>
6202: </div>
1.41 asau 6203: <div class="sect1">
1.1 dsieger 6204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6205: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 6206: <p>Packages that install X11 fonts should update the database files
6207: that index the fonts within each fonts directory. This can easily be
6208: accomplished within the pkginstall framework.</p>
6209: <p>When a package installs X11 fonts, it must list the directories in
6210: which fonts are installed in the
6211: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 6212: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
6213: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.1 dsieger 6214: installation scripts to run the appropriate commands to update the fonts
6215: database files within each of those directories. For convenience, if the
6216: directory path is relative, it is taken to be relative to the package's
6217: installation prefix. Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
6218: <pre class="programlisting">
6219: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6220: </pre>
1.41 asau 6221: <div class="sect2">
1.1 dsieger 6222: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6223: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6224: <p>The automatic update of fonts databases can be disabled by
6225: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6226: environment variable to <code class="literal">NO</code>.</p>
6227: </div>
6228: </div>
6229: </div>
1.41 asau 6230: <div class="chapter">
1.1 dsieger 6231: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6232: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6233: <div class="toc">
6234: <p><b>Table of Contents</b></p>
6235: <dl>
1.6 rillig 6236: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 6237: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
1.6 rillig 6238: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 6239: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6240: </dl>
6241: </div>
6242: <p>Many packages have the ability to be built to support different
6243: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6244: in pkgsrc that provides generic handling of those options that
6245: determine different ways in which the packages can be built. It's
6246: possible for the user to specify exactly which sets of options will be
6247: built into a package or to allow a set of global default options
6248: apply.</p>
1.7 rillig 6249: <p>There are two broad classes of behaviors that one might want to
6250: control via options. One is whether some particular feature is
6251: enabled in a program that will be built anyway, often by including or
6252: not including a dependency on some other package. The other is
6253: whether or not an additional program will be built as part of the
6254: package. Generally, it is better to make a split package for such
6255: additional programs instead of using options, because it enables
6256: binary packages to be built which can then be added separately. For
6257: example, the foo package might have minimal dependencies (those
6258: packages without which foo doesn't make sense), and then the foo-gfoo
6259: package might include the GTK frontend program gfoo. This is better
6260: than including a gtk option to foo that adds gfoo, because either that
6261: option is default, in which case binary users can't get foo without
6262: gfoo, or not default, in which case they can't get gfoo. With split
6263: packages, they can install foo without having GTK, and later decide to
6264: install gfoo (pulling in GTK at that time). This is an advantage to
6265: source users too, avoiding the need for rebuilds.</p>
6266: <p>Plugins with widely varying dependencies should usually be split
6267: instead of options.</p>
6268: <p>It is often more work to maintain split packages, especially if
6269: the upstream package does not support this. The decision of split
6270: vs. option should be made based on the likelihood that users will want
6271: or object to the various pieces, the size of the dependencies that are
6272: included, and the amount of work.</p>
6273: <p>A further consideration is licensing. Non-free parts, or parts
6274: that depend on non-free dependencies (especially plugins) should
6275: almost always be split if feasible.</p>
1.41 asau 6276: <div class="sect1">
1.1 dsieger 6277: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6278: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6279: <p>Global default options are listed in
6280: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6281: that should be built into every package if that option is supported.
1.10 hubertf 6282: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6283: </div>
1.41 asau 6284: <div class="sect1">
1.1 dsieger 6285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6286: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6287: </h2></div></div></div>
6288: <p>The following example shows how
6289: <code class="filename">bsd.options.mk</code> should be used
6290: by the hypothetical ``wibble'' package, either in the package
6291: <code class="filename">Makefile</code>, or in a file,
6292: e.g. <code class="filename">options.mk</code>, that is included by the
6293: main package <code class="filename">Makefile</code>.</p>
6294: <pre class="programlisting">
6295: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6296: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6297: PKG_OPTIONS_OPTIONAL_GROUPS= database
6298: PKG_OPTIONS_GROUP.database= mysql pgsql
6299: PKG_SUGGESTED_OPTIONS= wibble-foo
6300: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6301: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6302:
6303: .include "../../mk/bsd.prefs.mk"
6304:
6305: # this package was previously named wibble2
6306: .if defined(PKG_OPTIONS.wibble2)
6307: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6308: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6309: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6310: .endif
6311:
6312: .include "../../mk/bsd.options.mk"
6313:
6314: # Package-specific option-handling
6315:
6316: ###
6317: ### FOO support
6318: ###
6319: .if !empty(PKG_OPTIONS:Mwibble-foo)
6320: CONFIGURE_ARGS+= --enable-foo
6321: .endif
6322:
6323: ###
6324: ### LDAP support
6325: ###
6326: .if !empty(PKG_OPTIONS:Mldap)
6327: . include "../../databases/openldap-client/buildlink3.mk"
6328: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6329: .endif
6330:
6331: ###
6332: ### database support
6333: ###
6334: .if !empty(PKG_OPTIONS:Mmysql)
6335: . include "../../mk/mysql.buildlink3.mk"
6336: .endif
6337: .if !empty(PKG_OPTIONS:Mpgsql)
6338: . include "../../mk/pgsql.buildlink3.mk"
6339: .endif
6340: </pre>
6341: <p>The first section contains the information about which build
6342: options are supported by the package, and any default options settings
6343: if needed.</p>
1.23 wiz 6344: <div class="orderedlist"><ol class="orderedlist" type="1">
6345: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29 dholland 6346: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 6347: options. It should be set to
6348: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6349: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6350: at the point where the options are processed.</p></li>
1.23 wiz 6351: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6352: build options supported by the package.</p></li>
1.23 wiz 6353: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6354: list of names of groups of mutually exclusive options. The options in
6355: each group are listed in
6356: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6357: The most specific setting of any option from the group takes
6358: precedence over all other options in the group. Options from the
6359: groups will be automatically added to
6360: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6361: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6362: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6363: packages will fail if no option from the group is
6364: selected.</p></li>
1.23 wiz 6365: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6366: of names of sets of options. At least one option from each set must
6367: be selected. The options in each set are listed in
6368: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6369: Options from the sets will be automatically added to
6370: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6371: fail if no option from the set is selected.</p></li>
1.23 wiz 6372: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6373: build options which are enabled by default.</p></li>
1.23 wiz 6374: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6375: of
1.23 wiz 6376: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 6377: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6378: their option counterparts. Pairs should be added with
1.23 wiz 6379: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6380: warning will be issued if the user uses a legacy
6381: variable.</p></li>
1.23 wiz 6382: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6383: of
1.23 wiz 6384: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.1 dsieger 6385: pairs that map options that have been renamed to their new
1.23 wiz 6386: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6387: the listing of global legacy options. A warning will be issued if
6388: the user uses a legacy option.</p></li>
1.23 wiz 6389: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6390: options implied by deprecated variables used. This can be used for
6391: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6392: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6393: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6394: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6395: a list of warnings about deprecated variables or options used, and
6396: what to use instead.</p></li>
6397: </ol></div>
6398: <p>A package should never modify
6399: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6400: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6401: To suggest a default set of options, use
6402: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6403: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6404: including <code class="filename">bsd.options.mk</code>. If none of
6405: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6406: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6407: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6408: happen with platform-specific options if none of them is supported on
6409: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6410: empty list and the package is otherwise treated as not using the
6411: options framework.</p>
6412: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6413: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6414: build options, properly filtered to remove unsupported and duplicate
6415: options.</p>
6416: <p>The remaining sections contain the logic that is specific to
6417: each option. The correct way to check for an option is to check
6418: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6419: <pre class="programlisting">
6420: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6421: </pre>
6422: </div>
1.41 asau 6423: <div class="sect1">
1.1 dsieger 6424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6425: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6426: <p>Options that enable similar features in different packages (like
6427: optional support for a library) should use a common name in all
6428: packages that support it (like the name of the library). If another
6429: package already has an option with the same meaning, use the same
6430: name.</p>
6431: <p>Options that enable features specific to one package, where it's
6432: unlikely that another (unrelated) package has the same (or a similar)
6433: optional feature, should use a name prefixed with
6434: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6435: <p>If a group of related packages share an optional feature
6436: specific to that group, prefix it with the name of the
1.23 wiz 6437: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6438: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6439: <p>For new options, add a line to
6440: <code class="filename">mk/defaults/options.description</code>. Lines have two
6441: fields, separated by tab. The first field is the option name, the
6442: second its description. The description should be a whole sentence
6443: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6444: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6445: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6446: </div>
1.41 asau 6447: <div class="sect1">
1.7 rillig 6448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6449: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6450: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 6451: different dependencies based on the options with which the package was
6452: built. For querying these options, the file
6453: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6454: typical example looks like this:</p>
6455: <pre class="programlisting">
6456: pkgbase := libpurple
6457: .include "../../mk/pkg-build-options.mk"
6458:
6459: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6460: ...
6461: .endif
6462: </pre>
6463: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6464: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6465: options of the libpurple package, which can then be queried like
6466: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6467: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6468: details.</p>
6469: </div>
1.1 dsieger 6470: </div>
1.41 asau 6471: <div class="chapter">
1.1 dsieger 6472: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6473: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6474: <div class="toc">
6475: <p><b>Table of Contents</b></p>
6476: <dl>
1.6 rillig 6477: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6478: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6479: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6480: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6481: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 6482: <dd><dl>
6483: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6484: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6485: </dl></dd>
1.23 wiz 6486: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6487: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6488: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6489: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6490: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6491: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6492: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6493: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6494: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6495: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 6496: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6497: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6498: </dl>
6499: </div>
1.41 asau 6500: <div class="sect1">
1.1 dsieger 6501: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6502: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6503: <p>This chapter gives a detailed description on how a package is
6504: built. Building a package is separated into different
6505: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6506: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6507: described in the following sections. Each phase is split into
1.1 dsieger 6508: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6509: containing phase, prefixed by one of <code class="varname">pre-</code>,
6510: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6511: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6512: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6513: <p>Never override the regular targets (like
6514: <code class="varname">fetch</code>), if you have to, override the
6515: <code class="varname">do-*</code> ones instead.</p>
6516: <p>The basic steps for building a program are always the same. First
6517: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6518: the local system and then extracted. After any pkgsrc-specific patches
6519: to compile properly are applied, the software can be configured, then
6520: built (usually by compiling), and finally the generated binaries, etc.
6521: can be put into place on the system.</p>
6522: <p>To get more details about what is happening at each step,
6523: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6524: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6525: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6526: </div>
1.41 asau 6527: <div class="sect1">
1.1 dsieger 6528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6529: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6530: <p>Before outlining the process performed by the NetBSD package system in
6531: the next section, here's a brief discussion on where programs are
6532: installed, and which variables influence this.</p>
6533: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6534: where all files of the final program shall be installed. It is
6535: usually set to <code class="varname">LOCALBASE</code>
6536: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6537: for pkgs in the <code class="filename">cross</code> category. The value of
6538: <code class="varname">PREFIX</code> needs to be put
6539: into the various places in the program's source where paths to
1.10 hubertf 6540: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.1 dsieger 6541: <p>When choosing which of these variables to use,
6542: follow the following rules:</p>
1.41 asau 6543: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6544: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6545: where the current pkg will be installed. When referring to a
6546: pkg's own installation path, use
1.23 wiz 6547: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6548: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6549: are installed. If you need to construct a -I or -L argument
6550: to the compiler to find includes and libraries installed by
1.23 wiz 6551: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6552: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6553: installed all packages in <code class="filename">/usr/local</code>. As
6554: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6555: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6556: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6557: distribution (from xsrc, etc.) is installed. When looking for
6558: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6559: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6560: <li class="listitem">
1.1 dsieger 6561: <p>X11-based packages are special in that they may be
6562: installed in either <code class="varname">X11BASE</code> or
6563: <code class="varname">LOCALBASE</code>.</p>
6564: <p>Usually, X11 packages should be installed under
6565: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6566: will need to include
6567: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6568: request the presence of X11 and to get the right compilation
6569: flags.</p>
6570: <p>Even though, there are some packages that cannot be installed
6571: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6572: files. These packages are special and they must be placed under
6573: <code class="varname">X11BASE</code>. To accomplish this, set either
6574: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6575: your package.</p>
6576: <p>Some notes: If you need
6577: to find includes or libraries installed by a pkg that has
6578: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6579: its pkg <code class="filename">Makefile</code>, you need to look in
6580: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6581: <code class="filename">${LOCALBASE}</code>. To force installation of
6582: all X11 packages in <code class="varname">LOCALBASE</code>, the
6583: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6584: is enabled by default.</p>
6585: </li>
1.23 wiz 6586: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1 dsieger 6587: the installed location of an X11
6588: package. <code class="varname">X11PREFIX</code> will be set to
6589: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6590: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6591: installed.</p></li>
1.23 wiz 6592: <li class="listitem">
1.1 dsieger 6593: <p>If xpkgwedge is installed, it is possible to have some
6594: packages installed in <code class="varname">X11BASE</code> and some in
6595: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6596: installed package, the <code class="varname">EVAL_PREFIX</code>
6597: definition can be used. It takes pairs in the format
1.29 dholland 6598: <span class="quote">“<span class="quote">DIRNAME=<package></span>”</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 6599: variable <code class="varname">DIRNAME</code> will be set to the prefix
6600: of the installed package <package>, or
1.23 wiz 6601: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.1 dsieger 6602: installed.</p>
6603: <p>This is best illustrated by example.</p>
6604: <p>The following lines are taken from
6605: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6606: <pre class="programlisting">
6607: EVAL_PREFIX+= GTKDIR=gtk+
6608: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6609: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6610: CONFIGURE_ARGS+= --enable-multibyte
6611: </pre>
6612: <p>Specific defaults can be defined for the packages
6613: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6614: definition of the form:</p>
6615: <pre class="programlisting">
6616: GTKDIR_DEFAULT= ${LOCALBASE}
6617: </pre>
6618: <p>where <code class="varname">GTKDIR</code> corresponds
6619: to the first definition in
6620: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6621: </li>
1.23 wiz 6622: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29 dholland 6623: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 6624: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6625: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6626: </ul></div>
6627: </div>
1.41 asau 6628: <div class="sect1">
1.1 dsieger 6629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6630: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6631: <p>When building a package, various directories are used to store
1.1 dsieger 6632: source files, temporary files, pkgsrc-internal files, and so on. These
6633: directories are explained here.</p>
6634: <p>Some of the directory variables contain relative pathnames. There
6635: are two common base directories for these relative directories:
6636: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6637: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6638: inside the package itself.</p>
1.41 asau 6639: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6640: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6641: <dd><p>This is an absolute pathname that points to the pkgsrc
6642: root directory. Generally, you don't need
6643: it.</p></dd>
6644: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6645: <dd><p>This is an absolute pathname that points to the
6646: current package.</p></dd>
6647: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6648: <dd><p>This is a pathname relative to
6649: <code class="varname">PKGSRCDIR</code> that points to the current
6650: package.</p></dd>
6651: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6652: <dd><p>This is an absolute pathname pointing to the directory
6653: where all work takes place. The distfiles are extracted to this
6654: directory. It also contains temporary directories and log files used by
6655: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6656: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6657: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6658: <dd><p>This is an absolute pathname pointing to the directory
6659: where the distfiles are extracted. It is usually a direct subdirectory
6660: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6661: that isn't hidden. This variable may be changed by a package
6662: <code class="filename">Makefile</code>.</p></dd>
6663: </dl></div>
1.14 jmcneill 6664: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6665: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6666: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6667: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6668: If users would like to have their pkgsrc trees behave in a
6669: read-only manner, then the value of
6670: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6671: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6672: </div>
1.41 asau 6673: <div class="sect1">
1.1 dsieger 6674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6675: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6676: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6677: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6678: phase. This will automatically run all phases that are required for this
6679: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6680: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6681: the package will be built, but not installed.</p>
6682: </div>
1.41 asau 6683: <div class="sect1">
1.1 dsieger 6684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6685: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6686: <p>The first step in building a package is to fetch the
6687: distribution files (distfiles) from the sites that are providing
6688: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6689: phase.</p>
1.41 asau 6690: <div class="sect2">
1.1 dsieger 6691: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6692: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 6693: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6694: defines all URLs from where the distfile, whose name is
6695: derived from the <code class="varname">DISTNAME</code> variable, is
6696: fetched. The more complicated cases are described
6697: below.</p>
6698: <p>The variable <code class="varname">DISTFILES</code> specifies
6699: the list of distfiles that have to be fetched. Its value
6700: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6701: so that most packages don't need to define it at all.
6702: <code class="varname">EXTRACT_SUFX</code> is
6703: <code class="literal">.tar.gz</code> by default, but can be changed
6704: freely. Note that if your package requires additional
6705: distfiles to the default one, you cannot just append the
6706: additional filenames using the <code class="literal">+=</code>
6707: operator, but you have write for example:</p>
6708: <pre class="programlisting">
6709: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6710: </pre>
6711: <p>Each distfile is fetched from a list of sites, usually
6712: <code class="varname">MASTER_SITES</code>. If the package has multiple
6713: <code class="varname">DISTFILES</code> or multiple
6714: <code class="varname">PATCHFILES</code> from different sites, you can
6715: set
6716: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6717: to the list of URLs where the file
6718: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6719: (including the suffix) can be found.</p>
6720: <pre class="programlisting">
6721: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6722: DISTFILES+= foo-file.tar.gz
6723: SITES.foo-file.tar.gz= \
6724: http://www.somewhere.com/somehow/ \
6725: http://www.somewhereelse.com/mirror/somehow/
6726: </pre>
6727: <p>When actually fetching the distfiles, each item from
6728: <code class="varname">MASTER_SITES</code> or
6729: <code class="varname">SITES.*</code> gets the name of each distfile
6730: appended to it, without an intermediate slash. Therefore,
6731: all site values have to end with a slash or other separator
6732: character. This allows for example to set
6733: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6734: that gets the name of the distfile as a parameter. In this
6735: case, the definition would look like:</p>
6736: <pre class="programlisting">
6737: MASTER_SITES= http://www.example.com/download.cgi?file=
6738: </pre>
1.22 jakllsch 6739: <p> The exception to this rule are URLs starting with a dash.
6740: In that case the URL is taken as is, fetched and the result stored
6741: under the name of the distfile.</p>
1.1 dsieger 6742: <p>There are some predefined values for
6743: <code class="varname">MASTER_SITES</code>, which can be used in
6744: packages. The names of the variables should speak for
6745: themselves.</p>
6746: <pre class="programlisting">
6747: ${MASTER_SITE_APACHE}
6748: ${MASTER_SITE_BACKUP}
6749: ${MASTER_SITE_CYGWIN}
6750: ${MASTER_SITE_DEBIAN}
6751: ${MASTER_SITE_FREEBSD}
6752: ${MASTER_SITE_FREEBSD_LOCAL}
6753: ${MASTER_SITE_GENTOO}
6754: ${MASTER_SITE_GNOME}
6755: ${MASTER_SITE_GNU}
6756: ${MASTER_SITE_GNUSTEP}
6757: ${MASTER_SITE_IFARCHIVE}
6758: ${MASTER_SITE_KDE}
6759: ${MASTER_SITE_MOZILLA}
6760: ${MASTER_SITE_MYSQL}
6761: ${MASTER_SITE_OPENOFFICE}
6762: ${MASTER_SITE_PERL_CPAN}
6763: ${MASTER_SITE_PGSQL}
6764: ${MASTER_SITE_R_CRAN}
6765: ${MASTER_SITE_SOURCEFORGE}
6766: ${MASTER_SITE_SOURCEFORGE_JP}
6767: ${MASTER_SITE_SUNSITE}
6768: ${MASTER_SITE_SUSE}
6769: ${MASTER_SITE_TEX_CTAN}
6770: ${MASTER_SITE_XCONTRIB}
6771: ${MASTER_SITE_XEMACS}
6772: </pre>
6773: <p>Some explanations for the less self-explaining ones:
6774: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6775: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25 spz 6776: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.1 dsieger 6777: <p>If you choose one of these predefined sites, you may
6778: want to specify a subdirectory of that site. Since these
6779: macros may expand to more than one actual site, you
6780: <span class="emphasis"><em>must</em></span> use the following construct to
6781: specify a subdirectory:</p>
6782: <pre class="programlisting">
6783: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6784: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6785: </pre>
6786: <p>Note the trailing slash after the subdirectory
6787: name.</p>
6788: </div>
1.41 asau 6789: <div class="sect2">
1.1 dsieger 6790: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6791: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6792: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6793: all the distfiles exist in a local directory
6794: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6795: user). If the files do not exist, they are fetched using
6796: commands of the form</p>
6797: <pre class="programlisting">
6798: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6799: </pre>
6800: <p>where <code class="literal">${site}</code> varies through
6801: several possibilities in turn: first,
6802: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6803: sites specified in either <code class="varname">SITES.file</code> if
6804: defined, else <code class="varname">MASTER_SITES</code> or
6805: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6806: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6807: all except the first and the last can be optionally sorted
6808: by the user, via setting either
6809: <code class="varname">MASTER_SORT_RANDOM</code>, and
6810: <code class="varname">MASTER_SORT_AWK</code> or
6811: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6812: <p> The specific command and arguments used depend on the
6813: <code class="varname">FETCH_USING</code> parameter. The example above is
6814: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6815: <p>The distfiles mirror run by the NetBSD Foundation uses the
6816: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6817: distfiles, if they are freely distributable. Packages setting
6818: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6819: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6820: mirrored.</p>
6821: </div>
6822: </div>
1.41 asau 6823: <div class="sect1">
1.1 dsieger 6824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6825: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6826: <p>After the distfile(s) are fetched, their checksum is
6827: generated and compared with the checksums stored in the
6828: distinfo file. If the checksums don't match, the build is
6829: aborted. This is to ensure the same distfile is used for
6830: building, and that the distfile wasn't changed, e.g. by some
6831: malign force, deliberately changed distfiles on the master
6832: distribution site or network lossage.</p>
6833: </div>
1.41 asau 6834: <div class="sect1">
1.1 dsieger 6835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6836: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6837: <p>When the distfiles are present on the local system, they
6838: need to be extracted, as they usually come in the form of some
6839: compressed archive format.</p>
6840: <p>By default, all <code class="varname">DISTFILES</code> are
6841: extracted. If you only need some of them, you can set the
6842: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6843: files.</p>
6844: <p>Extracting the files is usually done by a little
6845: program, <code class="filename">mk/extract/extract</code>, which
6846: already knows how to extract various archive formats, so most
6847: likely you will not need to change anything here. But if you
6848: need, the following variables may help you:</p>
1.41 asau 6849: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6850: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6851: <dd><p>Use these variables to override the default
6852: options for an extract command, which are defined in
6853: <code class="filename">mk/extract/extract</code>.</p></dd>
6854: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6855: <dd><p>This variable can be set to
1.14 jmcneill 6856: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6857: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6858: absolute pathname pointing to the command with which tar
1.14 jmcneill 6859: archives should be extracted. It is preferred to choose bsdtar over gtar
6860: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6861: </dl></div>
6862: <p>If the <code class="filename">extract</code> program doesn't
6863: serve your needs, you can also override the
6864: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6865: command used for extracting the files. This command is
6866: executed in the <code class="filename">${WRKSRC}</code>
6867: directory. During execution of this command, the shell
6868: variable <code class="varname">extract_file</code> holds the absolute
6869: pathname of the file that is going to be extracted.</p>
6870: <p>And if that still does not suffice, you can override the
6871: <code class="varname">do-extract</code> target in the package
6872: Makefile.</p>
6873: </div>
1.41 asau 6874: <div class="sect1">
1.1 dsieger 6875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6876: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6877: <p>After extraction, all the patches named by the
6878: <code class="varname">PATCHFILES</code>, those present in the patches
6879: subdirectory of the package as well as in
6880: $LOCALPATCHES/$PKGPATH (e.g.
6881: <code class="filename">/usr/local/patches/graphics/png</code>) are
6882: applied. Patchfiles ending in <code class="filename">.Z</code> or
6883: <code class="filename">.gz</code> are uncompressed before they are
6884: applied, files ending in <code class="filename">.orig</code> or
6885: <code class="filename">.rej</code> are ignored. Any special options to
1.29 dholland 6886: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.10 hubertf 6887: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
1.29 dholland 6888: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 6889: it fail if the patches apply with some lines of fuzz. Please
6890: fix (regen) the patches so that they apply cleanly. The
6891: rationale behind this is that patches that don't apply cleanly
6892: may end up being applied in the wrong place, and cause severe
6893: harm there.</p>
6894: </div>
1.41 asau 6895: <div class="sect1">
1.1 dsieger 6896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6897: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6898: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1 dsieger 6899: </p>
6900: </div>
1.41 asau 6901: <div class="sect1">
1.1 dsieger 6902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6903: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6904: <p>This phase creates wrapper programs for the compilers and
6905: linkers. The following variables can be used to tweak the
6906: wrappers.</p>
1.41 asau 6907: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6908: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6909: <dd><p>The command used to print progress
6910: messages. Does nothing by default. Set to
6911: <code class="literal">${ECHO}</code> to see the progress
6912: messages.</p></dd>
6913: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6914: <dd><p>This variable can be set to
6915: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6916: depending on whether you want additional information in the
6917: wrapper log file.</p></dd>
6918: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6919: <dd><p>This variable can be set to
6920: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6921: on whether the wrapper should use its cache, which will
6922: improve the speed. The default value is
6923: <code class="literal">yes</code>, but is forced to
6924: <code class="literal">no</code> if the platform does not support
6925: it.</p></dd>
6926: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6927: <dd><p>A list of reordering commands. A reordering
6928: command has the form
6929: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6930: It ensures that that
6931: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6932: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6933: </p></dd>
6934: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6935: <dd><p>A list of transformation commands. [TODO:
6936: investigate further]</p></dd>
6937: </dl></div>
6938: </div>
1.41 asau 6939: <div class="sect1">
1.1 dsieger 6940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6941: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6942: <p>Most pieces of software need information on the header
6943: files, system calls, and library routines which are available
6944: on the platform they run on. The process of determining this
6945: information is known as configuration, and is usually
6946: automated. In most cases, a script is supplied with the
6947: distfiles, and its invocation results in generation of header
6948: files, Makefiles, etc.</p>
6949: <p>If the package contains a configure script, this can be
6950: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 6951: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 6952: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 6953: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 6954: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6955: <pre class="programlisting">
6956: .for d in ${CONFIGURE_DIRS}
6957: cd ${WRKSRC} \
6958: && cd ${d} \
6959: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6960: .endfor
6961: </pre>
6962: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 6963: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 6964: <code class="varname">WRKSRC</code>. In each of these directories, the
6965: configure script is run with the environment
6966: <code class="varname">CONFIGURE_ENV</code> and arguments
6967: <code class="varname">CONFIGURE_ARGS</code>. The variables
6968: <code class="varname">CONFIGURE_ENV</code>,
6969: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 6970: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 6971: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6972: package.</p>
1.37 wiz 6973: <p>If the program uses the Perl way of configuration (mainly Perl
6974: modules, but not only), i.e. a file called
6975: <code class="filename">Makefile.PL</code>, it should include
6976: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
6977: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
6978: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 6979: <p>If the program uses an <code class="filename">Imakefile</code>
6980: for configuration, the appropriate steps can be invoked by
6981: setting <code class="varname">USE_IMAKE</code> to
1.23 wiz 6982: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.1 dsieger 6983: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6984: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6985: xmkmf's environment by adding them to the
6986: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 6987: <p>If the program uses <code class="filename">cmake</code>
6988: for configuration, the appropriate steps can be invoked by
1.23 wiz 6989: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 6990: You can add variables to cmake's environment by adding them to the
6991: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6992: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6993: The top directory argument is given by the
6994: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 6995: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6996: <p>If there is no configure step at all, set
1.23 wiz 6997: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 6998: </div>
1.41 asau 6999: <div class="sect1">
1.1 dsieger 7000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7001: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7002: <p>For building a package, a rough equivalent of the
7003: following code is executed.</p>
7004: <pre class="programlisting">
7005: .for d in ${BUILD_DIRS}
7006: cd ${WRKSRC} \
7007: && cd ${d} \
7008: && env ${MAKE_ENV} \
7009: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
7010: -f ${MAKE_FILE} \
7011: ${BUILD_TARGET}
7012: .endfor
7013: </pre>
7014: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 7015: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 7016: <code class="varname">WRKSRC</code>. In each of these directories,
7017: <code class="varname">MAKE_PROGRAM</code> is run with the environment
7018: <code class="varname">MAKE_ENV</code> and arguments
7019: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
7020: <code class="varname">MAKE_ENV</code>,
7021: <code class="varname">BUILD_MAKE_FLAGS</code>,
7022: <code class="varname">MAKE_FILE</code> and
7023: <code class="varname">BUILD_TARGET</code> may all be changed by the
7024: package.</p>
7025: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 7026: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
7027: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 7028: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 7029: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
7030: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 7031: <p>If there is no build step at all, set
1.23 wiz 7032: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 7033: </div>
1.41 asau 7034: <div class="sect1">
1.1 dsieger 7035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7036: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 7037: <p>[TODO]</p>
7038: </div>
1.41 asau 7039: <div class="sect1">
1.1 dsieger 7040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7041: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 7042: <p>Once the build stage has completed, the final step is to
7043: install the software in public directories, so users can
7044: access the programs and files.</p>
7045: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
7046: equivalent of the following code is executed. Additionally,
7047: before and after this code, much magic is performed to do
7048: consistency checks, registering the package, and so on.</p>
7049: <pre class="programlisting">
7050: .for d in ${INSTALL_DIRS}
7051: cd ${WRKSRC} \
7052: && cd ${d} \
7053: && env ${MAKE_ENV} \
7054: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7055: -f ${MAKE_FILE} \
7056: ${INSTALL_TARGET}
7057: .endfor
7058: </pre>
7059: <p>The variable's meanings are analogous to the ones in the
7060: <span class="emphasis"><em>build</em></span> phase.
7061: <code class="varname">INSTALL_DIRS</code> defaults to
7062: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 7063: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
7064: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 7065: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7066: defined.</p>
7067: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7068: variables are useful. They are all variations of the
1.29 dholland 7069: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 7070: permissions preset. <code class="varname">INSTALL</code> is the plain
7071: install command. The specialized variants, together with their
7072: intended use, are:</p>
1.41 asau 7073: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7074: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7075: <dd><p>directories that contain
7076: binaries</p></dd>
7077: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7078: <dd><p>directories that contain
7079: scripts</p></dd>
7080: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7081: <dd><p>directories that contain shared and static
7082: libraries</p></dd>
7083: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7084: <dd><p>directories that contain data
7085: files</p></dd>
7086: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7087: <dd><p>directories that contain man
7088: pages</p></dd>
7089: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7090: <dd><p>binaries that can be stripped from debugging
7091: symbols</p></dd>
7092: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7093: <dd><p>binaries that cannot be
7094: stripped</p></dd>
7095: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7096: <dd><p>game
7097: binaries</p></dd>
7098: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7099: <dd><p>shared and static
7100: libraries</p></dd>
7101: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7102: <dd><p>data files</p></dd>
7103: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7104: <dd><p>data files for
7105: games</p></dd>
7106: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7107: <dd><p>man pages</p></dd>
7108: </dl></div>
7109: <p>Some other variables are:</p>
1.41 asau 7110: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7111: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7112: <dd><p>A list of directories relative to
7113: <code class="varname">PREFIX</code> that are created by pkgsrc at the
7114: beginning of the <span class="emphasis"><em>install</em></span> phase.
7115: The package is supposed to create all needed directories itself
7116: before installing files to it and list all other directories here.
7117: </p></dd>
7118: </dl></div>
7119: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 7120: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 7121: mostly relevant for packages in the <code class="filename">regress</code>
7122: category.</p>
7123: </div>
1.41 asau 7124: <div class="sect1">
1.1 dsieger 7125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7126: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 7127: <p>Once the install stage has completed, a binary package of
7128: the installed files can be built. These binary packages can be
7129: used for quick installation without previous compilation, e.g. by
1.10 hubertf 7130: the <span class="command"><strong>make bin-install</strong></span> or by using
7131: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 7132: <p>By default, the binary packages are created in
7133: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7134: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7135: one for each category in the <code class="varname">CATEGORIES</code>
7136: variable. <code class="varname">PACKAGES</code> defaults to
7137: <code class="filename">pkgsrc/packages</code>.</p>
7138: </div>
1.41 asau 7139: <div class="sect1">
1.1 dsieger 7140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7141: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 7142: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 7143: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 7144: to clean the work directories of all dependencies too, use
1.10 hubertf 7145: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 7146: </div>
1.41 asau 7147: <div class="sect1">
1.1 dsieger 7148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7149: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 7150: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7151: <dt><span class="term">pre/post-*</span></dt>
7152: <dd><p>For any of the main targets described in the
7153: previous section, two auxiliary targets exist with
1.23 wiz 7154: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 7155: prefix for the main target's name. These targets are
7156: invoked before and after the main target is called,
7157: allowing extra configuration or installation steps be
7158: performed from a package's Makefile, for example, which
7159: a program's configure script or install target
7160: omitted.</p></dd>
7161: <dt><span class="term">do-*</span></dt>
7162: <dd><p>Should one of the main targets do the wrong thing,
7163: and should there be no variable to fix this, you can
7164: redefine it with the do-* target. (Note that redefining
7165: the target itself instead of the do-* target is a bad
7166: idea, as the pre-* and post-* targets won't be called
7167: anymore, etc.) You will not usually need to do
7168: this.</p></dd>
7169: <dt><span class="term">reinstall</span></dt>
7170: <dd>
1.10 hubertf 7171: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 7172: you noticed some file was not installed properly, you
7173: can repeat the installation with this target, which will
1.23 wiz 7174: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 7175: <p>This is the default value of
7176: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 7177: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 7178: package</strong></span>, where the defaults are
1.23 wiz 7179: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 7180: respectively.</p>
7181: </dd>
7182: <dt><span class="term">deinstall</span></dt>
7183: <dd>
1.29 dholland 7184: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 7185: current directory, effectively de-installing the
7186: package. The following variables can be used to tune the
7187: behaviour:</p>
1.41 asau 7188: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7189: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29 dholland 7190: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 7191: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7192: <dd><p>Remove all packages that require (depend on)
7193: the given package. This can be used to remove any
7194: packages that may have been pulled in by a given
1.10 hubertf 7195: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 7196: DEINSTALLDEPENDS=1</strong></span> is done in
7197: <code class="filename">pkgsrc/x11/kde</code>, this is
7198: likely to remove whole KDE. Works by adding
1.29 dholland 7199: <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+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 7200: command line.</p></dd>
7201: </dl></div>
7202: </dd>
7203: <dt><span class="term">bin-install</span></dt>
7204: <dd><p>Install a binary package from local disk and via FTP
7205: from a list of sites (see the
7206: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 7207: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 7208: available anywhere. The arguments given to
1.10 hubertf 7209: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 7210: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7211: operation, etc.</p></dd>
7212: <dt><span class="term">update</span></dt>
7213: <dd>
7214: <p>This target causes the current package to be
7215: updated to the latest version. The package and all
7216: depending packages first get de-installed, then current
7217: versions of the corresponding packages get compiled and
7218: installed. This is similar to manually noting which
7219: packages are currently installed, then performing a
1.10 hubertf 7220: series of <span class="command"><strong>make deinstall</strong></span> and
7221: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 7222: <code class="varname">UPDATE_TARGET</code> is set to) for these
7223: packages.</p>
1.23 wiz 7224: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 7225: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 7226: update</strong></span> was interrupted for some reason.
7227: However, in this case, make sure you don't call
1.10 hubertf 7228: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 7229: list of dependent packages in <code class="varname">WRKDIR</code>.
7230: Otherwise, you lose the ability to automatically update
7231: the current package along with the dependent packages
7232: you have installed.</p>
1.10 hubertf 7233: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 7234: update</strong></span> will only work as long as the package
7235: tree remains unchanged. If the source code for one of
7236: the packages to be updated has been changed, resuming
1.10 hubertf 7237: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 7238: fail!</p>
7239: <p>The following variables can be used either on the
1.10 hubertf 7240: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7241: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7242: update</strong></span>:</p>
1.41 asau 7243: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7244: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7245: <dd><p>Install target to recursively use for the
7246: updated package and the dependent packages.
7247: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 7248: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 7249: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 7250: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7251: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7252: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 7253: endless loop!</p></dd>
7254: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7255: <dd><p>Don't clean up after updating. Useful if
7256: you want to leave the work sources of the updated
7257: packages around for inspection or other purposes.
7258: Be sure you eventually clean up the source tree
1.23 wiz 7259: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 7260: or you may run into troubles with old source code
7261: still lying around on your next
1.10 hubertf 7262: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7263: update</strong></span>.</p></dd>
7264: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7265: <dd><p>Deinstall each package before installing
7266: (making <code class="varname">DEPENDS_TARGET</code>). This
7267: may be necessary if the
1.23 wiz 7268: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 7269: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7270: update</strong></span>.</p></dd>
7271: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7272: <dd><p>Allows you to disable recursion and hardcode
7273: the target for packages. The default is
1.23 wiz 7274: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 7275: facilitating a recursive update of prerequisite
7276: packages. Only set
7277: <code class="varname">DEPENDS_TARGET</code> if you want to
7278: disable recursive updates. Use
7279: <code class="varname">UPDATE_TARGET</code> instead to just
7280: set a specific target for each package to be
1.10 hubertf 7281: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7282: (see above).</p></dd>
7283: </dl></div>
7284: </dd>
7285: <dt><span class="term">clean-update</span></dt>
7286: <dd>
7287: <p>Clean the source tree for all packages that would
1.10 hubertf 7288: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7289: from the current directory. This target should not be
7290: used if the current package (or any of its depending
7291: packages) have already been de-installed (e.g., after
1.10 hubertf 7292: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7293: some packages you intended to update. As a rule of
7294: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7295: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7296: and only if you have a dirty package tree (e.g., if you
7297: used <code class="varname">NOCLEAN</code>).</p>
7298: <p>If you are unsure about whether your tree is
1.10 hubertf 7299: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7300: clean</strong></span> at the top of the tree, or use the
7301: following sequence of commands from the directory of the
7302: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7303: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7304: time, otherwise you lose all the packages you wanted to
7305: update!):</p>
7306: <pre class="screen">
7307: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7308: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7309: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7310: </pre>
7311: <p>The following variables can be used either on the
1.10 hubertf 7312: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7313: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 7314: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7315: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7316: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7317: reconstruct the list of directories to update for
1.10 hubertf 7318: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7319: update</strong></span> successfully installed all
7320: packages you wanted to update. Normally, this is
1.10 hubertf 7321: done automatically on <span class="command"><strong>make
1.1 dsieger 7322: update</strong></span>, but may have been suppressed by
7323: the <code class="varname">NOCLEAN</code> variable (see
7324: above).</p></dd>
7325: </dl></div>
7326: </dd>
7327: <dt><span class="term">replace</span></dt>
7328: <dd>
7329: <p>Update the installation of the current package. This
7330: differs from update in that it does not replace dependent
7331: packages. You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
7332: target to work.</p>
7333: <p><span class="emphasis"><em>Be careful when using this
7334: target!</em></span> There are no guarantees that dependent
7335: packages will still work, in particular they will most
1.10 hubertf 7336: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7337: library package whose shared library major version changed
7338: between your installed version and the new one. For this
7339: reason, this target is not officially supported and only
7340: recommended for advanced users.</p>
7341: </dd>
7342: <dt><span class="term">info</span></dt>
1.29 dholland 7343: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 7344: package. You can use this to check which version of a
7345: package is installed.</p></dd>
7346: <dt><span class="term">index</span></dt>
7347: <dd>
7348: <p>This is a top-level command, i.e. it should be used in
7349: the <code class="filename">pkgsrc</code> directory. It creates a
7350: database of all packages in the local pkgsrc tree, including
7351: dependencies, comment, maintainer, and some other useful
7352: information. Individual entries are created by running
1.10 hubertf 7353: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7354: directories. This index file is saved as
7355: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7356: verbose format by running <span class="command"><strong>make
1.1 dsieger 7357: print-index</strong></span>. You can search in it with
1.10 hubertf 7358: <span class="command"><strong>make search
1.1 dsieger 7359: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7360: extract a list of all packages that depend on a particular
1.10 hubertf 7361: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7362: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7363: <p>Running this command takes a very long time, some
7364: hours even on fast machines!</p>
7365: </dd>
7366: <dt><span class="term">readme</span></dt>
7367: <dd>
7368: <p>This target generates a
7369: <code class="filename">README.html</code> file, which can be
7370: viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>. The generated files
7371: contain references to any packages which are in the
7372: <code class="varname">PACKAGES</code> directory on the local
7373: host. The generated files can be made to refer to URLs
7374: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7375: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7376: wanted to generate <code class="filename">README.html</code>
7377: files which pointed to binary packages on the local
7378: machine, in the directory
7379: <code class="filename">/usr/packages</code>, set
7380: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7381: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7382: <code class="varname">${PACKAGES}</code> directory and its
7383: subdirectories will be searched for all the binary
7384: packages.</p>
7385: <p>The target can be run at the toplevel or in category
7386: directories, in which case it descends recursively.</p>
7387: </dd>
7388: <dt><span class="term">readme-all</span></dt>
7389: <dd><p>This is a top-level command, run it in
7390: <code class="filename">pkgsrc</code>. Use this target to create a
7391: file <code class="filename">README-all.html</code> which contains a
7392: list of all packages currently available in the NetBSD
7393: Packages Collection, together with the category they belong
7394: to and a short description. This file is compiled from the
7395: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7396: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7397: readme</strong></span>.</p></dd>
7398: <dt><span class="term">cdrom-readme</span></dt>
7399: <dd><p>This is very much the same as the
1.23 wiz 7400: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7401: used when generating a pkgsrc tree to be written to a
7402: CD-ROM. This target also produces
7403: <code class="filename">README.html</code> files, and can be made
7404: to refer to URLs based on
7405: <code class="varname">CDROM_PKG_URL_HOST</code> and
7406: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7407: <dt><span class="term">show-distfiles</span></dt>
7408: <dd><p>This target shows which distfiles and patchfiles
7409: are needed to build the package
7410: (<code class="varname">ALLFILES</code>, which contains all
7411: <code class="varname">DISTFILES</code> and
7412: <code class="varname">PATCHFILES</code>, but not
7413: <code class="filename">patches/*</code>).</p></dd>
7414: <dt><span class="term">show-downlevel</span></dt>
7415: <dd><p>This target shows nothing if the package is not
7416: installed. If a version of this package is installed,
7417: but is not the version provided in this version of
7418: pkgsrc, then a warning message is displayed. This target
7419: can be used to show which of your installed packages are
7420: downlevel, and so the old versions can be deleted, and
7421: the current ones added.</p></dd>
7422: <dt><span class="term">show-pkgsrc-dir</span></dt>
7423: <dd><p>This target shows the directory in the pkgsrc
7424: hierarchy from which the package can be built and
7425: installed. This may not be the same directory as the one
7426: from which the package was installed. This target is
7427: intended to be used by people who may wish to upgrade
7428: many packages on a single host, and can be invoked from
7429: the top-level pkgsrc Makefile by using the
1.23 wiz 7430: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7431: <dt><span class="term">show-installed-depends</span></dt>
7432: <dd><p>This target shows which installed packages match
7433: the current package's <code class="varname">DEPENDS</code>. Useful
7434: if out of date dependencies are causing build
7435: problems.</p></dd>
7436: <dt><span class="term">check-shlibs</span></dt>
7437: <dd><p>After a package is installed, check all its
7438: binaries and (on ELF platforms) shared libraries to see
7439: if they find the shared libs they need. Run by default
1.10 hubertf 7440: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 7441: <dt><span class="term">print-PLIST</span></dt>
7442: <dd>
1.23 wiz 7443: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7444: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7445: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7446: -newer work/.extract_done</strong></span>. An attempt is made
7447: to care for shared libs etc., but it is
7448: <span class="emphasis"><em>strongly</em></span> recommended to review the
7449: result before putting it into
7450: <code class="filename">PLIST</code>. On upgrades, it's useful to
7451: diff the output of this command against an already
7452: existing <code class="filename">PLIST</code> file.</p>
1.29 dholland 7453: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 7454: other methods that don't update file access times, be
7455: sure to add these files manually to your
1.23 wiz 7456: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7457: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7458: them!</p>
1.23 wiz 7459: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.1 dsieger 7460: information on this target.</p>
7461: </dd>
7462: <dt><span class="term">bulk-package</span></dt>
7463: <dd>
7464: <p>Used to do bulk builds. If an appropriate binary
7465: package already exists, no action is taken. If not, this
7466: target will compile, install and package it (and its
7467: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10 hubertf 7468: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.1 dsieger 7469: After creating the binary package, the sources, the
7470: just-installed package and its required packages are
7471: removed, preserving free disk space.</p>
7472: <p><span class="emphasis"><em>Beware that this target may deinstall
7473: all packages installed on a system!</em></span></p>
7474: </dd>
7475: <dt><span class="term">bulk-install</span></dt>
7476: <dd>
7477: <p>Used during bulk-installs to install required
7478: packages. If an up-to-date binary package is available,
1.29 dholland 7479: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 7480: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7481: but the installed binary won't be removed.</p>
7482: <p>A binary package is considered
1.23 wiz 7483: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.29 dholland 7484: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 7485: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7486: <li class="listitem"><p>None of the package's files
1.1 dsieger 7487: (<code class="filename">Makefile</code>, ...) were modified
7488: since it was built.</p></li>
1.23 wiz 7489: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7490: packages were modified since it was built.</p></li>
7491: </ul></div>
7492: <p><span class="emphasis"><em>Beware that this target may deinstall
7493: all packages installed on a system!</em></span></p>
7494: </dd>
7495: </dl></div>
7496: </div>
7497: </div>
1.41 asau 7498: <div class="chapter">
1.1 dsieger 7499: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7500: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7501: <div class="toc">
7502: <p><b>Table of Contents</b></p>
7503: <dl>
1.6 rillig 7504: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7505: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7506: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7507: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7508: </dl>
7509: </div>
7510: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7511: by pkgsrc and also for individual packages to define what commands
7512: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7513: or for later run-time of an installed packaged (such as
7514: <code class="varname">DEPENDS</code>).
7515: If the native system provides an adequate tool, then in many cases, a pkgsrc
7516: package will not be used.</p>
7517: <p>When building a package, the replacement tools are
7518: made available in a directory (as symlinks or wrapper scripts)
7519: that is early in the executable search path. Just like the buildlink
7520: system, this helps with consistent builds.</p>
7521: <p>A tool may be needed to help build a specific package. For example,
7522: perl, GNU make (gmake) or yacc may be needed.</p>
7523: <p>Also a tool may be needed, for example, because the native system's supplied
7524: tool may be inefficient for building a package with pkgsrc.
7525: For example, a package may need GNU awk, bison (instead of
7526: yacc) or a better sed.</p>
7527: <p>The tools used by a package can be listed by running
1.10 hubertf 7528: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7529: <div class="sect1">
1.1 dsieger 7530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7531: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7532: <p>The default set of tools used by pkgsrc is defined in
7533: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7534: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7535: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7536: These can be seen by running:
1.10 hubertf 7537: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7538: <p>If a package needs a specific program to build
7539: then the <code class="varname">USE_TOOLS</code> variable can be used
7540: to define the tools needed.</p>
7541: </div>
1.41 asau 7542: <div class="sect1">
1.1 dsieger 7543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7544: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7545: <p>In the following examples, the :run means that it is needed at
7546: run-time (and becomes a DEPENDS).
1.1 dsieger 7547: The default is a build dependency which can be set with
7548: :build. (So in this example, it is the same as gmake:build
7549: and pkg-config:build.)</p>
7550: <pre class="programlisting">
7551: USE_TOOLS+= gmake perl:run pkg-config
7552: </pre>
7553: <p>When using the tools framework, a
7554: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7555: which contains the full path to the appropriate tool. For example,
1.23 wiz 7556: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7557: on Linux systems.</p>
7558: <p>If you always need a pkgsrc version of the
7559: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7560: </p>
7561: </div>
1.41 asau 7562: <div class="sect1">
1.1 dsieger 7563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7564: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7565: <p>When improving or porting pkgsrc to a new platform, have a look
7566: at (or create) the corresponding platform specific make file fragment under
7567: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7568: the name of the common tools. For example:</p>
7569: <pre class="programlisting">
7570: .if exists(/usr/bin/bzcat)
7571: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7572: .elif exists(/usr/bin/bzip2)
7573: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7574: .endif
7575:
7576: TOOLS_PLATFORM.true?= true # shell builtin
7577: </pre>
7578: </div>
1.41 asau 7579: <div class="sect1">
1.1 dsieger 7580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7581: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41 asau 7582: <div class="qandaset">
1.43 ! asau 7583: <a name="idm10021824"></a><dl>
1.6 rillig 7584: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7585: </dt>
1.6 rillig 7586: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7587: tools?</a>
7588: </dt>
1.6 rillig 7589: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7590: package is using while being built? I want to know whether it
7591: uses sed or not.</a>
7592: </dt>
7593: </dl>
1.41 asau 7594: <table border="0" style="width: 100%;">
7595: <colgroup>
1.1 dsieger 7596: <col align="left" width="1%">
1.23 wiz 7597: <col>
1.41 asau 7598: </colgroup>
1.1 dsieger 7599: <tbody>
1.41 asau 7600: <tr class="question">
1.1 dsieger 7601: <td align="left" valign="top">
1.43 ! asau 7602: <a name="tools.new"></a><a name="idm10021632"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7603: </td>
7604: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7605: </tr>
7606: <tr class="answer">
7607: <td align="left" valign="top"></td>
7608: <td align="left" valign="top"><p>TODO</p></td>
7609: </tr>
1.41 asau 7610: <tr class="question">
1.1 dsieger 7611: <td align="left" valign="top">
1.43 ! asau 7612: <a name="tools.listall"></a><a name="idm10021120"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7613: </td>
7614: <td align="left" valign="top"><p>How do I get a list of all available
7615: tools?</p></td>
7616: </tr>
7617: <tr class="answer">
7618: <td align="left" valign="top"></td>
7619: <td align="left" valign="top"><p>TODO</p></td>
7620: </tr>
1.41 asau 7621: <tr class="question">
1.1 dsieger 7622: <td align="left" valign="top">
1.43 ! asau 7623: <a name="tools.used"></a><a name="idm10020608"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7624: </td>
7625: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7626: package is using while being built? I want to know whether it
7627: uses sed or not.</p></td>
7628: </tr>
7629: <tr class="answer">
7630: <td align="left" valign="top"></td>
7631: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7632: to do it.)</p></td>
7633: </tr>
7634: </tbody>
7635: </table>
7636: </div>
7637: </div>
7638: </div>
1.41 asau 7639: <div class="chapter">
1.1 dsieger 7640: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7641: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7642: <div class="toc">
7643: <p><b>Table of Contents</b></p>
7644: <dl>
1.6 rillig 7645: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7646: <dd><dl>
1.6 rillig 7647: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 7648: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
1.6 rillig 7649: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7650: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7651: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7652: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7653: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7654: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7655: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7656: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7657: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7658: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7659: </dl></dd>
1.23 wiz 7660: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 7661: <dd><dl>
7662: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7663: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
7664: </dl></dd>
1.23 wiz 7665: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6 rillig 7666: <dd><dl>
7667: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7668: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7669: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7670: </dl></dd>
7671: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7672: <dd><dl>
7673: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7674: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7675: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7676: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7677: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7678: </dl></dd>
1.23 wiz 7679: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6 rillig 7680: <dd><dl>
7681: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7682: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7683: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 7684: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7685: </dl></dd>
1.23 wiz 7686: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6 rillig 7687: <dd><dl>
7688: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7689: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7690: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7691: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7692: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7693: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7694: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7695: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7696: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7697: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7698: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7699: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7700: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7701: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7702: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7703: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7704: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7705: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7706: emulation</a></span></dt>
1.6 rillig 7707: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7708: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7709: </dl></dd>
1.6 rillig 7710: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7711: </dl>
7712: </div>
1.41 asau 7713: <div class="sect1">
1.1 dsieger 7714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7715: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41 asau 7716: <div class="sect2">
1.1 dsieger 7717: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7718: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7719: <p>One appealing feature of pkgsrc is that it runs on many
7720: different platforms. As a result, it is important to ensure,
7721: where possible, that packages in pkgsrc are portable. This
7722: chapter mentions some particular details you should pay
7723: attention to while working on pkgsrc.</p>
7724: </div>
1.41 asau 7725: <div class="sect2">
1.1 dsieger 7726: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7727: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7728: </h3></div></div></div>
7729: <p>The pkgsrc user can configure pkgsrc by overriding several
7730: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7731: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7732: want to use those variables in the preprocessor directives of
1.29 dholland 7733: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7734: <code class="literal">.for</code>), you need to include the file
7735: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7736: loads the user preferences.</p>
7737: <p>But note that some variables may not be completely defined
7738: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7739: included, as they may contain references to variables that are
7740: not yet defined. In shell commands this is no problem, since
7741: variables are actually macros, which are only expanded when they
7742: are used. But in the preprocessor directives mentioned above and
7743: in dependency lines (of the form <code class="literal">target:
7744: dependencies</code>) the variables are expanded at load
7745: time.</p>
1.41 asau 7746: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7747: <h3 class="title">Note</h3>
7748: <p>Currently there is no exhaustive list of all
7749: variables that tells you whether they can be used at load time
7750: or only at run time, but it is in preparation.</p>
7751: </div>
7752: </div>
1.41 asau 7753: <div class="sect2">
1.1 dsieger 7754: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7755: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7756: <p>Occasionally, packages require interaction from the user,
7757: and this can be in a number of ways:</p>
1.41 asau 7758: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7759: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7760: interaction such as entering username/password or accepting a
7761: license on a web page.</p></li>
1.23 wiz 7762: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7763: passwords.</p></li>
1.23 wiz 7764: <li class="listitem"><p>help to configure the package before it is built</p></li>
7765: <li class="listitem"><p>help during the build process</p></li>
7766: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7767: </ul></div>
7768: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7769: provided to notify the pkgsrc mechanism of an interactive stage
7770: which will be needed, and this should be set in the package's
7771: <code class="filename">Makefile</code>, e.g.:</p>
7772: <pre class="programlisting">
7773: INTERACTIVE_STAGE= build
7774: </pre>
7775: <p>Multiple interactive stages can be specified:</p>
7776: <pre class="programlisting">
7777: INTERACTIVE_STAGE= configure install
7778: </pre>
7779: <p>The user can then decide to skip this package by setting the
7780: <code class="varname">BATCH</code> variable.</p>
7781: </div>
1.41 asau 7782: <div class="sect2">
1.1 dsieger 7783: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7784: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7785: <p>Authors of software can choose the licence under which
7786: software can be copied. This is due to copyright law, and reasons
7787: for license choices are outside the scope of pkgsrc. The pkgsrc
7788: system recognizes that there are a number of licenses which some
7789: users may find objectionable or difficult or impossible to comply
7790: with. The Free Software Foundation has declared some licenses
7791: "Free", and the Open Source Initiative has a definition of "Open
7792: Source". The pkgsrc system, as a policy choice, does not label
7793: packages which have licenses that are Free or Open Source.
7794: However, packages without a license meeting either of those tests
7795: are labeled with a license tag denoting the license. Note that a
7796: package with no license to copy trivially does not meet either the
7797: Free or Open Source test.</p>
7798: <p>For packages which are not Free or Open Source, pkgsrc will
7799: not build the package unless the user has indicated to pkgsrc that
7800: packages with that particular license may be built. Note that
7801: this documentation avoids the term "accepted the license". The
7802: pkgsrc system is merely providing a mechanism to avoid
7803: accidentally building a package with a non-free license;
7804: judgement and responsibility remain with the user. (Installation
7805: of binary packages are not currently subject to this mechanism;
7806: this is a bug.)</p>
7807: <p>One might want to only install packages with a BSD license,
1.19 jnemeth 7808: or the GPL, and not the other. The free licenses are added to the
7809: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7810: user can override the default by setting the
7811: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7812: of "+=". The licenses accepted by default are:
7813: </p>
7814: <pre class="programlisting">
1.32 wiz 7815: public-domain unlicense
7816: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7817: gnu-gpl-v1
7818: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7819: gnu-gpl-v3 gnu-lgpl-v3
7820: original-bsd modified-bsd 2-clause-bsd
7821: x11 mit miros
7822: apache-1.1 apache-2.0
7823: artistic artistic-2.0
7824: cddl-1.0
7825: cpl-1.0
7826: open-font-license
7827: mpl-1.0 mpl-1.1 mpl-2.0
7828: php png-license
7829: postgresql-license
7830: zlib
7831: zpl
7832: python-software-foundation
7833: ipafont
7834: ibm-public-license-1.0
7835: isc
7836: boost-license
7837: mplusfont
7838: cc-by-sa-v3.0
7839: lppl-1.3c
7840: lucent
7841: epl-v1.0
7842: info-zip
1.19 jnemeth 7843: </pre>
7844: <p>
7845: </p>
1.1 dsieger 7846: <p>The license tag mechanism is intended to address
7847: copyright-related issues surrounding building, installing and
7848: using a package, and not to address redistribution issues (see
7849: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7850: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7851: Packages with redistribution restrictions should set these
7852: tags.</p>
1.1 dsieger 7853: <p>Denoting that a package may be copied according to a
7854: particular license is done by placing the license in
7855: <code class="filename">pkgsrc/licenses</code> and setting the
7856: <code class="varname">LICENSE</code> variable to a string identifying the
7857: license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
7858: <pre class="programlisting">
7859: LICENSE= xv-license
7860: </pre>
7861: <p>When trying to build, the user will get a notice that the
7862: package is covered by a license which has not been placed in the
7863: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7864: <pre class="programlisting">
7865: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7866: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7867: ===> To view the license, enter "/usr/bin/make show-license".
7868: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7869: ===> ACCEPTABLE_LICENSES+=xv-license
7870: *** Error code 1
7871: </pre>
1.10 hubertf 7872: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7873: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7874: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7875: convey to pkgsrc that it should not in the future fail because of
7876: that license:</p>
7877: <pre class="programlisting">
7878: ACCEPTABLE_LICENSES+=xv-license
7879: </pre>
7880: <p>When adding a package with a new license, the license text
7881: should be added to <code class="filename">pkgsrc/licenses</code> for
7882: displaying. A list of known licenses can be seen in this
7883: directory.</p>
7884: <p>When the license changes (in a way other than formatting),
7885: please make sure that the new license has a different name (e.g.,
7886: append the version number if it exists, or the date). Just
7887: because a user told pkgsrc to build programs under a previous
7888: version of a license does not mean that pkgsrc should build
7889: programs under the new licenses. The higher-level point is that
7890: pkgsrc does not evaluate licenses for reasonableness; the only
7891: test is a mechanistic test of whether a particular text has been
7892: approved by either of two bodies.</p>
7893: <p>The use of <code class="varname">LICENSE=shareware</code>,
7894: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7895: is deprecated because it does not crisply refer to a particular
7896: license text. Another problem with such usage is that it does not
7897: enable a user to tell pkgsrc to proceed for a single package
7898: without also telling pkgsrc to proceed for all packages with that
7899: tag.</p>
7900: </div>
1.41 asau 7901: <div class="sect2">
1.1 dsieger 7902: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7903: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7904: <p>Some licenses restrict how software may be re-distributed.
7905: Because a license tag is required unless the package is Free or
7906: Open Source, all packages with restrictions should have license
7907: tags. By declaring the restrictions, package tools can
7908: automatically refrain from e.g. placing binary packages on FTP
7909: sites.</p>
7910: <p>There are four restrictions that may be encoded, which are
7911: the cross product of sources (distfiles) and binaries not being
7912: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7913: language in any license, and because non-Free licenses tend to be
7914: different from each other, pkgsrc adopts a definition of FTP and
7915: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7916: should not be made available over the Internet at no charge.
7917: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7918: made available on some kind of media, together with other source
7919: and binary packages, and which is sold for a distribution charge.
7920: </p>
7921: <p>In order to encode these restrictions, the package system
7922: defines five make variables that can be set to note these
7923: restrictions:</p>
1.41 asau 7924: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7925: <li class="listitem">
1.1 dsieger 7926: <p><code class="varname">RESTRICTED</code></p>
7927: <p>This variable should be set whenever a restriction
7928: exists (regardless of its kind). Set this variable to a
7929: string containing the reason for the restriction. It should
7930: be understood that those wanting to understand the restriction
7931: will have to read the license, and perhaps seek advice of
7932: counsel.</p>
7933: </li>
1.23 wiz 7934: <li class="listitem">
1.1 dsieger 7935: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7936: <p>Binaries may not be placed on CD-ROM containing other
7937: binary packages, for which a distribution charge may be made.
7938: In this case, set this variable to
7939: <code class="varname">${RESTRICTED}</code>.</p>
7940: </li>
1.23 wiz 7941: <li class="listitem">
1.1 dsieger 7942: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7943: <p>Binaries may not made available on the Internet without
7944: charge. In this case, set this variable to
7945: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7946: binary packages will not be included on ftp.NetBSD.org.</p>
7947: </li>
1.23 wiz 7948: <li class="listitem">
1.1 dsieger 7949: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7950: <p>Distfiles may not be placed on CD-ROM, together with
7951: other distfiles, for which a fee may be charged. In this
7952: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7953: </p>
7954: </li>
1.23 wiz 7955: <li class="listitem">
1.1 dsieger 7956: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7957: <p>Distfiles may not made available via FTP at no charge.
7958: In this case, set this variable to
7959: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7960: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7961: </li>
7962: </ul></div>
1.32 wiz 7963: <p>Please note that packages will to be removed from pkgsrc
7964: when the distfiles are not distributable and cannot be obtained
7965: for a period of one full quarter branch. Packages with manual /
7966: interactive fetch must have a maintainer and it is his/her
7967: responsibility to ensure this.</p>
1.1 dsieger 7968: </div>
1.41 asau 7969: <div class="sect2">
1.1 dsieger 7970: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7971: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7972: <p>Your package may depend on some other package being present
7973: - and there are various ways of expressing this dependency.
7974: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7975: <code class="varname">DEPENDS</code> definitions, the
7976: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7977: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7978: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7979: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 7980: <p>The basic difference between the two variables is as
7981: follows: The <code class="varname">DEPENDS</code> definition registers
7982: that pre-requisite in the binary package so it will be pulled in
7983: when the binary package is later installed, whilst the
7984: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7985: dependency that is only needed for building the package.</p>
7986: <p>This means that if you only need a package present whilst
7987: you are building, it should be noted as a
7988: <code class="varname">BUILD_DEPENDS</code>.</p>
7989: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7990: <code class="varname">DEPENDS</code> definition is:</p>
7991: <pre class="programlisting">
7992: <pre-req-package-name>:../../<category>/<pre-req-package>
7993: </pre>
1.23 wiz 7994: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 7995: may include any of the wildcard version numbers recognized by
1.29 dholland 7996: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 7997: <div class="orderedlist"><ol class="orderedlist" type="1">
7998: <li class="listitem">
1.1 dsieger 7999: <p>If your package needs another package's binaries or
8000: libraries to build or run, and if that package has a
8001: <code class="filename">buildlink3.mk</code> file available, use it:</p>
8002: <pre class="programlisting">
8003: .include "../../graphics/jpeg/buildlink3.mk"
8004: </pre>
8005: </li>
1.23 wiz 8006: <li class="listitem">
1.25 spz 8007: <p>If your package needs binaries from another package to build,
8008: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 8009: <pre class="programlisting">
1.25 spz 8010: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 8011: </pre>
8012: </li>
1.25 spz 8013: <li class="listitem"><p>If your package needs a library with which to link and
8014: there is no <code class="filename">buildlink3.mk</code> file
8015: available, create one. Using
8016: <code class="varname">DEPENDS</code> won't be sufficient because the
8017: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 8018: <li class="listitem">
1.25 spz 8019: <p>If your package needs some executable to be able to run
8020: correctly and if there's no
8021: <code class="filename">buildlink3.mk</code> file, this is specified
8022: using the <code class="varname">DEPENDS</code> variable. The
8023: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
8024: be able to execute the latex binary from the teTeX package
8025: when it runs, and that is specified:</p>
1.1 dsieger 8026: <pre class="programlisting">
1.25 spz 8027: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 8028: </pre>
1.25 spz 8029: </li>
8030: <li class="listitem">
8031: <p>You can use wildcards in package dependencies. Note that
8032: such wildcard dependencies are retained when creating binary
8033: packages. The dependency is checked when installing the binary
8034: package and any package which matches the pattern will be
8035: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 8036: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
8037: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
8038: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
8039: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 8040: <p>Wildcards can also be used to specify that a package
8041: will only build against a certain minimum version of a
8042: pre-requisite:</p>
8043: <pre class="programlisting">
1.25 spz 8044: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 8045: </pre>
1.25 spz 8046: <p>This means that the package will build using version 6.0
8047: of ImageMagick or newer. Such a dependency may be warranted
8048: if, for example, the command line options of an executable
8049: have changed.</p>
8050: <p>If you need to depend on minimum versions of libraries,
8051: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 8052: <p>For security fixes, please update the package
1.10 hubertf 8053: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, “Handling packages with security problems”</a> for more
1.1 dsieger 8054: information.</p>
8055: </li>
8056: </ol></div>
8057: <p>If your package needs files from another package to build,
8058: add the relevant distribution files to
8059: <code class="varname">DISTFILES</code>, so they will be extracted
8060: automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
8061: (It relies on the jpeg sources being present in source form
8062: during the build.)</p>
8063: </div>
1.41 asau 8064: <div class="sect2">
1.1 dsieger 8065: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8066: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 8067: <p>Your package may conflict with other packages a user might
8068: already have installed on his system, e.g. if your package
8069: installs the same set of files as another package in the pkgsrc
8070: tree.</p>
8071: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8072: space-separated list of packages (including version string) your
8073: package conflicts with.</p>
8074: <p>For example, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw3d/README.html" target="_top"><code class="filename">x11/Xaw3d</code></a>
8075: and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
8076: install the same shared library, thus you set in
8077: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8078: <pre class="programlisting">
8079: CONFLICTS= Xaw-Xpm-[0-9]*
8080: </pre>
8081: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8082: <pre class="programlisting">
8083: CONFLICTS= Xaw3d-[0-9]*
8084: </pre>
8085: <p>Packages will automatically conflict with other packages
8086: with the name prefix and a different version
1.23 wiz 8087: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
8088: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.1 dsieger 8089: </div>
1.41 asau 8090: <div class="sect2">
1.1 dsieger 8091: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8092: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 8093: <p>There are several reasons why a package might be
8094: instructed to not build under certain circumstances. If the
8095: package builds and runs on most platforms, the exceptions
8096: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8097: the package builds and runs on a small handful of platforms,
8098: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8099: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8100: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8101: (OS-version-platform) that can use glob-style
8102: wildcards.</p>
8103: <p>Some packages are tightly bound to a specific version of an
8104: operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>. Such binary packages are not
8105: backwards compatible with other versions of the OS, and should be
8106: uploaded to a version specific directory on the FTP server. Mark
8107: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 8108: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 8109: the package system internals, but may be used in the
8110: future.</p>
8111: <p>If the package should be skipped (for example, because it
8112: provides functionality already provided by the system), set
8113: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8114: the package should fail because some preconditions are not met,
8115: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8116: message.</p>
8117: </div>
1.41 asau 8118: <div class="sect2">
1.1 dsieger 8119: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8120: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 8121: <p>To ensure that a package may not be deleted, once it has been
8122: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8123: be set in the package Makefile. This will be carried into any
8124: binary package that is made from this pkgsrc entry. A
1.23 wiz 8125: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.29 dholland 8126: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 8127: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 8128: </div>
1.41 asau 8129: <div class="sect2">
1.1 dsieger 8130: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8131: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8132: <p>When a vulnerability is found, this should be noted in
8133: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 8134: and after committing that file, ask pkgsrc-security@NetBSD.org to
8135: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 8136: <p>After fixing the vulnerability by a patch, its
1.31 wiz 8137: <code class="varname">PKGREVISION</code> should be increased (this is of
8138: course not necessary if the problem is fixed by using a newer
8139: release of the software), and the pattern in the
8140: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 8141: <p>Also, if the fix should be applied to the stable pkgsrc
8142: branch, be sure to submit a pullup request!</p>
8143: <p>Binary packages already on ftp.NetBSD.org will be handled
8144: semi-automatically by a weekly cron job.</p>
8145: </div>
1.41 asau 8146: <div class="sect2">
1.1 dsieger 8147: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8148: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 8149: <p>When making fixes to an existing package it can be useful
8150: to change the version number in <code class="varname">PKGNAME</code>. To
8151: avoid conflicting with future versions by the original author, a
1.23 wiz 8152: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 8153: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 8154: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8155: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 8156: <pre class="programlisting">
8157: DISTNAME= foo-17.42
8158: PKGREVISION= 9
8159: </pre>
8160: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 8161: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8162: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 8163: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8164: <code class="varname">PKGNAME_NOREV</code>.</p>
8165: <p>When a new release of the package is released, the
8166: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8167: minor release of the above package, things should be like:</p>
8168: <pre class="programlisting">
8169: DISTNAME= foo-17.43
8170: </pre>
8171: <p><code class="varname">PKGREVISION</code> should be incremented for any
8172: non-trivial change in the resulting binary package. Without a
8173: <code class="varname">PKGREVISION</code> bump, someone with the previous
8174: version installed has no way of knowing that their package is out
8175: of date. Thus, changes without increasing
8176: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8177: trivial that no reasonable person would want to upgrade", and this
8178: is the rough test for when increasing
8179: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8180: changes that do not merit increasing
8181: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8182: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8183: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 8184: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 8185: or comments in Makefile.</p></li>
1.23 wiz 8186: <li class="listitem"><p>
1.1 dsieger 8187: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 8188: <li class="listitem"><p>
1.1 dsieger 8189: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 8190: <li class="listitem"><p>
1.1 dsieger 8191: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8192: </ul></div>
8193: <p>Examples of changes that do merit an increase to
8194: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8196: <li class="listitem"><p>
1.1 dsieger 8197: Security fixes</p></li>
1.23 wiz 8198: <li class="listitem"><p>
1.1 dsieger 8199: Changes or additions to a patch file</p></li>
1.23 wiz 8200: <li class="listitem"><p>
1.1 dsieger 8201: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 8202: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 8203: </ul></div>
8204: <p>PKGREVISION must also be incremented when dependencies have ABI
8205: changes.</p>
8206: </div>
1.41 asau 8207: <div class="sect2">
1.1 dsieger 8208: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8209: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 8210: <p>When you want to replace the same text in multiple files
8211: or when the replacement text varies, patches alone cannot help.
8212: This is where the SUBST framework comes in. It provides an
8213: easy-to-use interface for replacing text in files.
8214: Example:</p>
8215: <pre class="programlisting">
8216: SUBST_CLASSES+= fix-paths
8217: SUBST_STAGE.fix-paths= pre-configure
8218: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8219: SUBST_FILES.fix-paths= src/*.c
8220: SUBST_FILES.fix-paths+= scripts/*.sh
8221: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8222: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8223: </pre>
8224: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8225: that are used to identify the different SUBST blocks that are
8226: defined. The SUBST framework is heavily used by pkgsrc, so it is
8227: important to always use the <code class="literal">+=</code> operator with
8228: this variable. Otherwise some substitutions may be
8229: skipped.</p>
8230: <p>The remaining variables of each SUBST block are
8231: parameterized with the identifier from the first line
8232: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8233: parameters to a function call.</p>
8234: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8235: which the replacement will take place. All combinations of
8236: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8237: <code class="literal">post-</code> together with a phase name are
8238: possible, though only few are actually used. Most commonly used
8239: are <code class="literal">post-patch</code> and
8240: <code class="literal">pre-configure</code>. Of these two,
8241: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8242: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8243: have the state after applying the patches but before making any
8244: other changes. This is especially useful when you are debugging
8245: a package in order to create new patches for it. Similarly,
8246: <code class="literal">post-build</code> is preferred over
8247: <code class="literal">pre-install</code>, because the install phase should
8248: generally be kept as simple as possible. When you use
8249: <code class="literal">post-build</code>, you have the same files in the
8250: working directory that will be installed later, so you can check
8251: if the substitution has succeeded.</p>
8252: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8253: that is printed just before the substitution is done.</p>
8254: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8255: globbing patterns that specifies the files in which the
8256: substitution will take place. The patterns are interpreted
8257: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8258: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29 dholland 8259: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 8260: command should be prefixed with <code class="literal">-e</code>, so that
8261: all SUBST blocks look uniform.</p>
8262: <p>There are some more variables, but they are so seldomly
8263: used that they are only documented in the
8264: <code class="filename">mk/subst.mk</code> file.</p>
8265: </div>
8266: </div>
1.41 asau 8267: <div class="sect1">
1.1 dsieger 8268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8269: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8270: <div class="sect2">
1.1 dsieger 8271: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8272: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8273: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8274: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8275: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8276: with the name of each file to download as an argument, expecting
8277: it to output the URL of the directory from which to download
8278: it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
8279: example of this usage.</p>
8280: <p>If the download can't be automated, because the user must
8281: submit personal information to apply for a password, or must pay
8282: for the source, or whatever, you can set
8283: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8284: displayed to the user before aborting the build. Example:</p>
8285: <pre class="programlisting">
8286: FETCH_MESSAGE= "Please download the files"
8287: FETCH_MESSAGE+= " "${DISTFILES:Q}
8288: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8289: </pre>
8290: </div>
1.41 asau 8291: <div class="sect2">
1.1 dsieger 8292: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8293: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8294: <p>Sometimes authors of a software package make some
8295: modifications after the software was released, and they put up a
8296: new distfile without changing the package's version number. If a
8297: package is already in pkgsrc at that time, the checksum will
8298: no longer match. The contents of the new distfile should be
8299: compared against the old one before changing anything, to make
8300: sure the distfile was really updated on purpose, and that
8301: no trojan horse or so crept in.
8302: Please mention that the distfiles were compared and what was found
8303: in your commit message.
8304: Then, the correct way to work around this is to
8305: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8306: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8307: <code class="varname">DISTFILES</code> and
8308: <code class="varname">PATCHFILES</code> for this package will be put in that
8309: subdirectory of the local distfiles directory.
1.10 hubertf 8310: (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
1.1 dsieger 8311: In case this
8312: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8313: including the <code class="filename">nbX</code> suffix) or a date stamp
8314: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8315: Do not forget regenerating the <code class="filename">distinfo</code> file
8316: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8317: path in the filenames.
8318: Also increase the PKGREVISION if the installed package is different.
8319: Furthermore, a mail to the package's authors seems appropriate
8320: telling them that changing distfiles after releases without
8321: changing the file names is not good practice.</p>
8322: </div>
8323: </div>
1.41 asau 8324: <div class="sect1">
1.1 dsieger 8325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8326: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8327: <div class="sect2">
1.1 dsieger 8328: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8329: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8330: <p>pkgsrc supports many different machines, with different
8331: object formats like a.out and ELF, and varying abilities to do
8332: shared library and dynamic loading at all. To accompany this,
8333: varying commands and options have to be passed to the
8334: compiler, linker, etc. to get the Right Thing, which can be
8335: pretty annoying especially if you don't have all the machines
8336: at your hand to test things. The
8337: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23 wiz 8338: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8339: both static and dynamic libraries from a set of source files,
8340: thus being platform-independent.</p>
8341: <p>Here's how to use libtool in a package in seven simple
8342: steps:</p>
1.23 wiz 8343: <div class="orderedlist"><ol class="orderedlist" type="1">
8344: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8345: Makefile.</p></li>
1.23 wiz 8346: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8347: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8348: add it to the definition of <code class="varname">CC</code>, if only
8349: libraries are being built in a given Makefile. This one command
8350: will build both PIC and non-PIC library objects, so you need not
8351: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8352: <li class="listitem">
1.1 dsieger 8353: <p>For the linking of the library, remove any
1.23 wiz 8354: <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
8355: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8356: <pre class="programlisting">
8357: ${LIBTOOL} --mode=link \
8358: ${CC} -o ${.TARGET:.a=.la} \
8359: ${OBJS:.o=.lo} \
8360: -rpath ${PREFIX}/lib \
8361: -version-info major:minor
8362: </pre>
8363: <p>Note that the library is changed to have a
8364: <code class="filename">.la</code> extension, and the objects are
8365: changed to have a <code class="filename">.lo</code>
8366: extension. Change <code class="varname">OBJS</code> as
8367: necessary. This automatically creates all of the
8368: <code class="filename">.a</code>,
8369: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8370: necessary) in the build directory. Be sure to include
1.23 wiz 8371: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8372: minor are zero, as libtool will otherwise strip off the
8373: shared library version.</p>
8374: <p>From the libtool manual:</p>
8375: <pre class="programlisting">
8376: So, libtool library versions are described by three integers:
8377:
8378: CURRENT
8379: The most recent interface number that this library implements.
8380:
8381: REVISION
8382: The implementation number of the CURRENT interface.
8383:
8384: AGE
8385: The difference between the newest and oldest interfaces that
8386: this library implements. In other words, the library implements
8387: all the interface numbers in the range from number `CURRENT -
8388: AGE' to `CURRENT'.
8389:
8390: If two libraries have identical CURRENT and AGE numbers, then the
8391: dynamic linker chooses the library with the greater REVISION number.
8392: </pre>
1.23 wiz 8393: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8394: different results for a.out and ELF (excluding symlinks)
8395: in only one case. An ELF library of the form
1.23 wiz 8396: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8397: will have a symlink of
1.23 wiz 8398: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8399: on an a.out platform. This is handled
8400: automatically.</p>
1.23 wiz 8401: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8402: directory of the library being built.</p>
8403: <p>In the <code class="filename">PLIST</code>, include only the
8404: <code class="filename">.la</code> file, the other files will be
8405: added automatically.</p>
8406: </li>
1.23 wiz 8407: <li class="listitem">
1.1 dsieger 8408: <p>When linking shared object (<code class="filename">.so</code>)
1.29 dholland 8409: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8410: shared libraries, use <span class="quote">“<span class="quote">-module
8411: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8412: tacked on.</p>
8413: <p>The <code class="filename">PLIST</code> file gets the
8414: <code class="filename">foo.so</code> entry.</p>
8415: </li>
1.23 wiz 8416: <li class="listitem">
1.1 dsieger 8417: <p>When linking programs that depend on these libraries
8418: <span class="emphasis"><em>before</em></span> they are installed, preface
1.29 dholland 8419: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><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+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8420: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8421: libraries (static or shared), but please be aware that
8422: libtool will not allow you to specify a relative path in
1.23 wiz 8423: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8424: expects you to change that argument to be the
8425: <code class="filename">.la</code> file. e.g.</p>
8426: <pre class="programlisting">
8427: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8428: </pre>
8429: <p>should be changed to:</p>
8430: <pre class="programlisting">
8431: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8432: </pre>
8433: <p>and it will do the right thing with the libraries.</p>
8434: </li>
1.23 wiz 8435: <li class="listitem">
1.29 dholland 8436: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8437: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8438: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8439: <code class="filename">.la</code>. e.g.</p>
8440: <pre class="programlisting">
1.22 jakllsch 8441: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8442: </pre>
8443: <p>This will install the static <code class="filename">.a</code>,
8444: shared library, any needed symlinks, and run
1.29 dholland 8445: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8446: </li>
1.23 wiz 8447: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8448: the <code class="filename">.la</code>
8449: file (this is a change from previous behaviour).</p></li>
8450: </ol></div>
8451: </div>
1.41 asau 8452: <div class="sect2">
1.1 dsieger 8453: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8454: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8455: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8456: package Makefile. This will override the package's own libtool
8457: in most cases. For older libtool using packages, libtool is
8458: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8459: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8460: configure; find work*/ -name libtool</strong></span>.</p>
8461: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8462: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8463: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8464: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8465: package's libtool script(s), set it as appropriate.</p>
8466: <p>If you do not need <code class="filename">*.a</code> static
8467: libraries built and installed, then use
8468: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8469: <p>If your package makes use of the platform-independent library
8470: for loading dynamic shared objects, that comes with libtool
8471: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8472: <p>Some packages use libtool incorrectly so that the package
8473: may not work or build in some circumstances. Some of the more
8474: common errors are:</p>
1.41 asau 8475: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8476: <li class="listitem">
1.1 dsieger 8477: <p>The inclusion of a shared object (-module) as a dependent library in an
8478: executable or library. This in itself isn't a problem if one of two things
8479: has been done:</p>
1.23 wiz 8480: <div class="orderedlist"><ol class="orderedlist" type="1">
8481: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8482: <code class="filename">libfoo.la</code>, not
8483: <code class="filename">foo.la</code></p></li>
1.23 wiz 8484: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8485: </ol></div>
8486: </li>
1.23 wiz 8487: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8488: The function lt_dlinit() should be called and the macro
8489: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8490: executables.</p></li>
8491: </ul></div>
8492: </div>
1.41 asau 8493: <div class="sect2">
1.1 dsieger 8494: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8495: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8496: <p>If a package needs GNU autoconf or automake to be executed
8497: to regenerate the configure script and Makefile.in makefile
8498: templates, then they should be executed in a pre-configure
8499: target.</p>
8500: <p>For packages that need only autoconf:</p>
8501: <pre class="programlisting">
8502: AUTOCONF_REQD= 2.50 # if default version is not good enough
8503: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8504: ...
8505:
8506: pre-configure:
8507: cd ${WRKSRC} && autoconf
8508:
8509: ...
8510: </pre>
8511: <p>and for packages that need automake and autoconf:</p>
8512: <pre class="programlisting">
8513: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8514: USE_TOOLS+= automake # use "automake14" for automake-1.4
8515: ...
8516:
8517: pre-configure:
8518: set -e; cd ${WRKSRC}; \
8519: aclocal; autoheader; automake -a --foreign -i; autoconf
8520:
8521: ...
8522: </pre>
8523: <p>Packages which use GNU Automake will almost certainly
8524: require GNU Make.</p>
8525: <p>There are times when the configure process makes
8526: additional changes to the generated files, which then causes
8527: the build process to try to re-execute the automake sequence.
8528: This is prevented by touching various files in the configure
8529: stage. If this causes problems with your package you can set
8530: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8531: Makefile.</p>
8532: </div>
8533: </div>
1.41 asau 8534: <div class="sect1">
1.1 dsieger 8535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8536: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8537: <div class="sect2">
1.1 dsieger 8538: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8539: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8540: <p>Compilers for the C, C++, and Fortran languages comes with
8541: the NetBSD base system. By default, pkgsrc assumes that a package
8542: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8543: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8544: <p>To declare which language's compiler a package needs, set
8545: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8546: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8547: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8548: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8549: written in C++, usually need a C compiler for the configure
8550: phase.</p>
8551: </div>
1.41 asau 8552: <div class="sect2">
1.1 dsieger 8553: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8554: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8555: <p>If a program is written in Java, use the Java framework in
8556: pkgsrc. The package must include
8557: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8558: provides the following variables:</p>
1.41 asau 8559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8560: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8561: dependency on the JDK is added. If
1.23 wiz 8562: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8563: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8564: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8565: JDK.</p></li>
1.23 wiz 8566: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8567: a package needs a Java2 implementation. The supported values
1.23 wiz 8568: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8569: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8570: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8571: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8572: above. This variable is not set by default.</p></li>
1.24 wiz 8573: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8574: automatically set to the runtime location of the used Java
8575: implementation dependency. It may be used to set
8576: <code class="varname">JAVA_HOME</code> to a good value if the program
8577: needs this variable to be defined.
8578: </p></li>
1.1 dsieger 8579: </ul></div>
8580: </div>
1.41 asau 8581: <div class="sect2">
1.1 dsieger 8582: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8583: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8584: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8585: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8586: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8587: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8588: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8589: that you want adjusted. Every occurrence of
8590: <code class="filename">*/bin/perl</code> will be replaced with the full
8591: path to the perl executable.</p>
8592: <p>If a particular version of perl is needed, set the
8593: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8594: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8595: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.1 dsieger 8596: about handling perl modules.</p>
8597: </div>
1.41 asau 8598: <div class="sect2">
1.1 dsieger 8599: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8600: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8601: <p><code class="varname">REPLACE_SH</code>,
8602: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8603: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8604: hash bangs in files. Please use the appropriate one, prefering
8605: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
8606: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8607: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8608: </div>
1.41 asau 8609: <div class="sect2">
1.40 wiz 8610: <div class="titlepage"><div><div><h3 class="title">
8611: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8612: <p>Currently, there is no special handling for other languages
8613: in pkgsrc. If a compiler package provides a
8614: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8615: just add a (build) dependency on the appropriate compiler
8616: package.</p>
8617: </div>
8618: </div>
1.41 asau 8619: <div class="sect1">
1.1 dsieger 8620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8621: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8622: <p>The most common failures when building a package are that
8623: some platforms do not provide certain header files, functions or
8624: libraries, or they provide the functions in a library that the
8625: original package author didn't know. To work around this, you
8626: can rewrite the source code in most cases so that it does not
8627: use the missing functions or provides a replacement function.</p>
1.41 asau 8628: <div class="sect2">
1.1 dsieger 8629: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8630: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8631: <p>If a package already comes with a GNU configure script, the
8632: preferred way to fix the build failure is to change the
8633: configure script, not the code. In the other cases, you can
8634: utilize the C preprocessor, which defines certain macros
8635: depending on the operating system and hardware architecture it
8636: compiles for. These macros can be queried using for example
8637: <code class="varname">#if defined(__i386)</code>. Almost every operating
8638: system, hardware architecture and compiler has its own macro.
8639: For example, if the macros <code class="varname">__GNUC__</code>,
8640: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8641: are all defined, you know that you are using NetBSD on an i386
8642: compatible CPU, and your compiler is GCC.</p>
8643: <p>The list of the following macros for hardware and
8644: operating system depends on the compiler that is used. For
8645: example, if you want to conditionally compile code on Solaris,
8646: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8647: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8648: <div class="sect3">
1.1 dsieger 8649: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8650: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8651: <p>To distinguish between 4.4 BSD-derived systems and the
8652: rest of the world, you should use the following code.</p>
8653: <pre class="programlisting">
8654: #include <sys/param.h>
8655: #if (defined(BSD) && BSD >= 199306)
8656: /* BSD-specific code goes here */
8657: #else
8658: /* non-BSD-specific code goes here */
8659: #endif
8660: </pre>
8661: <p>If this distinction is not fine enough, you can also test
8662: for the following macros.</p>
8663: <pre class="programlisting">
8664: FreeBSD __FreeBSD__
8665: DragonFly __DragonFly__
8666: Interix __INTERIX
8667: IRIX __sgi (TODO: get a definite source for this)
8668: Linux linux, __linux, __linux__
8669: NetBSD __NetBSD__
8670: OpenBSD __OpenBSD__
8671: Solaris sun, __sun
8672: </pre>
8673: </div>
1.41 asau 8674: <div class="sect3">
1.1 dsieger 8675: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8676: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8677: <pre class="programlisting">
8678: i386 i386, __i386, __i386__
8679: MIPS __mips
8680: SPARC sparc, __sparc
8681: </pre>
8682: </div>
1.41 asau 8683: <div class="sect3">
1.1 dsieger 8684: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8685: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8686: <pre class="programlisting">
8687: GCC __GNUC__ (major version), __GNUC_MINOR__
8688: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8689: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8690: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8691: </pre>
8692: </div>
8693: </div>
1.41 asau 8694: <div class="sect2">
1.1 dsieger 8695: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8696: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8697: <p>Some source files trigger bugs in the compiler, based on
8698: combinations of compiler version and architecture and almost
8699: always relation to optimisation being enabled. Common symptoms
8700: are gcc internal errors or never finishing compiling a
8701: file.</p>
8702: <p>Typically, a workaround involves testing the
8703: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8704: optimisation for that combination of file,
8705: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8706: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8707: number of examples.</p>
8708: </div>
1.41 asau 8709: <div class="sect2">
1.1 dsieger 8710: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8711: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8712: </h3></div></div></div>
1.1 dsieger 8713: <p>This error message often means that a package did not
8714: link to a shared library it needs. The following functions are
8715: known to cause this error message over and over.</p>
8716: <div class="informaltable">
8717: <a name="undefined-reference-functions"></a><table border="1">
8718: <colgroup>
8719: <col>
8720: <col>
8721: <col>
8722: </colgroup>
8723: <thead><tr>
8724: <th>Function</th>
8725: <th>Library</th>
8726: <th>Affected platforms</th>
8727: </tr></thead>
8728: <tbody>
8729: <tr>
8730: <td>accept, bind, connect</td>
8731: <td>-lsocket</td>
8732: <td>Solaris</td>
8733: </tr>
8734: <tr>
8735: <td>crypt</td>
8736: <td>-lcrypt</td>
8737: <td>DragonFly, NetBSD</td>
8738: </tr>
8739: <tr>
8740: <td>dlopen, dlsym</td>
8741: <td>-ldl</td>
8742: <td>Linux</td>
8743: </tr>
8744: <tr>
8745: <td>gethost*</td>
8746: <td>-lnsl</td>
8747: <td>Solaris</td>
8748: </tr>
8749: <tr>
8750: <td>inet_aton</td>
8751: <td>-lresolv</td>
8752: <td>Solaris</td>
8753: </tr>
8754: <tr>
8755: <td>nanosleep, sem_*, timer_*</td>
8756: <td>-lrt</td>
8757: <td>Solaris</td>
8758: </tr>
8759: <tr>
8760: <td>openpty</td>
8761: <td>-lutil</td>
8762: <td>Linux</td>
8763: </tr>
8764: </tbody>
8765: </table>
8766: </div>
8767: <p>To fix these linker errors, it is often sufficient to say
8768: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8769: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8770: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8771: bmake</strong></span>.</p>
1.41 asau 8772: <div class="sect3">
1.1 dsieger 8773: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8774: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8775: <p>When you are using the SunPro compiler, there is another
8776: possibility. That compiler cannot handle the following code:</p>
8777: <pre class="programlisting">
8778: extern int extern_func(int);
8779:
8780: static inline int
8781: inline_func(int x)
8782: {
8783: return extern_func(x);
8784: }
8785:
8786: int main(void)
8787: {
8788: return 0;
8789: }
8790: </pre>
8791: <p>It generates the code for <code class="function">inline_func</code> even if
8792: that function is never used. This code then refers to
8793: <code class="function">extern_func</code>, which can usually not be resolved. To
8794: solve this problem you can try to tell the package to disable inlining
8795: of functions.</p>
8796: </div>
8797: </div>
1.41 asau 8798: <div class="sect2">
1.1 dsieger 8799: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8800: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8801: <p>Sometimes packages fail to build because the compiler runs
8802: into an operating system specific soft limit. With the
8803: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8804: to unlimit the resources. Currently, the allowed values are
1.23 wiz 8805: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.1 dsieger 8806: Setting this variable is similar to running the shell builtin
1.10 hubertf 8807: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8808: segment size or maximum stack size of a process, respectively, to
8809: their hard limits.</p>
8810: </div>
8811: </div>
1.41 asau 8812: <div class="sect1">
1.1 dsieger 8813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8814: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8815: <div class="sect2">
1.1 dsieger 8816: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8817: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8818: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8819: with some operating systems cannot create more than one
8820: directory at a time. As such, you should call
8821: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8822: <pre class="programlisting">
8823: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8824: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8825: </pre>
1.23 wiz 8826: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8827: dir2</code></span>”</span> to the
1.1 dsieger 8828: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8829: automatically do the right thing.</p>
8830: </div>
1.41 asau 8831: <div class="sect2">
1.1 dsieger 8832: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8833: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8834: <p>In general, documentation should be installed into
8835: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8836: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8837: includes the version number of the package).</p>
8838: <p>Many modern packages using GNU autoconf allow to set the
8839: directory where HTML documentation is installed with the
1.23 wiz 8840: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8841: is needed because otherwise the documentation ends up in
8842: <code class="filename">${PREFIX}/share/doc/html</code> or other
8843: places.</p>
8844: <p>An exception to the above is that library API documentation
8845: generated with the <a href="ftp://ftp.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
8846: browsers (devhelp) should be left at their default location, which
8847: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8848: documentation can be recognized from files ending in
8849: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8850: (It is also acceptable to install such files in
8851: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8852: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8853: <code class="filename">.devhelp*</code> file must be directly in that
8854: directory then, no additional subdirectory level is allowed in
8855: this case. This is usually achieved by using
1.23 wiz 8856: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 8857: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8858: though.)</p>
8859: </div>
1.41 asau 8860: <div class="sect2">
1.1 dsieger 8861: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8862: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8863: <p>Certain packages, most of them in the games category, install
8864: a score file that allows all users on the system to record their
8865: highscores. In order for this to work, the binaries need to be
8866: installed setgid and the score files owned by the appropriate
1.35 wiz 8867: group and/or owner (traditionally the "games" user/group). Set
8868: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 8869: following variables, documented in more detail in
8870: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 8871: behaviour: <code class="varname">GAMEDATAMODE</code>,
8872: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
8873: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14 jmcneill 8874: <p>A package should therefore never hard code file ownership or
1.1 dsieger 8875: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8876: <code class="varname">INSTALL_GAME_DATA</code> to set these
8877: correctly.</p>
8878: </div>
1.41 asau 8879: <div class="sect2">
1.1 dsieger 8880: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8881: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 8882: <p><code class="varname">DESTDIR</code> support means that a package
8883: installs into a staging directory, not the final location of the
8884: files. Then a binary package is created which can be used for
8885: installation as usual. There are two ways: Either the package must
1.23 wiz 8886: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
8887: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 8888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8889: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 8890: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
8891: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
8892: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
8893: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 8894: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8895: the inclusion.</p></li>
1.23 wiz 8896: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 8897: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 8898: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 8899: automatically. Many manual rules and pre/post-install often are
8900: incorrect; fix them.</p></li>
1.23 wiz 8901: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 8902: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 8903: <li class="listitem"><p>In general, packages should support
1.4 rillig 8904: <code class="varname">UNPRIVILEGED</code> to be able to use
8905: DESTDIR.</p></li>
8906: </ul></div>
8907: </div>
1.41 asau 8908: <div class="sect2">
1.4 rillig 8909: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8910: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8911: <p>Your package may also contain scripts with hardcoded paths to
8912: other interpreters besides (or as well as) perl. To correct the
8913: full pathname to the script interpreter, you need to set the
8914: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8915: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8916: <pre class="programlisting">
8917: REPLACE_INTERPRETER+= tcl
8918: REPLACE.tcl.old= .*/bin/tclsh
8919: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8920: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8921: # relative to ${WRKSRC}, just as in REPLACE_PERL
8922: </pre>
1.41 asau 8923: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 8924: <h3 class="title">Note</h3>
8925: <p>Before March 2006, these variables were called
8926: <code class="varname">_REPLACE.*</code> and
8927: <code class="varname">_REPLACE_FILES.*</code>.</p>
8928: </div>
8929: </div>
1.41 asau 8930: <div class="sect2">
1.1 dsieger 8931: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8932: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8933: <p>Makefiles of packages providing perl5 modules should include
8934: the Makefile fragment
8935: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8936: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8937: configuration for such modules as well as various hooks to tune
8938: this configuration. See comments in this file for
8939: details.</p>
8940: <p>Perl5 modules will install into different places depending
8941: on the version of perl used during the build process. To
8942: address this, pkgsrc will append lines to the
8943: <code class="filename">PLIST</code> corresponding to the files listed in
8944: the installed <code class="filename">.packlist</code> file generated by
8945: most perl5 modules. This is invoked by defining
8946: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8947: paths to packlist files, e.g.:</p>
8948: <pre class="programlisting">
8949: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8950: </pre>
8951: <p>The variables <code class="varname">PERL5_SITELIB</code>,
8952: <code class="varname">PERL5_SITEARCH</code>, and
8953: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8954: in which perl5 modules may be installed, and may be used by
8955: perl5 packages that don't have a packlist. These three
8956: variables are also substituted for in the
8957: <code class="filename">PLIST</code>.</p>
8958: </div>
1.41 asau 8959: <div class="sect2">
1.1 dsieger 8960: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8961: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8962: <p>Some packages install info files or use the
1.23 wiz 8963: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 8964: commands. <code class="varname">INFO_FILES</code> should be defined in
8965: the package Makefile so that <code class="filename">INSTALL</code> and
8966: <code class="filename">DEINSTALL</code> scripts will be generated to
8967: handle registration of the info files in the Info directory
1.23 wiz 8968: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 8969: files registration is either provided by the system, or by a
8970: special purpose package automatically added as dependency if
8971: needed.</p>
8972: <p><code class="varname">PKGINFODIR</code> is the directory under
8973: <code class="filename">${PREFIX}</code> where info files are primarily
8974: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 8975: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 8976: <p>The info files for the package should be listed in the
8977: package <code class="filename">PLIST</code>; however any split info files
8978: need not be listed.</p>
1.23 wiz 8979: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
8980: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 8981: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 8982: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 8983: should be noted with the <code class="varname">TEXINFO_REQD</code>
8984: variable in the package <code class="filename">Makefile</code>. By
8985: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8986: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8987: does not match the required minimum, a build dependency on the
8988: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
8989: be added automatically.</p>
8990: <p>The build and installation process of the software provided
8991: by the package should not use the
1.10 hubertf 8992: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8993: info files is the task of the package
8994: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8995: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8996: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8997: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8998: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8999: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9000: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9001: no effect except the logging of a message. The script overriding
1.10 hubertf 9002: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9003: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9004: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9005: </div>
1.41 asau 9006: <div class="sect2">
1.1 dsieger 9007: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9008: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9009: <p>All packages that install manual pages should install them
9010: into the same directory, so that there is one common place to look
9011: for them. In pkgsrc, this place is
9012: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9013: should be used in packages. The default for
9014: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9015: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9016: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9017: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9018: <h3 class="title">Note</h3>
9019: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9020: is far from complete.</p>
9021: </div>
9022: <p>The <code class="filename">PLIST</code> files can just use
9023: <code class="filename">man/</code> as the top level directory for the man
9024: page file entries, and the pkgsrc framework will convert as
9025: needed. In all other places, the correct
9026: <code class="varname">PKGMANDIR</code> must be used.</p>
9027: <p>Packages that are
9028: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9029: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9030: <code class="filename">./configure</code>
9031: --mandir switch to set where the man pages should be installed.
9032: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9033: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9034: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9035: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9036: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9037: Or if the <code class="filename">./configure</code> script uses
9038: a non-standard use of --mandir, you can set
9039: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 9040: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 9041: information on installation of compressed manual pages.</p>
9042: </div>
1.41 asau 9043: <div class="sect2">
1.1 dsieger 9044: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 9045: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 9046: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 9047: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 9048: you need to take some extra steps to make sure they get registered
9049: in the database:</p>
1.23 wiz 9050: <div class="orderedlist"><ol class="orderedlist" type="1">
9051: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 9052: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 9053: takes care of rebuilding the GConf database at installation and
1.1 dsieger 9054: deinstallation time, and tells the package where to install
1.7 rillig 9055: GConf data files using some standard configure arguments. It
1.1 dsieger 9056: also disallows any access to the database directly from the
9057: package.</p></li>
1.23 wiz 9058: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 9059: <code class="filename">.schemas</code> files under
9060: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9061: installed under <code class="filename">${PREFIX}/etc</code>, you will
9062: need to manually patch the package.</p></li>
1.23 wiz 9063: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 9064: directory, as they will be handled automatically. See
1.10 hubertf 9065: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.23 wiz 9066: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 9067: your <code class="filename">Makefile</code> with a list of all
9068: <code class="filename">.schemas</code> files installed by the package, if
9069: any. Names must not contain any directories in them.</p></li>
1.23 wiz 9070: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 9071: your <code class="filename">Makefile</code> with a
9072: list of all <code class="filename">.entries</code> files installed by the
9073: package, if any. Names must not contain any directories in
9074: them.</p></li>
9075: </ol></div>
9076: </div>
1.41 asau 9077: <div class="sect2">
1.1 dsieger 9078: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 9079: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 9080: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 9081: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 9082: get registered in the database:</p>
1.23 wiz 9083: <div class="orderedlist"><ol class="orderedlist" type="1">
9084: <li class="listitem"><p>Include
1.18 snj 9085: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9086: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 9087: takes care of rebuilding the scrollkeeper database at
9088: installation and deinstallation time, and disallows any access
9089: to it directly from the package.</p></li>
1.23 wiz 9090: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9091: <code class="filename">libdata/scrollkeeper</code> directory, as they
9092: will be handled automatically.</p></li>
1.23 wiz 9093: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 9094: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9095: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 9096: </ol></div>
9097: </div>
1.41 asau 9098: <div class="sect2">
1.1 dsieger 9099: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9100: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9101: <p>If a package installs font files, you will need to rebuild
9102: the fonts database in the directory where they get installed at
9103: installation and deinstallation time. This can be automatically
9104: done by using the pkginstall framework.</p>
9105: <p>You can list the directories where fonts are installed in the
9106: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9107: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9108: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 9109: Also make sure that the database file
9110: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9111: <p>Note that you should not create new directories for fonts;
9112: instead use the standard ones to avoid that the user needs to
9113: manually configure his X server to find them.</p>
9114: </div>
1.41 asau 9115: <div class="sect2">
1.1 dsieger 9116: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9117: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9118: <p>If a package installs GTK2 immodules or loaders, you need to
9119: take some extra steps to get them registered in the GTK2 database
9120: properly:</p>
1.23 wiz 9121: <div class="orderedlist"><ol class="orderedlist" type="1">
9122: <li class="listitem"><p>Include
1.1 dsieger 9123: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9124: <code class="filename">buildlink3.mk</code> file. This takes care of
9125: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 9126: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 9127: your package installs GTK2 immodules.</p></li>
1.23 wiz 9128: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 9129: GTK2 loaders.</p></li>
1.23 wiz 9130: <li class="listitem">
1.1 dsieger 9131: <p>Patch the package to not touch any of the GTK2
9132: databases directly. These are:</p>
1.41 asau 9133: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9134: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9135: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 9136: </ul></div>
9137: </li>
1.23 wiz 9138: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 9139: any entries under the <code class="filename">libdata/gtk-2.0</code>
9140: directory, as they will be handled automatically.</p></li>
9141: </ol></div>
9142: </div>
1.41 asau 9143: <div class="sect2">
1.1 dsieger 9144: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9145: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9146: <p>If a package installs SGML or XML data files that need to be
9147: registered in system-wide catalogs (like DTDs, sub-catalogs,
9148: etc.), you need to take some extra steps:</p>
1.23 wiz 9149: <div class="orderedlist"><ol class="orderedlist" type="1">
9150: <li class="listitem"><p>Include
1.1 dsieger 9151: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9152: your <code class="filename">Makefile</code>, which takes care of
9153: registering those files in system-wide catalogs at
9154: installation and deinstallation time.</p></li>
1.23 wiz 9155: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9156: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9157: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9158: any XML catalogs installed by the package.</p></li>
1.23 wiz 9159: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9160: to be added to the SGML catalog. These come in groups of
9161: three strings; see xmlcatmgr(1) for more information
9162: (specifically, arguments recognized by the 'add' action).
9163: Note that you will normally not use this variable.</p></li>
1.23 wiz 9164: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9165: to be added to the XML catalog. These come in groups of three
9166: strings; see xmlcatmgr(1) for more information (specifically,
9167: arguments recognized by the 'add' action). Note that you will
9168: normally not use this variable.</p></li>
9169: </ol></div>
9170: </div>
1.41 asau 9171: <div class="sect2">
1.1 dsieger 9172: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9173: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9174: <p>If a package provides extensions to the MIME database by
9175: installing <code class="filename">.xml</code> files inside
9176: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9177: need to take some extra steps to ensure that the database is kept
9178: consistent with respect to these new files:</p>
1.23 wiz 9179: <div class="orderedlist"><ol class="orderedlist" type="1">
9180: <li class="listitem"><p>Include
1.1 dsieger 9181: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9182: (avoid using the <code class="filename">buildlink3.mk</code> file from
9183: this same directory, which is reserved for inclusion from
9184: other <code class="filename">buildlink3.mk</code> files). It takes
9185: care of rebuilding the MIME database at installation and
9186: deinstallation time, and disallows any access to it directly
9187: from the package.</p></li>
1.23 wiz 9188: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9189: <code class="filename">share/mime</code> directory,
9190: <span class="emphasis"><em>except</em></span> for files saved under
9191: <code class="filename">share/mime/packages</code>. The former are
9192: handled automatically by
9193: the update-mime-database program, but the latter are
9194: package-dependent and must be removed by the package that
9195: installed them in the first place.</p></li>
1.23 wiz 9196: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9197: from the PLIST. They will be handled by the shared-mime-info
9198: package.</p></li>
9199: </ol></div>
9200: </div>
1.41 asau 9201: <div class="sect2">
1.1 dsieger 9202: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9203: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9204: <p>If a package uses intltool during its build, add
9205: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9206: which forces it to use the intltool package provided by pkgsrc,
9207: instead of the one bundled with the distribution file.</p>
9208: <p>This tracks intltool's build-time dependencies and uses the
9209: latest available version; this way, the package benefits of any
9210: bug fixes that may have appeared since it was released.</p>
9211: </div>
1.41 asau 9212: <div class="sect2">
1.1 dsieger 9213: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9214: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9215: <p>If a package contains a rc.d script, it won't be copied into
9216: the startup directory by default, but you can enable it, by adding
9217: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9218: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9219: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9220: it will automatically remove the scripts when the package is
9221: deinstalled.</p>
9222: </div>
1.41 asau 9223: <div class="sect2">
1.1 dsieger 9224: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9225: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9226: <p>If a package installs TeX packages into the texmf tree,
9227: the <code class="filename">ls-R</code> database of the tree needs to be
9228: updated.</p>
1.41 asau 9229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9230: <h3 class="title">Note</h3>
1.22 jakllsch 9231: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9232: packages should install files
1.22 jakllsch 9233: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9234: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9235: </div>
1.23 wiz 9236: <div class="orderedlist"><ol class="orderedlist" type="1">
9237: <li class="listitem"><p>Include
1.22 jakllsch 9238: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9239: takes care of rebuilding the <code class="filename">ls-R</code>
9240: database at installation and deinstallation time.</p></li>
1.23 wiz 9241: <li class="listitem">
1.1 dsieger 9242: <p>If your package installs files into a texmf
9243: tree other than the one
1.22 jakllsch 9244: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9245: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9246: trees that need database update.</p>
9247: <p>If your package also installs font map files that need
1.10 hubertf 9248: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9249: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9250: set <code class="varname">TEX_MAP_FILES</code> and/or
9251: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9252: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9253: be run automatically at installation/deinstallation to
9254: enable/disable font map files for TeX output
9255: drivers.</p>
9256: </li>
1.23 wiz 9257: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9258: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9259: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9260: </ol></div>
9261: </div>
1.41 asau 9262: <div class="sect2">
1.1 dsieger 9263: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9264: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9265: emulation</h3></div></div></div>
9266: <p>There are some packages that provide libraries and
9267: executables for running binaries from a one operating system
9268: on a different one (if the latter supports it). One example
9269: is running Linux binaries on NetBSD.</p>
9270: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
9271: helps in extracting and packaging Linux rpm packages.</p>
9272: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9273: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9274: if all libraries for each installed executable can be found by
9275: the dynamic linker. Since the standard dynamic linker is run,
9276: this fails for emulation packages, because the libraries used
9277: by the emulation are not in the standard directories.</p>
9278: </div>
1.41 asau 9279: <div class="sect2">
1.1 dsieger 9280: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9281: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9282: <p>If a package installs images under the
9283: <code class="filename">share/icons/hicolor</code> and/or updates the
9284: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9285: database, you need to take some extra steps to make sure that the
9286: shared theme directory is handled appropriately and that the cache
9287: database is rebuilt:</p>
1.23 wiz 9288: <div class="orderedlist"><ol class="orderedlist" type="1">
9289: <li class="listitem"><p>Include
1.1 dsieger 9290: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9291: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9292: entry that refers to the theme cache.</p></li>
1.23 wiz 9293: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9294: directories from the <code class="filename">share/icons/hicolor</code>
9295: hierarchy because they will be handled automatically.</p></li>
9296: </ol></div>
9297: <p>The best way to verify that the PLIST is correct with
9298: respect to the last two points is to regenerate it using
1.10 hubertf 9299: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9300: </div>
1.41 asau 9301: <div class="sect2">
1.1 dsieger 9302: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9303: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9304: <p>If a package installs <code class="filename">.desktop</code> files
9305: under <code class="filename">share/applications</code> and these include
9306: MIME information, you need to take extra steps to ensure that they
9307: are registered into the MIME database:</p>
1.23 wiz 9308: <div class="orderedlist"><ol class="orderedlist" type="1">
9309: <li class="listitem"><p>Include
1.1 dsieger 9310: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9311: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9312: <code class="filename">share/applications/mimeinfo.cache</code> file.
9313: It will be handled automatically.</p></li>
9314: </ol></div>
9315: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9316: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9317: print-PLIST</strong></span>.</p>
9318: </div>
9319: </div>
1.41 asau 9320: <div class="sect1">
1.1 dsieger 9321: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9322: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9323: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9324: immediately. In this case, one can plainly mark a package as broken. For
9325: this, one just sets the variable <code class="varname">BROKEN</code> to the
9326: reason why the package is broken (similar to the
9327: <code class="varname">RESTRICTED</code> variable). A user trying to build
9328: the package will immediately be shown this message, and the build
9329: will not be even tried.</p>
9330: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9331: intervals.</p>
9332: </div>
9333: </div>
1.41 asau 9334: <div class="chapter">
1.1 dsieger 9335: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9336: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9337: <p>To check out all the gotchas when building a package, here are
9338: the steps that I do in order to get a package working. Please note
9339: this is basically the same as what was explained in the previous
9340: sections, only with some debugging aids.</p>
1.41 asau 9341: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9342: <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>
9343: <li class="listitem">
1.1 dsieger 9344: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
9345: create a directory for a new package, change into it, then run
1.10 hubertf 9346: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9347: <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>
9348: <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>
9349: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9350: </li>
1.23 wiz 9351: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9352: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9353: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9354: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9355: configure step to the package's
9356: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9357: <li class="listitem">
1.1 dsieger 9358: <p>Make the package compile, doing multiple rounds of</p>
9359: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9360: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9361: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9362: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9363: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9364: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9365: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9366: <p>Doing this step as non-root user will ensure that no files
9367: are modified that shouldn't be, especially during the build
1.10 hubertf 9368: phase. <span class="command"><strong>mkpatches</strong></span>,
9369: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1 dsieger 9370: from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
9371: package.</p>
9372: </li>
1.23 wiz 9373: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9374: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9375: <li class="listitem">
1.1 dsieger 9376: <p>Generate a <code class="filename">PLIST</code>:</p>
9377: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9378: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9379: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9380: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9381: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9382: <p>You usually need to be <code class="username">root</code> to do
9383: this. Look if there are any files left:</p>
9384: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9385: <p>If this reveals any files that are missing in
9386: <code class="filename">PLIST</code>, add them.</p>
9387: </li>
1.23 wiz 9388: <li class="listitem">
1.1 dsieger 9389: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9390: package again and make a binary package:</p>
9391: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9392: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9393: </li>
1.23 wiz 9394: <li class="listitem">
1.1 dsieger 9395: <p>Delete the installed package:</p>
9396: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9397: </li>
1.23 wiz 9398: <li class="listitem">
1.10 hubertf 9399: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9400: command, which shouldn't find anything now:</p>
9401: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9402: </li>
1.23 wiz 9403: <li class="listitem">
1.1 dsieger 9404: <p>Reinstall the binary package:</p>
9405: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9406: </li>
1.23 wiz 9407: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9408: <li class="listitem">
1.10 hubertf 9409: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1 dsieger 9410: reports:</p>
9411: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9412: </li>
1.23 wiz 9413: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 9414: </ul></div>
9415: </div>
1.41 asau 9416: <div class="chapter">
1.1 dsieger 9417: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9418: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9419: <div class="toc">
9420: <p><b>Table of Contents</b></p>
9421: <dl>
1.6 rillig 9422: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9423: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9424: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 9425: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9426: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9427: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9428: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9429: </dl>
9430: </div>
1.41 asau 9431: <div class="sect1">
1.1 dsieger 9432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9433: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9434: <p>Our policy is that we accept binaries only from pkgsrc
9435: developers to guarantee that the packages don't contain any
9436: trojan horses etc. This is not to annoy anyone but rather to
9437: protect our users! You're still free to put up your home-made
9438: binary packages and tell the world where to get them. NetBSD
9439: developers doing bulk builds and wanting to upload them please
1.10 hubertf 9440: see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, “Uploading results of a bulk build”</a>.</p>
1.1 dsieger 9441: </div>
1.41 asau 9442: <div class="sect1">
1.1 dsieger 9443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9444: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9445: <p>First, check that your package is complete, compiles and
1.10 hubertf 9446: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.29 dholland 9447: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9448: archive that contains all files that make up the package.
9449: Finally, send this package to the pkgsrc bug tracking system,
1.29 dholland 9450: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9451: that, go to the web page
1.10 hubertf 9452: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 9453: which contains some instructions and a link to a form where you
9454: can submit packages. The
9455: <a href="ftp://ftp.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
9456: also available as a substitute for either of the above two tools.
9457: </p>
1.1 dsieger 9458: <p>In the form of the problem report, the category should be
1.23 wiz 9459: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9460: and version number, and the description field should contain a
9461: short description of your package (contents of the COMMENT
9462: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9463: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9464: <p>If you want to submit several packages, please send a
9465: separate PR for each one, it's easier for us to track things
9466: that way.</p>
9467: <p>Alternatively, you can also import new packages into
1.23 wiz 9468: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.10 hubertf 9469: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9470: for details.</p>
9471: </div>
1.41 asau 9472: <div class="sect1">
1.1 dsieger 9473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9474: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9475: <p>Please note all package additions, updates, moves, and
9476: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9477: important to keep this file up to date and conforming to the
9478: existing format, because it will be used by scripts to
1.10 hubertf 9479: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9480: sites. Additionally, check the
9481: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9482: for the package you updated or removed, in case it was mentioned
9483: there.</p>
9484: <p>When the <code class="varname">PKGREVISION</code> of a package is
9485: bumped, the change should appear in
9486: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9487: related or otherwise relevant. Mass bumps that result from a
9488: dependency being updated should not be mentioned. In all other
9489: cases it's the developer's decision.</p>
9490: <p>There is a make target that helps in creating proper
1.10 hubertf 9491: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9492: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9493: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9494: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9495: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9496: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9497: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9498: For new packages, or package moves or removals, set the
9499: <code class="varname">CTYPE</code> variable on the command line to "Added",
9500: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9501: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9502: not the same as your NetBSD login name. The target also automatically
9503: removes possibly existing entries for the package in the
9504: <code class="filename">TODO</code> file. Don't forget to commit
9505: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
9506: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9507: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9508: makes the cvs commands use the main repository.
9509: </p>
1.1 dsieger 9510: </div>
1.41 asau 9511: <div class="sect1">
1.1 dsieger 9512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9513: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9514: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9515: access to the pkgsrc repository.</p>
9516: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9517: Start by adding the directory and then files in the directory. Don't
9518: forget to add the new package to the category's
9519: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9520: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9521: <pre class="programlisting">
9522: <code class="prompt">$</code> cd .../pkgsrc/category
9523: <code class="prompt">$</code> cvs add pkgname
9524: <code class="prompt">$</code> cd pkgname
9525: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9526: <code class="prompt">$</code> cvs add patches/p*
9527: <code class="prompt">$</code> cvs status | less
1.34 wiz 9528: <code class="prompt">$</code> cvs commit
1.33 wiz 9529: <code class="prompt">$</code> cd ..
9530: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9531: <code class="prompt">$</code> cvs commit Makefile
1.33 wiz 9532: </pre>
1.1 dsieger 9533: <p>The commit message of the initial import should include part of the
9534: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9535: what the package is/does.</p>
1.33 wiz 9536: <p>Also mention the new package in
9537: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9538: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9539: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9540: </div>
1.41 asau 9541: <div class="sect1">
1.1 dsieger 9542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9543: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9544: <p>Please always put a concise, appropriate and relevant summary of the
9545: changes between old and new versions into the commit log when updating
9546: a package. There are various reasons for this:</p>
1.41 asau 9547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9548: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9549: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9550: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9551: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9552: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9553: repository is very useful for people who read the pkgsrc-changes mailing
9554: list, so that they can make tactical decisions about when to upgrade
9555: the package.</p></li>
9556: </ul></div>
9557: <p>Please also recognize that, just because a new version of a package
9558: has been released, it should not automatically be upgraded in the CVS
9559: repository. We prefer to be conservative in the packages that are
9560: included in pkgsrc - development or beta packages are not really the
9561: best thing for most places in which pkgsrc is used. Please use your
9562: judgement about what should go into pkgsrc, and bear in mind that
9563: stability is to be preferred above new and possibly untested features.</p>
9564: </div>
1.41 asau 9565: <div class="sect1">
1.1 dsieger 9566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9567: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9568: <p>Renaming packages is not recommended.</p>
9569: <p>When renaming packages, be sure to fix any references to old name
9570: in other Makefiles, options, buildlink files, etc.</p>
9571: <p>Also When renaming a package, please define
9572: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9573: pattern(s) of the previous package name.
9574: This may be repeated for multiple renames.
9575: The new package would be an exact replacement.
9576: </p>
1.23 wiz 9577: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9578: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9579: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9580: not be an exact replacement but is a suggestion for the replaced
9581: functionality.</p>
9582: </div>
1.41 asau 9583: <div class="sect1">
1.20 snj 9584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9585: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9586: <p>It is preferred that packages are not renamed or moved, but if needed
9587: please follow these steps.
9588: </p>
1.23 wiz 9589: <div class="orderedlist"><ol class="orderedlist" type="1">
9590: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9591: <li class="listitem">
1.1 dsieger 9592: <p>Remove all CVS dirs.</p>
9593: <p>Alternatively to the first two steps you can also do:</p>
9594: <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>
9595: <p>and use that for further work.</p>
9596: </li>
1.23 wiz 9597: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9598: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9599: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9600: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9601: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9602: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9603: for doing an update using pkgsrc building; for example, it can
1.29 dholland 9604: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 9605: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9606: new <code class="varname">PKGPATH</code> for that moved package. Note that
9607: it may have multiple matches, so the tool should also check on the
9608: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9609: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9610: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9611: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9612: place.</p></li>
1.23 wiz 9613: <li class="listitem">
1.1 dsieger 9614: <p>Check if any package depends on it:
9615: </p>
9616: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9617: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9618: </li>
1.23 wiz 9619: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9620: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9621: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9622: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9623: <li class="listitem">
1.1 dsieger 9624: <p>Commit the changed and removed files:</p>
9625: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9626: <p>(and any packages from step 5, of course).</p>
9627: </li>
9628: </ol></div>
9629: </div>
9630: </div>
1.41 asau 9631: <div class="chapter">
1.1 dsieger 9632: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9633: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9634: <p>This section contains the answers to questions that may
9635: arise when you are writing a package. If you don't find your
9636: question answered here, first have a look in the other chapters,
9637: and if you still don't have the answer, ask on the
9638: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9639: <div class="qandaset">
1.43 ! asau 9640: <a name="idm11801472"></a><dl>
1.6 rillig 9641: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9642: MAKEFLAGS, .MAKEFLAGS and
9643: MAKE_FLAGS?</a>
9644: </dt>
1.6 rillig 9645: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9646: MAKE, GMAKE and
9647: MAKE_PROGRAM?</a>
9648: </dt>
1.6 rillig 9649: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9650: CC, PKG_CC and
9651: PKGSRC_COMPILER?</a>
9652: </dt>
1.6 rillig 9653: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9654: BUILDLINK_LDFLAGS,
9655: BUILDLINK_LDADD and
9656: BUILDLINK_LIBS?</a>
9657: </dt>
1.6 rillig 9658: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9659: VARNAME=BUILDLINK_PREFIX.foo
9660: say it's empty?</a>
9661: </dt>
1.6 rillig 9662: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9663: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9664: don't understand the := inside
9665: it.</a>
9666: </dt>
1.6 rillig 9667: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9668: developers?</a>
9669: </dt>
1.6 rillig 9670: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9671: documentation?</a>
9672: </dt>
1.6 rillig 9673: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9674: do?</a>
9675: </dt>
9676: </dl>
1.41 asau 9677: <table border="0" style="width: 100%;">
9678: <colgroup>
1.1 dsieger 9679: <col align="left" width="1%">
1.23 wiz 9680: <col>
1.41 asau 9681: </colgroup>
1.1 dsieger 9682: <tbody>
1.41 asau 9683: <tr class="question">
1.1 dsieger 9684: <td align="left" valign="top">
1.43 ! asau 9685: <a name="devfaq.makeflags"></a><a name="idm11801280"></a><p><b>22.1.</b></p>
1.1 dsieger 9686: </td>
9687: <td align="left" valign="top"><p>What is the difference between
9688: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9689: <code class="varname">MAKE_FLAGS</code>?</p></td>
9690: </tr>
9691: <tr class="answer">
9692: <td align="left" valign="top"></td>
9693: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29 dholland 9694: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9695: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9696: the <code class="varname">MAKE_PROGRAM</code> when building the
9697: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9698: </tr>
1.41 asau 9699: <tr class="question">
1.1 dsieger 9700: <td align="left" valign="top">
1.43 ! asau 9701: <a name="devfaq.make"></a><a name="idm11799104"></a><p><b>22.2.</b></p>
1.1 dsieger 9702: </td>
9703: <td align="left" valign="top"><p>What is the difference between
9704: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9705: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9706: </tr>
9707: <tr class="answer">
9708: <td align="left" valign="top"></td>
9709: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29 dholland 9710: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9711: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9712: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9713: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9714: Make program that is used for building the
9715: package.</p></td>
9716: </tr>
1.41 asau 9717: <tr class="question">
1.1 dsieger 9718: <td align="left" valign="top">
1.43 ! asau 9719: <a name="devfaq.cc"></a><a name="idm11796864"></a><p><b>22.3.</b></p>
1.1 dsieger 9720: </td>
9721: <td align="left" valign="top"><p>What is the difference between
9722: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9723: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9724: </tr>
9725: <tr class="answer">
9726: <td align="left" valign="top"></td>
9727: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9728: compiler, which can be configured by the pkgsrc user.
9729: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9730: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9731: path to a compiler, but the type of compiler that should be
9732: used. See <code class="filename">mk/compiler.mk</code> for more
9733: information about the latter variable.</p></td>
9734: </tr>
1.41 asau 9735: <tr class="question">
1.1 dsieger 9736: <td align="left" valign="top">
1.43 ! asau 9737: <a name="devfaq.bl3flags"></a><a name="idm11794688"></a><p><b>22.4.</b></p>
1.1 dsieger 9738: </td>
9739: <td align="left" valign="top"><p>What is the difference between
9740: <code class="varname">BUILDLINK_LDFLAGS</code>,
9741: <code class="varname">BUILDLINK_LDADD</code> and
9742: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9743: </tr>
9744: <tr class="answer">
9745: <td align="left" valign="top"></td>
9746: <td align="left" valign="top"><p>[FIXME]</p></td>
9747: </tr>
1.41 asau 9748: <tr class="question">
1.1 dsieger 9749: <td align="left" valign="top">
1.43 ! asau 9750: <a name="devfaq.bl3prefix"></a><a name="idm11793600"></a><p><b>22.5.</b></p>
1.1 dsieger 9751: </td>
1.10 hubertf 9752: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9753: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9754: say it's empty?</p></td>
9755: </tr>
9756: <tr class="answer">
9757: <td align="left" valign="top"></td>
9758: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9759: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9760: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9761: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9762: command.</p></td>
9763: </tr>
1.41 asau 9764: <tr class="question">
1.1 dsieger 9765: <td align="left" valign="top">
1.43 ! asau 9766: <a name="devfaq.master_sites"></a><a name="idm11792000"></a><p><b>22.6.</b></p>
1.1 dsieger 9767: </td>
9768: <td align="left" valign="top"><p>What does
9769: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9770: don't understand the <code class="literal">:=</code> inside
9771: it.</p></td>
9772: </tr>
9773: <tr class="answer">
9774: <td align="left" valign="top"></td>
9775: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9776: assignment operator, like you might expect at first sight.
9777: Instead, it is a degenerate form of
9778: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29 dholland 9779: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.1 dsieger 9780: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9781: case of <code class="varname">MASTER_SITE_*</code>,
9782: <em class="replaceable"><code>old_string</code></em> is the empty string and
9783: <em class="replaceable"><code>new_string</code></em> is
9784: <code class="literal">package/</code>. That's where the
9785: <code class="literal">:</code> and the <code class="literal">=</code> fall
9786: together.</p></td>
9787: </tr>
1.41 asau 9788: <tr class="question">
1.1 dsieger 9789: <td align="left" valign="top">
1.43 ! asau 9790: <a name="devfaq.mailinglists"></a><a name="idm11783936"></a><p><b>22.7.</b></p>
1.1 dsieger 9791: </td>
9792: <td align="left" valign="top"><p>Which mailing lists are there for package
9793: developers?</p></td>
9794: </tr>
9795: <tr class="answer">
9796: <td align="left" valign="top"></td>
1.41 asau 9797: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9798: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 9799: <dd><p>This is a list for technical discussions related
9800: to pkgsrc development, e.g. soliciting feedback for changes to
9801: pkgsrc infrastructure, proposed new features, questions related
9802: to porting pkgsrc to a new platform, advice for maintaining a
9803: package, patches that affect many packages, help requests moved
9804: from pkgsrc-users when an infrastructure bug is found,
9805: etc.</p></dd>
1.10 hubertf 9806: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 9807: <dd><p>All bug reports in category "pkg" sent with
1.29 dholland 9808: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 9809: directly; use one of the other mailing
9810: lists.</p></dd>
9811: </dl></div></td>
9812: </tr>
1.41 asau 9813: <tr class="question">
1.1 dsieger 9814: <td align="left" valign="top">
1.43 ! asau 9815: <a name="devfaq.documentation"></a><a name="idm11781888"></a><p><b>22.8.</b></p>
1.1 dsieger 9816: </td>
9817: <td align="left" valign="top"><p>Where is the pkgsrc
9818: documentation?</p></td>
9819: </tr>
9820: <tr class="answer">
9821: <td align="left" valign="top"></td>
9822: <td align="left" valign="top">
9823: <p>There are many places where you can find
9824: documentation about pkgsrc:</p>
1.41 asau 9825: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9826: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9827: of chapters that explain large parts of pkgsrc, but some
9828: chapters tend to be outdated. Which ones they are is hard to
9829: say.</p></li>
1.23 wiz 9830: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.1 dsieger 9831: about certain features, announcements of new parts of the pkgsrc
9832: infrastructure and sometimes even announcements that a certain
9833: feature has been marked as obsolete. The benefit here is that
9834: each message has a date appended to it.</p></li>
1.23 wiz 9835: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9836: <code class="filename">mk/</code> directory start with a comment that
9837: describes the purpose of the file and how it can be used by the
9838: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9839: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9840: help</strong></span>.</p></li>
1.23 wiz 9841: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 9842: information, but they tend to be highly abbreviated, especially
9843: for actions that occur often. Some contain a detailed
9844: description of what has changed, but they are geared towards the
9845: other pkgsrc developers, not towards an average pkgsrc user.
9846: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9847: don't know what has been before, these messages may not be worth
9848: too much to you.</p></li>
1.23 wiz 9849: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
9850: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 9851: mind of the developer who wrote the code. To get this
1.10 hubertf 9852: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9853: to see who has written it and ask on the
9854: <code class="literal">tech-pkg</code> mailing list, so that others can
9855: find your questions later (see above). To be sure that the
9856: developer in charge reads the mail, you may CC him or
9857: her.</p></li>
9858: </ul></div>
9859: </td>
9860: </tr>
1.41 asau 9861: <tr class="question">
1.1 dsieger 9862: <td align="left" valign="top">
1.43 ! asau 9863: <a name="devfaq.too-much-time"></a><a name="idm11778624"></a><p><b>22.9.</b></p>
1.1 dsieger 9864: </td>
9865: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9866: do?</p></td>
9867: </tr>
9868: <tr class="answer">
9869: <td align="left" valign="top"></td>
9870: <td align="left" valign="top">
9871: <p>This is not really an FAQ yet, but here's the answer
9872: anyway.</p>
1.41 asau 9873: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9874: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1 dsieger 9875: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package). It
9876: will tell you about newer versions of installed packages that are
9877: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 9878: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 9879: — it contains a list of suggested new packages and a list of
1.1 dsieger 9880: cleanups and enhancements for pkgsrc that would be nice to
9881: have.</p></li>
1.23 wiz 9882: <li class="listitem"><p>Review packages for which review was requested on
1.10 hubertf 9883: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1 dsieger 9884: mailing list.</p></li>
9885: </ul></div>
9886: </td>
9887: </tr>
9888: </tbody>
9889: </table>
9890: </div>
9891: </div>
1.41 asau 9892: <div class="chapter">
1.1 dsieger 9893: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9894: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9895: <div class="toc">
9896: <p><b>Table of Contents</b></p>
9897: <dl>
1.6 rillig 9898: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9899: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9900: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9901: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9902: </dl>
9903: </div>
1.10 hubertf 9904: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9905: site</a>:</p>
9906: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9907: environment, an intuitive and attractive desktop for users, and the
9908: GNOME development platform, an extensive framework for building
9909: applications that integrate into the rest of the desktop.</p></blockquote></div>
9910: <p>pkgsrc provides a seamless way to automatically build and install
9911: a complete GNOME environment <span class="emphasis"><em>under many different
9912: platforms</em></span>. We can say with confidence that pkgsrc is one of
9913: the most advanced build and packaging systems for GNOME due to its
9914: included technologies buildlink3, the wrappers and tools framework and
9915: automatic configuration file management. Lots of efforts are put into
9916: achieving a completely clean deinstallation of installed software
9917: components.</p>
1.10 hubertf 9918: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9919: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9920: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9921: pkgsrc as its preferred packaging system, contributing lots of
9922: portability fixes to make GNOME build and install under it.</p>
9923: <p>This chapter is aimed at pkgsrc developers and other people
9924: interested in helping our GNOME porting and packaging efforts. It
9925: provides instructions on how to manage the existing packages and some
9926: important information regarding their internals.</p>
1.41 asau 9927: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9928: <h3 class="title">We need your help!</h3>
9929: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9930: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9931: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9932: work</a> list! There is still a long way to go to get a
9933: fully-functional GNOME desktop under NetBSD and we need your help to
9934: achieve it!</p>
9935: </div>
1.41 asau 9936: <div class="sect1">
1.1 dsieger 9937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9938: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9939: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 9940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9941: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.1 dsieger 9942: the core GNOME desktop environment. It only includes the necessary
9943: bits to get it to boot correctly, although it may lack important
9944: functionality for daily operation. The idea behind this package is
9945: to let end users build their own configurations on top of this one,
9946: first installing this meta package to achieve a functional setup and
9947: then adding individual applications.</p></li>
1.23 wiz 9948: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.1 dsieger 9949: complete installation of the GNOME platform and desktop as defined
9950: by the GNOME project; this is based on the components distributed in
9951: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9952: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9953: official FTP server. Developer-only tools found in those
9954: directories are not installed unless required by some other
9955: component to work properly. Similarly, packages from the bindings
9956: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9957: in unless required as a dependency for an end-user component. This
9958: package "extends" <a href="ftp://ftp.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>
1.23 wiz 9959: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.1 dsieger 9960: Installs all the tools required to build a GNOME component when
9961: fetched from the CVS repository. These are required to let the
1.10 hubertf 9962: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9963: </ul></div>
9964: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9965: sorted in a way that eases updates: a package may depend on other
9966: packages listed before it but not on any listed after it. It is very
9967: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9968: change it to alphabetical sorting!</em></span></p>
9969: </div>
1.41 asau 9970: <div class="sect1">
1.1 dsieger 9971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9972: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9973: <p>Almost all GNOME applications are written in C and use a common
9974: set of tools as their build system. Things get different with the new
9975: bindings to other languages (such as Python), but the following will
9976: give you a general idea on the minimum required tools:</p>
1.41 asau 9977: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9978: <li class="listitem">
1.1 dsieger 9979: <p>Almost all GNOME applications use the GNU Autotools as their
9980: build system. As a general rule you will need to tell this to your
9981: package:</p>
9982: <pre class="programlisting">
9983: GNU_CONFIGURE=yes
9984: USE_LIBTOOL=yes
9985: USE_TOOLS+=gmake
9986: </pre>
9987: </li>
1.23 wiz 9988: <li class="listitem">
1.1 dsieger 9989: <p>If the package uses pkg-config to detect dependencies, add this
9990: tool to the list of required utilities:</p>
9991: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9992: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
9993: the end of the build process to ensure that you did not miss to
9994: specify any dependency in your package and that the version
9995: requirements are all correct.</p>
9996: </li>
1.23 wiz 9997: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 9998: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9999: to handle dependencies and to force the package to use the latest
10000: available version.</p></li>
1.23 wiz 10001: <li class="listitem">
1.1 dsieger 10002: <p>If the package uses gtk-doc (a documentation generation
10003: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
10004: tool is rather big and the distfile should come with pregenerated
10005: documentation anyway; if it does not, it is a bug that you ought to
10006: report. For such packages you should disable gtk-doc (unless it is
10007: the default):</p>
10008: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
10009: <p>The default location of installed HTML files
10010: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
10011: and should not be changed unless the package insists on installing
10012: them somewhere else. Otherwise programs as
1.10 hubertf 10013: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 10014: do that with an entry similar to:</p>
10015: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
10016: </li>
10017: </ul></div>
10018: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
10019: files under the installation prefix to maintain databases. In this
10020: context, shared means that those exact same directories and files are
10021: used among several different packages, leading to conflicts in the
10022: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
10023: handle the most common cases, so you have to forget about using
10024: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
10025: omitting shared files from them. If you find yourself doing those,
10026: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
10027: <p>The following table lists the common situations that result in
10028: using shared directories or files. For each of them, the appropriate
10029: solution is given. After applying the solution be sure to
10030: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 10031: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 10032: <div class="table">
1.6 rillig 10033: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 10034: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
10035: <colgroup>
10036: <col>
10037: <col>
10038: </colgroup>
10039: <thead><tr>
10040: <th>If the package...</th>
10041: <th>Then...</th>
10042: </tr></thead>
10043: <tbody>
10044: <tr>
10045: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 10046: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.1 dsieger 10047: </tr>
10048: <tr>
10049: <td>Installs icons under the
10050: <code class="filename">share/icons/hicolor</code> hierarchy or updates
10051: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 10052: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.1 dsieger 10053: </tr>
10054: <tr>
10055: <td>Installs files under
10056: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 10057: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.1 dsieger 10058: </tr>
10059: <tr>
10060: <td>Installs <code class="filename">.desktop</code> files under
10061: <code class="filename">share/applications</code> and these include MIME
10062: information.</td>
1.10 hubertf 10063: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 10064: </tr>
10065: </tbody>
10066: </table></div>
10067: </div>
10068: <br class="table-break">
10069: </div>
1.41 asau 10070: <div class="sect1">
1.1 dsieger 10071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10072: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 10073: <p>When seeing GNOME as a whole, there are two kinds of
10074: updates:</p>
1.41 asau 10075: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10076: <dt><span class="term">Major update</span></dt>
10077: <dd>
10078: <p>Given that there is still a very long way for GNOME 3 (if it
10079: ever appears), we consider a major update one that goes from a
10080: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10081: where <code class="literal">Y</code> is even and greater than
10082: <code class="literal">X</code>. These are hard to achieve because they
10083: introduce lots of changes in the components' code and almost all
10084: GNOME distfiles are updated to newer versions. Some of them can
10085: even break API and ABI compatibility with the previous major
10086: version series. As a result, the update needs to be done all at
10087: once to minimize breakage.</p>
10088: <p>A major update typically consists of around 80 package
10089: updates and the addition of some new ones.</p>
10090: </dd>
10091: <dt><span class="term">Minor update</span></dt>
10092: <dd>
10093: <p>We consider a minor update one that goes from a
10094: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10095: one where <code class="literal">Y</code> is greater than
10096: <code class="literal">X</code>. These are easy to achieve because they do
10097: not update all GNOME components, can be done in an incremental way
10098: and do not break API nor ABI compatibility.</p>
10099: <p>A minor update typically consists of around 50 package
10100: updates, although the numbers here may vary a lot.</p>
10101: </dd>
10102: </dl></div>
10103: <p>In order to update the GNOME components in pkgsrc to a new stable
10104: release (either major or minor), the following steps should be
10105: followed:</p>
1.23 wiz 10106: <div class="orderedlist"><ol class="orderedlist" type="1">
10107: <li class="listitem">
1.1 dsieger 10108: <p>Get a list of all the tarballs that form the new release by
10109: using the following commands. These will leave the full list of the
1.18 snj 10110: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 10111: file:</p>
10112: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10113: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10114: awk '{ print $9 }' >list.txt</code></strong>
10115: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10116: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10117: awk '{ print $9 }' >>list.txt</code></strong></pre>
10118: </li>
1.23 wiz 10119: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 10120: bump their version to the release you are updating them to. The
10121: three meta packages should be always consistent with versioning.
10122: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10123: in them.</p></li>
1.23 wiz 10124: <li class="listitem">
1.1 dsieger 10125: <p>For each meta package, update all its
10126: <code class="varname">DEPENDS</code> lines to match the latest versions as
10127: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10128: newer version (even if found in the FTP) because the meta packages
10129: are supposed to list the exact versions that form a specific GNOME
10130: release. Exceptions are permitted here if a newer version solves a
10131: serious issue in the overall desktop experience; these typically
10132: come in the form of a revision bump in pkgsrc, not in newer versions
10133: from the developers.</p>
10134: <p>Packages not listed in the <code class="filename">list.txt</code> file
10135: should be updated to the latest version available (if found in
10136: pkgsrc). This is the case, for example, of the dependencies on the
10137: GNU Autotools in the <a href="ftp://ftp.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>
10138: </li>
1.23 wiz 10139: <li class="listitem">
1.1 dsieger 10140: <p>Generate a patch from the modified meta packages and extract the
10141: list of "new" lines. This will provide you an outline on what
10142: packages need to be updated in pkgsrc and in what order:</p>
10143: <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>
10144: </li>
1.23 wiz 10145: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 10146: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 10147: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 10148: of <code class="filename">todo.txt</code> and update the packages listed in
10149: it in order. For major desktop updates none of these should be
10150: committed until the entire set is completed because there are chances
10151: of breaking not-yet-updated packages.</p></li>
1.23 wiz 10152: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 10153: the tree one by one with appropriate log messages. At the end,
10154: commit the three meta package updates and all the corresponding
10155: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10156: <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>
10157: </ol></div>
10158: </div>
1.41 asau 10159: <div class="sect1">
1.1 dsieger 10160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10161: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10162: <p>GNOME is a very big component in pkgsrc which approaches 100
10163: packages. Please, it is very important that you always, always,
10164: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 10165: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.1 dsieger 10166: their attention on portability issues and to ensure that future versions
10167: can be built out-of-the box on NetBSD. The less custom patches in
10168: pkgsrc, the easier further updates are. Those developers in charge of
10169: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 10170: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1 dsieger 10171: Bugzilla</a>. Not all components use these to track bugs, but most
10172: of them do. Do not be short on your reports: always provide detailed
10173: explanations of the current failure, how it can be improved to achieve
10174: maximum portability and, if at all possible, provide a patch against CVS
10175: head. The more verbose you are, the higher chances of your patch being
10176: accepted.</p>
10177: <p>Also, please avoid using preprocessor magic to fix portability
10178: issues. While the FreeBSD GNOME people are doing a great job in porting
10179: GNOME to their operating system, the official GNOME sources are now
10180: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10181: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 10182: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10183: details.</p>
10184: </div>
10185: </div>
10186: </div>
1.41 asau 10187: <div class="part">
1.1 dsieger 10188: <div class="titlepage"><div><div><h1 class="title">
10189: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10190: <div class="partintro">
1.1 dsieger 10191: <div></div>
10192: <p>This part of the guide deals with everything
10193: from the infrastructure that is behind the interfaces described
10194: in the developer's guide. A casual package maintainer should not
10195: need anything from this part.</p>
10196: <div class="toc">
10197: <p><b>Table of Contents</b></p>
10198: <dl>
1.6 rillig 10199: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10200: <dd><dl>
1.6 rillig 10201: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10202: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10203: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10204: <dd><dl>
1.6 rillig 10205: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10206: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10207: </dl></dd>
1.6 rillig 10208: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10209: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10210: <dd><dl>
1.6 rillig 10211: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10212: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10213: </dl></dd>
1.6 rillig 10214: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10215: <dd><dl>
1.23 wiz 10216: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10217: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10218: </dl></dd>
10219: </dl></dd>
1.6 rillig 10220: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10221: <dd><dl>
1.6 rillig 10222: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10223: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10224: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10225: <dd><dl>
1.6 rillig 10226: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10227: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10228: </dl></dd>
10229: </dl></dd>
1.6 rillig 10230: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10231: <dd><dl>
1.6 rillig 10232: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10233: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10234: </dl></dd>
10235: </dl>
10236: </div>
10237: </div>
1.41 asau 10238: <div class="chapter">
1.1 dsieger 10239: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10240: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10241: <div class="toc">
10242: <p><b>Table of Contents</b></p>
10243: <dl>
1.6 rillig 10244: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10245: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10246: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10247: <dd><dl>
1.6 rillig 10248: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10249: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10250: </dl></dd>
1.6 rillig 10251: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10252: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10253: <dd><dl>
1.6 rillig 10254: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10255: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10256: </dl></dd>
1.6 rillig 10257: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10258: <dd><dl>
1.23 wiz 10259: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10260: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10261: </dl></dd>
10262: </dl>
10263: </div>
10264: <p>The pkgsrc infrastructure consists of many small Makefile
10265: fragments. Each such fragment needs a properly specified
10266: interface. This chapter explains how such an interface looks
10267: like.</p>
1.41 asau 10268: <div class="sect1">
1.1 dsieger 10269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10270: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10271: <p>Whenever a variable is defined in the pkgsrc
10272: infrastructure, the location and the way of definition provide
10273: much information about the intended use of that variable.
10274: Additionally, more documentation may be found in a header
10275: comment or in this pkgsrc guide.</p>
10276: <p>A special file is
10277: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10278: variables that are intended to be user-defined. They are either
10279: defined using the <code class="literal">?=</code> operator or they are
10280: left undefined because defining them to anything would
1.23 wiz 10281: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10282: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10283: file.</p>
10284: <p>Outside this file, the following conventions apply:
10285: Variables that are defined using the <code class="literal">?=</code>
10286: operator may be overridden by a package.</p>
10287: <p>Variables that are defined using the <code class="literal">=</code>
10288: operator may be used read-only at run-time.</p>
10289: <p>Variables whose name starts with an underscore must not be
10290: accessed outside the pkgsrc infrastructure at all. They may
10291: change without further notice.</p>
1.41 asau 10292: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10293: <h3 class="title">Note</h3>
10294: <p>These conventions are currently not applied
10295: consistently to the complete pkgsrc
10296: infrastructure.</p>
10297: </div>
10298: </div>
1.41 asau 10299: <div class="sect1">
1.1 dsieger 10300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10301: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10302: <p>All variables that contain lists of things should default
10303: to being empty. Two examples that do not follow this rule are
10304: <code class="varname">USE_LANGUAGES</code> and
10305: <code class="varname">DISTFILES</code>. These variables cannot simply be
10306: modified using the <code class="literal">+=</code> operator in package
10307: <code class="filename">Makefile</code>s (or other files included by
10308: them), since there is no guarantee whether the variable is
10309: already set or not, and what its value is. In the case of
1.23 wiz 10310: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10311: the default value and just define it as in the following
10312: example.</p>
10313: <pre class="programlisting">
10314: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10315: </pre>
10316: <p>Because of the selection of this default value, the same
10317: value appears in many package Makefiles. Similarly for
10318: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10319: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10320: doesn't stand out. Nevertheless it is mentioned in many
10321: files.</p>
10322: </div>
1.41 asau 10323: <div class="sect1">
1.1 dsieger 10324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10325: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10326: <div class="sect2">
1.1 dsieger 10327: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10328: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10329: <p>Variable evaluation takes place either at load time or at
10330: runtime, depending on the context in which they occur. The
10331: contexts where variables are evaluated at load time are:</p>
1.41 asau 10332: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10333: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10334: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10335: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10336: <code class="literal">.for</code>,</p></li>
1.23 wiz 10337: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10338: </ul></div>
10339: <p>A special exception are references to the iteration
10340: variables of <code class="literal">.for</code> loops, which are expanded
10341: inline, no matter in which context they appear.</p>
10342: <p>As the values of variables may change during load time,
10343: care must be taken not to evaluate them by accident. Typical
10344: examples for variables that should not be evaluated at load time
10345: are <code class="varname">DEPENDS</code> and
10346: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10347: clear, here is an example:</p>
10348: <pre class="programlisting">
10349: CONFIGURE_ARGS= # none
10350: CFLAGS= -O
10351: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10352:
10353: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10354:
10355: CFLAGS+= -Wall
10356: </pre>
10357: <p>This code shows how the use of the <code class="literal">:=</code>
10358: operator can quickly lead to unexpected results. The first
10359: paragraph is fairly common code. The second paragraph evaluates
10360: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10361: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10362: <code class="literal">-Wall</code> is appended to the
10363: <code class="varname">CFLAGS</code>, but this addition will not appear in
10364: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10365: paragraphs from above typically occur in completely unrelated
10366: files.</p>
10367: </div>
1.41 asau 10368: <div class="sect2">
1.1 dsieger 10369: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10370: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10371: <p>After all the files have been loaded, the values of the
10372: variables cannot be changed anymore. Variables that are used in
10373: the shell commands are expanded at this point.</p>
10374: </div>
10375: </div>
1.41 asau 10376: <div class="sect1">
1.1 dsieger 10377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10378: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10379: <p>There are many ways in which the definition and use of a
10380: variable can be restricted in order to detect bugs and
10381: violations of the (mostly unwritten) policies. See the
10382: <code class="literal">pkglint</code> developer's documentation for further
10383: details.</p>
10384: </div>
1.41 asau 10385: <div class="sect1">
1.1 dsieger 10386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10387: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10388: <p>Most of the <code class="filename">.mk</code> files fall into one
10389: of the following classes. Cases where a file falls into more
10390: than one class should be avoided as it often leads to subtle
10391: bugs.</p>
1.41 asau 10392: <div class="sect2">
1.1 dsieger 10393: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10394: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10395: <p>In a traditional imperative programming language some of
10396: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10397: procedures. They take some input parameters and—after
10398: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10399: variables in <code class="filename">Makefile</code>s have global scope
10400: care must be taken not to use parameter names that have already
10401: another meaning. For example, <code class="varname">PKGNAME</code> is a
10402: bad choice for a parameter name.</p>
10403: <p>Procedures are completely evaluated at preprocessing time.
10404: That is, when calling a procedure all input parameters must be
10405: completely resolvable. For example,
10406: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10407: parameter since it is very likely that further text will be
10408: added after calling the procedure, which would effectively apply
10409: the procedure to only a part of the variable. Also, references
10410: to other variables wit will be modified after calling the
10411: procedure.</p>
10412: <p>A procedure can declare its output parameters either as
10413: suitable for use in preprocessing directives or as only
10414: available at runtime. The latter alternative is for variables
10415: that contain references to other runtime variables.</p>
10416: <p>Procedures shall be written such that it is possible to
10417: call the procedure more than once. That is, the file must not
10418: contain multiple-inclusion guards.</p>
10419: <p>Examples for procedures are
10420: <code class="filename">mk/bsd.options.mk</code> and
10421: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10422: that the parameters are evaluated at load time, they should be
10423: assigned using the <code class="literal">:=</code> operator, which should
10424: be used only for this purpose.</p>
10425: </div>
1.41 asau 10426: <div class="sect2">
1.1 dsieger 10427: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10428: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10429: <p>Action files take some input parameters and may define
10430: runtime variables. They shall not define loadtime variables.
10431: There are action files that are included implicitly by the
10432: pkgsrc infrastructure, while other must be included
10433: explicitly.</p>
10434: <p>An example for action files is
10435: <code class="filename">mk/subst.mk</code>.</p>
10436: </div>
10437: </div>
1.41 asau 10438: <div class="sect1">
1.1 dsieger 10439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10440: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10441: <p>Package <code class="filename">Makefile</code>s usually consist of
10442: a set of variable definitions, and include the file
10443: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10444: Before that, they may also include various other
10445: <code class="filename">*.mk</code> files if they need to query the
10446: availability of certain features like the type of compiler or
10447: the X11 implementation. Due to the heavy use of preprocessor
10448: directives like <code class="literal">.if</code> and
10449: <code class="literal">.for</code>, the order in which the files are loaded
10450: matters.</p>
10451: <p>This section describes at which point the various files
10452: are loaded and gives reasons for that order.</p>
1.41 asau 10453: <div class="sect2">
1.1 dsieger 10454: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10455: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10456: </h3></div></div></div>
10457: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10458: is to define some essential variables like
10459: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10460: <code class="varname">MACHINE_ARCH</code>.</p>
10461: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10462: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10463: After that, those variables
1.1 dsieger 10464: that have not been overridden by the user are loaded from
10465: <code class="filename">mk/defaults/mk.conf</code>.</p>
10466: <p>After the user settings, the system settings and platform
10467: settings are loaded, which may override the user
10468: settings.</p>
10469: <p>Then, the tool definitions are loaded. The tool wrappers
10470: are not yet in effect. This only happens when building a
10471: package, so the proper variables must be used instead of the
10472: direct tool names.</p>
10473: <p>As the last steps, some essential variables from the
10474: wrapper and the package system flavor are loaded, as well as the
10475: variables that have been cached in earlier phases of a package
10476: build.</p>
10477: </div>
1.41 asau 10478: <div class="sect2">
1.1 dsieger 10479: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10480: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10481: </h3></div></div></div>
10482: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10483: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10484: loaded, which fill default values for those variables that have
10485: not been defined by the package. These variables may later
10486: be used even in unrelated files.</p>
10487: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10488: provides the target <code class="literal">error-check</code> that is added
10489: as a special dependency to all other targets that use
10490: <code class="varname">DELAYED_ERROR_MSG</code> or
10491: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10492: <p>Then, the package-specific hacks from
10493: <code class="filename">hacks.mk</code> are included.</p>
10494: <p>Then, various other files follow. Most of them don't have
10495: any dependencies on what they need to have included before or
10496: after them, though some do.</p>
10497: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10498: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10499: restricts the use of these variables to all the files that have
10500: been included before. Appearances in later files will be
10501: silently ignored.</p>
10502: <p>Then, the files for the main targets are included, in the
10503: order of later execution, though the actual order should not
10504: matter.</p>
10505: <p>At last, some more files are included that don't set any
10506: interesting variables but rather just define make targets to be
10507: executed.</p>
10508: </div>
10509: </div>
10510: </div>
1.41 asau 10511: <div class="chapter">
1.1 dsieger 10512: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10513: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10514: <div class="toc">
10515: <p><b>Table of Contents</b></p>
10516: <dl>
1.6 rillig 10517: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10518: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10519: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10520: <dd><dl>
1.6 rillig 10521: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10522: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10523: </dl></dd>
10524: </dl>
10525: </div>
10526: <p>The pkgsrc infrastructure consists of a large codebase,
10527: and there are many corners where every little bit of a file is
10528: well thought out, making pkgsrc likely to fail as soon as
10529: anything is changed near those parts. To prevent most changes
10530: from breaking anything, a suite of regression tests should go
10531: along with every important part of the pkgsrc infrastructure.
10532: This chapter describes how regression tests work in pkgsrc and
10533: how you can add new tests.</p>
1.41 asau 10534: <div class="sect1">
1.1 dsieger 10535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10536: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10537: <p></p>
10538: </div>
1.41 asau 10539: <div class="sect1">
1.1 dsieger 10540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10541: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10542: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10 hubertf 10543: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10544: can simply run that command, which will run all tests in the
10545: <code class="filename">regress</code> category.</p>
10546: </div>
1.41 asau 10547: <div class="sect1">
1.1 dsieger 10548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10549: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10550: <p>Every directory in the <code class="filename">regress</code>
10551: category that contains a file called <code class="filename">spec</code>
10552: is considered a regression test. This file is a shell program
1.10 hubertf 10553: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10554: The following functions can be overridden to suit your
10555: needs.</p>
1.41 asau 10556: <div class="sect2">
1.1 dsieger 10557: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10558: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10559: <p>These functions do not take any parameters. They are all
1.23 wiz 10560: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.1 dsieger 10561: to check the exitcodes of any commands you run in the
10562: test.</p>
1.41 asau 10563: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10564: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10565: <dd><p>This function prepares the environment for the
10566: test. By default it does nothing.</p></dd>
10567: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10568: <dd><p>This function runs the actual test. By default,
10569: it calls <code class="varname">TEST_MAKE</code> with the arguments
10570: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10571: error messages into the file
10572: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10573: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10574: <dd><p>This function is run after the test and is
10575: typically used to compare the actual output from the one that is
10576: expected. It can make use of the various helper functions from
10577: the next section.</p></dd>
10578: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10579: <dd><p>This function cleans everything up after the
10580: test has been run. By default it does nothing.</p></dd>
10581: </dl></div>
10582: </div>
1.41 asau 10583: <div class="sect2">
1.1 dsieger 10584: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10585: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41 asau 10586: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10587: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10588: <dd><p>This function compares the exitcode of the
1.10 hubertf 10589: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10590: If they differ, the test will fail.</p></dd>
10591: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10592: <dd><p>This function checks for each of its parameters
1.10 hubertf 10593: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10594: extended regular expression. If it does not, the test will
10595: fail.</p></dd>
10596: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10597: <dd><p>This function checks for each of its parameters
1.10 hubertf 10598: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10599: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10600: If any of the regular expressions matches, the test will
10601: fail.</p></dd>
10602: </dl></div>
10603: </div>
10604: </div>
10605: </div>
1.41 asau 10606: <div class="chapter">
1.1 dsieger 10607: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10608: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10609: <div class="toc">
10610: <p><b>Table of Contents</b></p>
10611: <dl>
1.6 rillig 10612: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10613: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10614: </dl>
10615: </div>
10616: <p>The pkgsrc system has already been ported to many
10617: operating systems, hardware architectures and compilers. This
10618: chapter explains the necessary steps to make pkgsrc even more
10619: portable.</p>
1.41 asau 10620: <div class="sect1">
1.1 dsieger 10621: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10622: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10623: <p>To port pkgsrc to a new operating system (called
10624: <code class="literal">MyOS</code> in this example), you need to touch the
10625: following files:</p>
1.41 asau 10626: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10627: <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>
10628: <dd><p>This file contains some basic definitions, for
10629: example the name of the C
10630: compiler.</p></dd>
10631: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10632: <dd><p>Insert code that defines the variables
10633: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10634: <code class="varname">LOWER_OS_VERSION</code>,
10635: <code class="varname">LOWER_VENDOR</code>,
10636: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10637: <code class="varname">APPEND_ELF</code>, and the other variables that
10638: appear in this file.</p></dd>
10639: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10640: <dd><p>This file contains the platform-specific
10641: definitions that are used by pkgsrc. Start by copying one of the
10642: other files and edit it to your
10643: needs.</p></dd>
10644: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10645: <dd><p>This file contains a list of directories,
10646: together with their permission bits and ownership. These
10647: directories will be created automatically with every package
10648: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10649: be removed.</p></dd>
10650: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10651: <dd><p>Just copy one of the pre-existing x11.dist files
10652: to your
10653: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10654: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10655: <dd><p>On some operating systems, the tools that are
10656: provided with the base system are not good enough for pkgsrc.
1.29 dholland 10657: For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.1 dsieger 10658: narrow limit on the line length they can process. Therefore
10659: pkgsrc brings its own tools, which can be enabled
10660: here.</p></dd>
10661: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10662: <dd><p>This file defines the paths to all the tools
10663: that are needed by one or the other package in pkgsrc, as well
10664: as by pkgsrc itself. Find out where these tools are on your
10665: platform and add them.</p></dd>
10666: </dl></div>
10667: <p>Now, you should be able to build some basic packages, like
10668: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
10669: </div>
1.41 asau 10670: <div class="sect1">
1.1 dsieger 10671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10672: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10673: <p>TODO</p>
10674: </div>
10675: </div>
10676: </div>
1.41 asau 10677: <div class="appendix">
10678: <div class="titlepage"><div><div><h1 class="title">
10679: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10680: <div class="toc">
10681: <p><b>Table of Contents</b></p>
10682: <dl>
10683: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10684: <dd><dl>
10685: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10686: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10687: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10688: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1 dsieger 10689: </dl></dd>
10690: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10691: </dl>
10692: </div>
10693: <p>We checked to find a piece of software that wasn't in the packages
10694: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10695: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10696: present in the tree is beyond us, but it's useful for the purposes of
10697: this exercise.</p>
1.41 asau 10698: <div class="sect1">
1.1 dsieger 10699: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10700: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10701: <div class="sect2">
1.1 dsieger 10702: <div class="titlepage"><div><div><h3 class="title">
10703: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10704: <pre class="programlisting">
10705: # $NetBSD$
10706: #
10707:
10708: DISTNAME= bison-1.25
10709: CATEGORIES= devel
10710: MASTER_SITES= ${MASTER_SITE_GNU}
10711:
1.29 dholland 10712: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10713: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10714: COMMENT= GNU yacc clone
10715:
10716: GNU_CONFIGURE= yes
10717: INFO_FILES= bison.info
10718:
10719: .include "../../mk/bsd.pkg.mk"
10720: </pre>
10721: </div>
1.41 asau 10722: <div class="sect2">
1.1 dsieger 10723: <div class="titlepage"><div><div><h3 class="title">
10724: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10725: <pre class="programlisting">
10726: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.29 dholland 10727: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10728: of the NetBSD source tree is beyond me.
10729: </pre>
10730: </div>
1.41 asau 10731: <div class="sect2">
1.1 dsieger 10732: <div class="titlepage"><div><div><h3 class="title">
10733: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10734: <pre class="programlisting">
10735: @comment $NetBSD$
10736: bin/bison
10737: man/man1/bison.1.gz
10738: share/bison.simple
10739: share/bison.hairy
10740: </pre>
10741: </div>
1.41 asau 10742: <div class="sect2">
1.1 dsieger 10743: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10744: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10745: </h3></div></div></div>
10746: <p>The NetBSD package system comes with
10747: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10748: which helps to check the contents of these
10749: files. After installation it is quite easy to use, just change to the
10750: directory of the package you wish to examine and execute
1.10 hubertf 10751: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10752: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10753: looks fine.</pre>
10754: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10755: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10756: -Wall</strong></span> for a very thorough check.</p>
10757: </div>
10758: </div>
1.41 asau 10759: <div class="sect1">
1.1 dsieger 10760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10761: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10762: <p>Create the directory where the package lives,
10763: plus any auxiliary directories:</p>
10764: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10765: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10766: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10767: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10768: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10769: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1 dsieger 10770: then continue with fetching the distfile:</p>
10771: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10772: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10773: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10774: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10775: ftp: Error retrieving file: 500 Internal error
10776:
10777: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10778: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10779: ftp: Error retrieving file: 500 Internal error
10780:
10781: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10782: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10783: Successfully retrieved file.</pre>
10784: <p>Generate the checksum of the distfile into
10785: <code class="filename">distinfo</code>:</p>
10786: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10787: <p>Now compile:</p>
10788: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10789: >> Checksum OK for bison-1.25.tar.gz.
10790: ===> Extracting for bison-1.25
10791: ===> Patching for bison-1.25
10792: ===> Ignoring empty patch directory
10793: ===> Configuring for bison-1.25
10794: creating cache ./config.cache
10795: checking for gcc... cc
10796: checking whether we are using GNU C... yes
10797: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10798: checking how to run the C preprocessor... cc -E
10799: checking for minix/config.h... no
10800: checking for POSIXized ISC... no
10801: checking whether cross-compiling... no
10802: checking for ANSI C header files... yes
10803: checking for string.h... yes
10804: checking for stdlib.h... yes
10805: checking for memory.h... yes
10806: checking for working const... yes
10807: checking for working alloca.h... no
10808: checking for alloca... yes
10809: checking for strerror... yes
10810: updating cache ./config.cache
10811: creating ./config.status
10812: creating Makefile
10813: ===> Building for bison-1.25
10814: 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
10815: 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
10816: 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
10817: 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
10818: 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
10819: 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
10820: 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
10821: 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
10822: 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
10823: 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
10824: 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
10825: 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
10826: 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
10827: 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
10828: 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
10829: 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
10830: 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
10831: 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
10832: 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
10833: 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
10834: 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
10835: 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
10836: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10837: rm -f bison.s1
10838: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10839: <p>Everything seems OK, so install the files:</p>
10840: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10841: >> Checksum OK for bison-1.25.tar.gz.
10842: ===> Installing for bison-1.25
10843: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10844: rm -f /usr/pkg/bin/bison
10845: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10846: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10847: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10848: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10849: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10850: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10851: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10852: ===> Registering installation for bison-1.25</pre>
10853: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10854: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10855: binary package, do this now:</p>
10856: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10857: >> Checksum OK for bison-1.25.tar.gz.
10858: ===> Building package for bison-1.25
10859: Creating package bison-1.25.tgz
10860: Registering depends:.
10861: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10862: <p>Now that you don't need the source and object files
10863: any more, clean up:</p>
10864: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10865: ===> Cleaning for bison-1.25</pre>
10866: </div>
10867: </div>
1.41 asau 10868: <div class="appendix">
10869: <div class="titlepage"><div><div><h1 class="title">
10870: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 10871: <div class="toc">
10872: <p><b>Table of Contents</b></p>
10873: <dl>
10874: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10875: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10876: </dl>
10877: </div>
1.41 asau 10878: <div class="sect1">
1.1 dsieger 10879: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10880: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10881: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10882: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10883: => figlet221.tar.gz doesn't seem to exist on this system.
10884: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10885: => [172219 bytes]
10886: Connected to ftp.plig.net.
10887: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10888: 331 Guest login ok, send your complete e-mail address as password.
10889: 230-You are user #5 of 500 simultaneous users allowed.
10890: 230-
10891: 230- ___ _ _ _
10892: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10893: 230- | _| _| . |_| . | | | . |_| . | _| . |
10894: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10895: 230- |_| |_| |___| |___|
10896: 230-
10897: 230-** Welcome to ftp.plig.org **
10898: 230-
10899: 230-Please note that all transfers from this FTP site are logged. If you
10900: 230-do not like this, please disconnect now.
10901: 230-
1.18 snj 10902: 230-This archive is available via
1.1 dsieger 10903: 230-
10904: 230-HTTP: http://ftp.plig.org/
10905: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10906: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10907: 230-
10908: 230-Please email comments, bug reports and requests for packages to be
10909: 230-mirrored to ftp-admin@plig.org.
10910: 230-
10911: 230-
10912: 230 Logged in anonymously.
10913: Remote system type is UNIX.
10914: Using binary mode to transfer files.
10915: 200 Type okay.
10916: 250 "/pub" is new cwd.
10917: 250-"/pub/figlet" is new cwd.
10918: 250-
10919: 250-Welcome to the figlet archive at ftp.figlet.org
10920: 250-
10921: 250- ftp://ftp.figlet.org/pub/figlet/
10922: 250-
10923: 250-The official FIGlet web page is:
10924: 250- http://www.figlet.org/
10925: 250-
10926: 250-If you have questions, please mailto:info@figlet.org. If you want to
10927: 250-contribute a font or something else, you can email us.
10928: 250
10929: 250 "/pub/figlet/program" is new cwd.
10930: 250 "/pub/figlet/program/unix" is new cwd.
10931: local: figlet221.tar.gz remote: figlet221.tar.gz
10932: 502 Unimplemented command.
10933: 227 Entering Passive Mode (195,40,6,41,246,104)
10934: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10935: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10936: 226 Transfer completed.
10937: 172219 bytes received in 00:02 (75.99 KB/s)
10938: 221 Goodbye.
10939: => Checksum OK for figlet221.tar.gz.
10940: ===> Extracting for figlet-2.2.1nb2
10941: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10942: ===> Patching for figlet-2.2.1nb2
10943: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10944: ===> Overriding tools for figlet-2.2.1nb2
10945: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10946: ===> Configuring for figlet-2.2.1nb2
10947: ===> Building for figlet-2.2.1nb2
10948: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10949: chmod a+x figlet
10950: gcc -O2 -o chkfont chkfont.c
10951: => Unwrapping files-to-be-installed.
10952: <code class="prompt">#</code>
10953: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10954: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10955: ===> Installing for figlet-2.2.1nb2
10956: install -d -o root -g wheel -m 755 /usr/pkg/bin
10957: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10958: mkdir -p /usr/pkg/share/figlet
10959: cp figlet /usr/pkg/bin
10960: cp chkfont /usr/pkg/bin
10961: chmod 555 figlist showfigfonts
10962: cp figlist /usr/pkg/bin
10963: cp showfigfonts /usr/pkg/bin
10964: cp fonts/*.flf /usr/pkg/share/figlet
10965: cp fonts/*.flc /usr/pkg/share/figlet
10966: cp figlet.6 /usr/pkg/man/man6
10967: ===> Registering installation for figlet-2.2.1nb2
10968: <code class="prompt">#</code></pre>
10969: </div>
1.41 asau 10970: <div class="sect1">
1.1 dsieger 10971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10972: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10973: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10974: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10975: ===> Packaging figlet-2.2.1nb2
10976: ===> Building binary package for figlet-2.2.1nb2
10977: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10978: Using SrcDir value of /usr/pkg
10979: Registering depends:.
10980: <code class="prompt">#</code></pre>
10981: </div>
10982: </div>
1.41 asau 10983: <div class="appendix">
10984: <div class="titlepage"><div><div><h1 class="title">
10985: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 10986: <div class="toc">
10987: <p><b>Table of Contents</b></p>
10988: <dl>
1.23 wiz 10989: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10990: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10991: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10992: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10993: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10994: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 10995: source packages</a></span></dt>
10996: </dl>
10997: </div>
10998: <p>As in other big projects, the directory layout of pkgsrc
10999: is quite complex for newbies. This chapter explains where you
11000: find things on the FTP server. The base directory on
1.10 hubertf 11001: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1 dsieger 11002: On other servers it may be different, but inside this directory,
11003: everything should look the same, no matter on which server you
11004: are. This directory contains some subdirectories, which are
11005: explained below.</p>
1.41 asau 11006: <div class="sect1">
1.1 dsieger 11007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11008: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 11009: <p>The directory <code class="filename">distfiles</code> contains lots
11010: of archive files from all pkgsrc packages, which are mirrored
11011: here. The subdirectories are called after their package names
11012: and are used when the distributed files have names that don't
11013: explicitly contain a version number or are otherwise too generic
11014: (for example <code class="filename">release.tar.gz</code>).</p>
11015: </div>
1.41 asau 11016: <div class="sect1">
1.1 dsieger 11017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11018: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 11019: <p>This directory contains things that individual pkgsrc
11020: developers find worth publishing.</p>
11021: </div>
1.41 asau 11022: <div class="sect1">
1.1 dsieger 11023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11024: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 11025: <p>This directory contains binary packages for the various
11026: platforms that are supported by pkgsrc.
11027: Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.41 asau 11028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11029: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 11030: operating system for which the packages have been built. The
1.10 hubertf 11031: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 11032: command, so it may differ from the one you are used to
11033: hear.</p></li>
1.23 wiz 11034: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 11035: architecture of the platform for which the packages have been
1.10 hubertf 11036: built. It also includes the <code class="varname">ABI</code> (Application
11037: Binary Interface) for platforms that have several of
11038: them.</p></li>
1.23 wiz 11039: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 11040: the operating system. For version numbers that change often (for
11041: example NetBSD-current), the often-changing part should be
11042: replaced with an <code class="literal">x</code>, for example
11043: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 11044: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 11045: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 11046: for a stable branch, or <code class="literal">head</code> for packages
11047: built from the HEAD branch. The latter should only be used when
11048: the packages are updated on a regular basis. Otherwise the date
11049: from checking out pkgsrc should be appended, for example
11050: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 11051: </ul></div>
11052: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11053: can quickly click through the directories on the
11054: server and find the best binary packages for their machines. Since they
11055: usually know the operating system and the hardware architecture, OPSYS
11056: and ARCH are placed first. After these choices, they can select the
11057: best combination of OSVERSION and TAG together, since it is usually the
11058: case that packages stay compatible between different version of the
11059: operating system.</p>
11060: <p>In each of these directories, there is a
11061: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 11062: <code class="filename">All</code> which contains all binary packages.
11063: Besides that, there are various category directories that
11064: contain symbolic links to the real binary packages.</p>
11065: </div>
1.41 asau 11066: <div class="sect1">
1.1 dsieger 11067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11068: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11069: <p>Here are the reports from bulk builds, for those who want
11070: to fix packages that didn't build on some of the platforms. The
1.23 wiz 11071: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 11072: </div>
1.41 asau 11073: <div class="sect1">
1.8 rillig 11074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11075: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
11076: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11077: source packages</h2></div></div></div>
1.23 wiz 11078: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11079: that is the files that define how to create binary packages from
11080: source archives.</p>
11081: <p>The directory <code class="filename">pkgsrc</code> contains a
11082: snapshot of the CVS repository, which is updated regularly. The
11083: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11084: directory, ready to be downloaded as a whole.</p>
11085: <p>In the directories for the quarterly branches, there is an
11086: additional file called
1.22 jakllsch 11087: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1 dsieger 11088: which contains the state of pkgsrc when it was branched.</p>
11089: </div>
11090: </div>
1.41 asau 11091: <div class="appendix">
11092: <div class="titlepage"><div><div><h1 class="title">
11093: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 11094: <div class="toc">
11095: <p><b>Table of Contents</b></p>
11096: <dl>
11097: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11098: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11099: </dl>
11100: </div>
11101: <p>This section contains information on editing the pkgsrc
11102: guide itself.</p>
1.41 asau 11103: <div class="sect1">
1.1 dsieger 11104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11105: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11106: <p>The pkgsrc guide's source code is stored in
11107: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11108: are created from it:</p>
1.41 asau 11109: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11110: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11111: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11112: <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>
11113: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 11114: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 11115: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 11116: PostScript version of the pkgsrc guide.</p></li>
11117: </ul></div>
11118: </div>
1.41 asau 11119: <div class="sect1">
1.1 dsieger 11120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11121: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11122: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 11123: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 11124: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 11125: regenerate the pkgsrc guide (and other XML-based NetBSD
11126: documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
11127: ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
11128: PostScript and PDF versions. You will need both packages
11129: installed, to make sure documentation is consistent across all
11130: formats.</p></li>
1.41 asau 11131: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 11132: right directory. All further steps will take place
11133: here.</p></li>
1.41 asau 11134: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 11135: <code class="filename">files/</code>.</p></li>
1.41 asau 11136: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 11137: guide for valid XML and to build the final output files. If you
11138: get any errors at this stage, you can just edit the files, as
11139: there are only symbolic links in the working directory, pointing
11140: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 11141: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 11142: commit)</strong></span></p></li>
1.41 asau 11143: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 11144: regenerate the output files with the proper RCS
11145: Ids.</p></li>
1.41 asau 11146: <li class="step">
1.10 hubertf 11147: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 11148: commit the files in both <code class="filename">pkgsrc/doc</code> and
11149: <code class="filename">htdocs</code>.</p>
1.41 asau 11150: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 11151: <h3 class="title">Note</h3>
11152: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 11153: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11154: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 11155: directory.</p>
11156: </div>
11157: </li>
11158: </ol></div>
11159: </div>
11160: </div>
11161: </div></body>
11162: </html>
CVSweb <webmaster@jp.NetBSD.org>