Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.11
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.2 rillig 6: <link rel="stylesheet" href="/global.css" type="text/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>
10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
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.1 dsieger 35: <div><div class="abstract">
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>
68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
70: </dl></dd>
71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
72: <dd><dl>
73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
75: </dl></dd>
76: </dl></dd>
77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
78: <dd><dl>
79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
82: <dd><dl>
83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
90: </dl></dd>
91: </dl></dd>
92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
93: <dd><dl>
94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
95: <dd><dl>
96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
101: <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>
102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
104: </dl></dd>
105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
106: <dd><dl>
107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
110: </dl></dd>
111: </dl></dd>
112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
113: <dd><dl>
114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 118: <dd><dl>
1.4 rillig 119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
121: <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 122: </dl></dd>
1.4 rillig 123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 125: </dl></dd>
126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
127: <dd><dl>
128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
129: <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 130: </dl></dd>
131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
132: builds)</a></span></dt>
1.1 dsieger 133: <dd><dl>
1.6 rillig 134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
137: <dd><dl>
138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
146: </dl></dd>
147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
148: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
149: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
150: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
151: </dl></dd>
152: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
153: <dd><dl>
154: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
155: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
156: </dl></dd>
157: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
158: <dd><dl>
159: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
160: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
161: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
162: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
163: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
164: <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>
165: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.10 hubertf 166: <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 167: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
168: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 169: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 170: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
171: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
172: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
173: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
174: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
175: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
176: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.1 dsieger 177: </dl></dd>
178: </dl></dd>
179: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
180: <dd><dl>
1.6 rillig 181: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 182: <dd><dl>
1.6 rillig 183: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 184: <dd><dl>
1.6 rillig 185: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
186: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 187: </dl></dd>
1.6 rillig 188: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
189: <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>
190: </dl></dd>
191: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
192: <dd><dl>
193: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
194: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
195: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
196: <dd><dl>
197: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
198: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
199: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
200: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
201: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
202: </dl></dd>
203: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
204: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
205: <dd><dl>
206: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
207: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
208: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
209: </dl></dd>
210: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
211: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
212: </dl></dd>
213: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
214: <dd><dl>
215: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
216: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
217: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
218: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
219: <dd><dl>
220: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
221: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
222: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
223: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
224: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
225: </dl></dd>
226: </dl></dd>
227: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
228: <dd><dl>
229: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
230: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.10 hubertf 231: <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 232: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
233: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
234: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
235: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
236: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
237: </dl></dd>
238: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
239: <dd><dl>
240: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
241: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
244: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
245: </dl></dd>
246: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
247: <dd><dl>
248: <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>
249: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
250: </dl></dd>
251: </dl></dd>
252: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
253: <dd><dl>
254: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
255: <dd><dl>
256: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
257: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
258: </dl></dd>
259: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
262: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
263: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
264: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
265: </dl></dd>
266: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
267: <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>
268: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
269: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
270: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
271: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
272: <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>
273: </dl></dd>
274: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
275: <dd><dl>
276: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
277: <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>
278: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 279: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 280: </dl></dd>
281: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
282: <dd><dl>
283: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
284: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
285: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
286: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
290: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
291: </dl></dd>
292: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
303: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
304: </dl></dd>
305: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
308: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
309: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
310: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
311: </dl></dd>
312: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
315: <dd><dl>
316: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
317: <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>
318: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
319: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
320: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
321: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
322: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
323: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
324: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
325: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
326: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
327: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
328: </dl></dd>
329: <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>
330: <dd><dl>
331: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
332: <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>
333: </dl></dd>
334: <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>
335: <dd><dl>
336: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
337: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
338: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
345: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
346: </dl></dd>
347: <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>
348: <dd><dl>
349: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
350: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
351: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
352: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
353: </dl></dd>
354: <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>
355: <dd><dl>
356: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
357: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
358: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
359: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
360: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
361: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
362: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
363: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 364: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 365: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
366: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
367: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
368: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
369: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
370: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
371: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
372: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
373: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 374: emulation</a></span></dt>
1.6 rillig 375: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
376: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 377: </dl></dd>
1.6 rillig 378: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 379: </dl></dd>
1.6 rillig 380: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
381: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 382: <dd><dl>
1.6 rillig 383: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
384: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
385: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
386: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
387: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
388: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
389: </dl></dd>
390: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
391: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
392: <dd><dl>
393: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
394: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
395: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
396: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 397: </dl></dd>
398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.6 rillig 401: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 402: <dd><dl>
1.6 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 406: <dd><dl>
1.6 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 409: </dl></dd>
1.6 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 412: <dd><dl>
1.6 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
414: <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 415: </dl></dd>
1.6 rillig 416: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.6 rillig 418: <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>
419: <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 420: </dl></dd>
421: </dl></dd>
1.6 rillig 422: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.6 rillig 424: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 427: <dd><dl>
1.6 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 430: </dl></dd>
431: </dl></dd>
1.6 rillig 432: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 433: <dd><dl>
1.6 rillig 434: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
435: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 436: </dl></dd>
437: </dl></dd>
438: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
439: <dd><dl>
440: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
443: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
444: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.10 hubertf 445: <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 446: </dl></dd>
447: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
448: </dl></dd>
449: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
452: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
453: </dl></dd>
454: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
455: <dd><dl>
456: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3 rillig 460: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.8 rillig 461: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.1 dsieger 463: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
464: source packages</a></span></dt>
465: </dl></dd>
466: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
467: <dd><dl>
468: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
469: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
470: </dl></dd>
471: </dl>
472: </div>
473: <div class="list-of-tables">
474: <p><b>List of Tables</b></p>
475: <dl>
476: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
477: </dt>
1.6 rillig 478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 479: </dt>
1.6 rillig 480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 481: </dt>
482: </dl>
483: </div>
484: <div class="chapter" lang="en">
485: <div class="titlepage"><div><div><h2 class="title">
486: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
487: <div class="toc">
488: <p><b>Table of Contents</b></p>
489: <dl>
490: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
491: <dd><dl>
492: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
493: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
494: </dl></dd>
495: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
496: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
497: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
498: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
499: </dl>
500: </div>
501: <div class="sect1" lang="en">
502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
503: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
504: <p>There is a lot of software freely available for Unix-based
505: systems, which is usually available in form of the source code. Before
506: such software can be used, it needs to be configured to the local
507: system, compiled and installed, and this is exactly what The NetBSD
508: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
509: to handle binary packages, so that not every user has to build the
510: packages for himself, which is a time-costly task.</p>
511: <p>pkgsrc currently contains several thousand packages,
512: including:</p>
513: <div class="itemizedlist"><ul type="disc">
514: <li><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
515: web server</p></li>
516: <li><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
517: web browser</p></li>
518: <li><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
519: Desktop Environment</p></li>
520: <li><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
521: Desktop Environment</p></li>
522: </ul></div>
523: <p>...just to name a few.</p>
524: <p>pkgsrc has built-in support for handling varying dependencies,
525: such as pthreads and X11, and extended features such as IPv6 support on
526: a range of platforms.</p>
527: <div class="sect2" lang="en">
528: <div class="titlepage"><div><div><h3 class="title">
529: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
530: <p>
531: pkgsrc provides the following key features:
532: </p>
533: <div class="itemizedlist"><ul type="disc">
534: <li><p>Easy building of software from source as well as the creation
535: and installation of binary packages. The source and latest
536: patches are retrieved from a master or mirror download site, checksum
537: verified, then built on your system. Support for binary-only
538: distributions is available for both native platforms and NetBSD
539: emulated platforms.</p></li>
540: <li><p>All packages are installed in a consistent directory tree,
541: including binaries, libraries, man pages and other
542: documentation.</p></li>
543: <li><p>Package dependencies, including when performing package updates,
544: are handled automatically. The configuration files of various
545: packages are handled automatically during updates, so local changes
546: are preserved.</p></li>
547: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
548: consists of highly portable code. This allows the greatest speed of
549: development when porting to new a platform. This portability also
550: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
551: platforms</em></span>.</p></li>
552: <li><p>The installation prefix, acceptable software licenses,
553: international encryption requirements and build-time options for a
554: large number of packages are all set in a simple, central
555: configuration file.</p></li>
556: <li><p>The entire source (not including the distribution files) is
557: freely available under a BSD license, so you may extend and adapt
558: pkgsrc to your needs. Support for local packages and patches is
559: available right out of the box, so you can configure it specifically
560: for your environment.</p></li>
561: </ul></div>
562: <p>The following principles are basic to pkgsrc:</p>
563: <div class="itemizedlist"><ul type="disc">
564: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.11 ! rillig 565: — That means, if a package contains bugs, it's better to find
1.1 dsieger 566: them and to complain about them rather than to just install the package
567: and hope that it works. There are numerous checks in pkgsrc that try to
568: 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
569: of shell scripts), and post-installation checks (installed files,
570: references to shared libraries, script interpreters).</p></li>
571: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.11 ! rillig 572: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 573: pkgsrc has been ported to many operating systems. Care is taken that
574: packages behave the same on all platforms.</p></li>
575: </ul></div>
576: </div>
577: <div class="sect2" lang="en">
578: <div class="titlepage"><div><div><h3 class="title">
579: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
580: <p>pkgsrc consists of both a source distribution and a binary
581: distribution for these operating systems. After retrieving the required
582: source or binaries, you can be up and running with pkgsrc in just
583: minutes!</p>
584: <p>pkgsrc was derived from FreeBSD's ports system, and
585: initially developed for NetBSD only. Since then, pkgsrc has
586: grown a lot, and now supports the following platforms:</p>
587: <div class="table">
588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
590: <colgroup>
591: <col>
592: <col>
593: </colgroup>
594: <thead><tr>
595: <th>Platform</th>
596: <th>Date Support Added</th>
597: </tr></thead>
598: <tbody>
599: <tr>
1.10 hubertf 600: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 601: <td align="center">Aug 1997</td>
602: </tr>
603: <tr>
1.10 hubertf 604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 605: <td align="center">Mar 1999</td>
606: </tr>
607: <tr>
1.10 hubertf 608: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 609: <td align="center">Jun 1999</td>
610: </tr>
611: <tr>
612: <td>
1.10 hubertf 613: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
614: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 615: </td>
616: <td align="center">Oct 2001</td>
617: </tr>
618: <tr>
1.10 hubertf 619: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 620: <td align="center">Nov 2002</td>
621: </tr>
622: <tr>
1.10 hubertf 623: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 624: <td align="center">Nov 2002</td>
625: </tr>
626: <tr>
1.10 hubertf 627: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 628: <td align="center">Dec 2002</td>
629: </tr>
630: <tr>
631: <td>BSD/OS</td>
632: <td align="center">Dec 2003</td>
633: </tr>
634: <tr>
1.10 hubertf 635: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 636: <td align="center">Dec 2003</td>
637: </tr>
638: <tr>
639: <td>
1.10 hubertf 640: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 641: (Microsoft Windows Services for Unix)
642: </td>
643: <td align="center">Mar 2004</td>
644: </tr>
645: <tr>
1.10 hubertf 646: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 647: <td align="center">Oct 2004</td>
648: </tr>
649: <tr>
1.10 hubertf 650: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 651: <td align="center">Nov 2004</td>
652: </tr>
653: <tr>
1.10 hubertf 654: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 655: <td align="center">Apr 2007</td>
656: </tr>
657: </tbody>
658: </table></div>
659: </div>
660: <br class="table-break">
661: </div>
662: </div>
663: <div class="sect1" lang="en">
664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
665: <a name="overview"></a>1.2. Overview</h2></div></div></div>
666: <p>This document is divided into three parts. The first,
1.10 hubertf 667: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 668: describes how one can use one of the packages in the Package
669: Collection, either by installing a precompiled binary package,
670: or by building one's own copy using the NetBSD package system.
1.10 hubertf 671: 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 672: package so it can be easily built by other NetBSD users without
673: knowing about the package's building details. The third part,
1.10 hubertf 674: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 675: is intended for those who want to understand how pkgsrc is
676: implemented.</p>
677: <p>This document is available in various formats:
1.10 hubertf 678: <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 679: </div>
680: <div class="sect1" lang="en">
681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
682: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
683: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
684: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
685: terminology used within this document.</p>
686: <div class="variablelist"><dl>
687: <dt><span class="term">Package</span></dt>
688: <dd><p>A set of files and building instructions
689: that describe what's necessary
690: to build a certain piece of software using
691: pkgsrc. Packages are traditionally stored under
692: <code class="filename">/usr/pkgsrc</code>.</p></dd>
693: <dt><span class="term">The NetBSD package system</span></dt>
694: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
695: is part of the NetBSD operating system and can be bootstrapped
696: to run on non-NetBSD operating systems as well. It handles
697: building (compiling), installing, and removing of
698: packages.</p></dd>
699: <dt><span class="term">Distfile</span></dt>
700: <dd><p>This term describes the file or files that are
701: provided by the author of the piece of software to
702: distribute his work. All the changes necessary to build on
703: NetBSD are reflected in the corresponding package. Usually
704: the distfile is in the form of a compressed tar-archive,
705: but other types are possible, too. Distfiles are usually
706: stored below
707: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
708: <dt><span class="term">Port</span></dt>
709: <dd><p>This is the term used by FreeBSD and OpenBSD people
710: for what we call a package.
711: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
712: architecture.</p></dd>
713: <dt><span class="term">Precompiled/binary package</span></dt>
714: <dd>
715: <p>A set of binaries built with pkgsrc from a distfile
716: and stuffed together in a single <code class="filename">.tgz</code>
717: file so it can be installed on machines of the same
718: machine architecture without the need to
719: recompile. Packages are usually generated in
720: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.10 hubertf 721: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.1 dsieger 722: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
723: especially in the context of precompiled packages.</p>
724: </dd>
725: <dt><span class="term">Program</span></dt>
726: <dd><p>The piece of software to be installed which will be
727: constructed from all the files in the distfile by the
728: actions defined in the corresponding package.</p></dd>
729: </dl></div>
730: <div class="sect2" lang="en">
731: <div class="titlepage"><div><div><h3 class="title">
732: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
733: <div class="variablelist"><dl>
734: <dt><span class="term">pkgsrc users</span></dt>
735: <dd>
736: <p>The
737: pkgsrc users are people who use the packages provided by pkgsrc.
738: Typically they are system administrators. The people using the
739: software that is inside the packages (maybe called “<span class="quote">end
740: users</span>”) are not covered by the pkgsrc guide.</p>
741: <p>There are two kinds of pkgsrc users: Some only want to
742: install pre-built binary packages. Others build the pkgsrc
743: packages from source, either for installing them directly or for
1.10 hubertf 744: 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 745: documentation.</p>
746: </dd>
747: <dt><span class="term">package maintainers</span></dt>
748: <dd><p>A
1.10 hubertf 749: 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 750: <dt><span class="term">infrastructure developers</span></dt>
751: <dd><p>These people are involved in all those files
752: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 753: 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 754: too.</p></dd>
755: </dl></div>
756: </div>
757: </div>
758: <div class="sect1" lang="en">
759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
760: <a name="typography"></a>1.4. Typography</h2></div></div></div>
761: <p>When giving examples for commands, shell prompts are used to
762: show if the command should/can be issued as root, or if
763: “<span class="quote">normal</span>” user privileges are sufficient. We use a
764: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
765: shell prompt, assuming they use the C-shell or tcsh.</p>
766: </div>
767: </div>
768: <div class="part" lang="en">
769: <div class="titlepage"><div><div><h1 class="title">
770: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
771: <div class="toc">
772: <p><b>Table of Contents</b></p>
773: <dl>
774: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
775: <dd><dl>
776: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
777: <dd><dl>
778: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
779: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
780: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
781: </dl></dd>
782: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
783: <dd><dl>
784: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
785: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
786: </dl></dd>
787: </dl></dd>
788: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
789: <dd><dl>
790: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
791: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
792: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
793: <dd><dl>
794: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
795: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
796: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
797: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
798: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
799: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
800: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
801: </dl></dd>
802: </dl></dd>
803: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
804: <dd><dl>
805: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
806: <dd><dl>
807: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
808: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
809: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
810: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
811: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
812: <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>
813: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
814: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
815: </dl></dd>
816: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
817: <dd><dl>
818: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
819: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
820: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
821: </dl></dd>
822: </dl></dd>
823: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
824: <dd><dl>
825: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
826: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 827: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 828: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 829: <dd><dl>
1.4 rillig 830: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
831: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
832: <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 833: </dl></dd>
1.4 rillig 834: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
835: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 836: </dl></dd>
837: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
838: <dd><dl>
839: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
840: <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 841: </dl></dd>
842: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
843: builds)</a></span></dt>
1.1 dsieger 844: <dd><dl>
1.6 rillig 845: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
846: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
847: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
848: <dd><dl>
849: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
850: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
851: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
852: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
853: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
854: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
855: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
856: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
857: </dl></dd>
858: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
859: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
860: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
861: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
862: </dl></dd>
863: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
864: <dd><dl>
865: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
866: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
867: </dl></dd>
868: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
869: <dd><dl>
870: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
871: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
872: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
873: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
874: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
875: <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>
876: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.10 hubertf 877: <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 878: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
879: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 880: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 881: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
882: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
883: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
884: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
885: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
886: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
887: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.1 dsieger 888: </dl></dd>
889: </dl>
890: </div>
891: <div class="chapter" lang="en">
892: <div class="titlepage"><div><div><h2 class="title">
893: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
894: <div class="toc">
895: <p><b>Table of Contents</b></p>
896: <dl>
897: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
898: <dd><dl>
899: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
900: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
901: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
902: </dl></dd>
903: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
904: <dd><dl>
905: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
906: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
907: </dl></dd>
908: </dl>
909: </div>
910: <p>Before you download and extract the files, you need to decide
911: where you want to extract them. When using pkgsrc as root user, pkgsrc
912: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
913: free to install the sources and binary packages wherever you want in
914: your filesystem, provided that the pathname does not contain white-space
915: or other characters that are interpreted specially by the shell and some
916: other programs. A safe bet is to use only letters, digits, underscores
917: and dashes.</p>
918: <div class="sect1" lang="en">
919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
920: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
921: <p>Before you download any pkgsrc files, you should decide
922: whether you want the <span class="emphasis"><em>current</em></span> branch or the
923: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
924: quarterly basis from the current branch and only gets modified
925: for security updates. The names of the stable branches are built
926: from the year and the quarter, for example
927: <code class="literal">2007Q1</code>.</p>
928: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
929: want to download pkgsrc. You can get it as a tar file, via SUP,
930: or via CVS. All three ways are described here.</p>
931: <div class="sect2" lang="en">
932: <div class="titlepage"><div><div><h3 class="title">
933: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
934: <p>The primary download location for all pkgsrc files is
1.10 hubertf 935: <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 936: number of subdirectories for different purposes, which are
1.10 hubertf 937: 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 938: <p>The tar file for the current branch is in the directory
1.10 hubertf 939: <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 940: It is autogenerated daily.</p>
941: <p>The tar file for the stable branch 2007Q1 is in the
1.10 hubertf 942: directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q1/pkgsrc-2007Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q1.tar.gz</code></a>.</p>
1.1 dsieger 943: <p>After downloading the tar file, change to the directory
944: where you want to have pkgsrc. This is usually
1.10 hubertf 945: <code class="filename">/usr</code>. Then, run <span class="command"><strong>gzcat
1.1 dsieger 946: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
947: </div>
948: <div class="sect2" lang="en">
949: <div class="titlepage"><div><div><h3 class="title">
950: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
951: <p>As an alternative to the tar file, you can get pkgsrc via
952: the Software Update Protocol, SUP. To do so, make sure your
953: supfile has a line
954:
955: </p>
956: <pre class="programlisting">
957: release=pkgsrc
958: </pre>
959: <p>
960:
961: in it, see the examples in
962: <code class="filename">/usr/share/examples/supfiles</code>, and that the
963: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.10 hubertf 964: run <span class="command"><strong>sup -v
1.1 dsieger 965: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
966: </div>
967: <div class="sect2" lang="en">
968: <div class="titlepage"><div><div><h3 class="title">
969: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.10 hubertf 970: <p>To get pkgsrc via CVS, make sure you have <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
1.1 dsieger 971: installed. To do an initial (full) checkout of pkgsrc, you first
972: have to set some environment variables. For the C-Shell,
973: type:</p>
974: <pre class="screen">
975: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
976: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
977: </pre>
978: <p>Or, the same for the bourne shell:</p>
979: <pre class="screen">
980: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
981: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
982: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
983: </pre>
1.2 rillig 984: <p>By default, cvs doesn't do things like most people would
985: expect it to do, and this is unlikely to change. But there is a
986: way to convince cvs, by creating a file called
987: <code class="filename">.cvsrc</code> in your home directory and saving
988: the following lines to it. This file will save you lots of
989: headache and some bug reports, so we strongly recommend it. You
990: can find an explanation of this file in the CVS
991: documentation.</p>
992: <pre class="programlisting">
993: # recommended CVS configuration file from the pkgsrc guide
994: checkout -P
1.4 rillig 995: update -dP
1.2 rillig 996: release -d
1.4 rillig 997: diff -upN
1.2 rillig 998: cvs -q -z3
999: rdiff -u
1000: </pre>
1.1 dsieger 1001: <p>Then, you change to the directory where you want to have
1002: your copy of pkgsrc. In most cases this is
1003: <code class="filename">/usr</code>. In that directory you run the
1.10 hubertf 1004: checkout command, which is <span class="command"><strong>cvs -q checkout -P
1005: pkgsrc</strong></span> for the current branch and <span class="command"><strong>cvs -q
1.1 dsieger 1006: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1007: branch. This command will create a directory called
1008: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1009: it.</p>
1010: </div>
1011: </div>
1012: <div class="sect1" lang="en">
1013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1014: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1015: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1016: (which also works if you have first installed it via a tar
1017: file). It saves bandwidth and hard disk activity, compared to
1018: downloading the tar file again.</p>
1019: <div class="sect2" lang="en">
1020: <div class="titlepage"><div><div><h3 class="title">
1021: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1022: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1023: <h3 class="title">Warning</h3>
1024: <p>When updating from a tar file, you first need to
1025: completely remove the old pkgsrc directory. Otherwise those
1026: files that have been removed from pkgsrc in the mean time will
1027: not be removed on your local disk, resulting in inconsistencies.
1028: When removing the old files, any changes that you have done to
1029: the pkgsrc files will be lost after updating. Therefore updating
1030: via CVS is strongly recommended.</p>
1031: </div>
1032: <p>Note that by default the distfiles and the binary packages
1033: are saved in the pkgsrc tree, so don't forget to rescue them
1034: before updating. You can also configure pkgsrc to use other than
1035: the default directories by setting the
1036: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1037: 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 1038: <p>To update pkgsrc from a tar file, download the tar file as
1039: explained above. Then, make sure that you have not made any
1040: changes to the files in the pkgsrc directory. Remove the pkgsrc
1041: directory and extract the new tar file. Done.</p>
1042: </div>
1043: <div class="sect2" lang="en">
1044: <div class="titlepage"><div><div><h3 class="title">
1045: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1046: <p>To update pkgsrc via CVS, make sure the environment
1047: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.10 hubertf 1048: change to the pkgsrc directory and run <span class="command"><strong>cvs -q update
1.1 dsieger 1049: -dP</strong></span>.</p>
1050: <div class="sect3" lang="en">
1051: <div class="titlepage"><div><div><h4 class="title">
1052: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1053: <p>When updating pkgsrc, the CVS program keeps track of the
1054: branch you selected. But if you, for whatever reason, want to
1055: switch from the stable branch to the current one, you can do it
1056: by adding the option “<span class="quote">-A</span>” after the
1057: “<span class="quote">update</span>” keyword. To switch from the current branch
1058: back to the stable branch, add the
1059: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1060: </div>
1061: <div class="sect3" lang="en">
1062: <div class="titlepage"><div><div><h4 class="title">
1063: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1064: <p>When you update pkgsrc, the CVS program will only touch
1065: those files that are registered in the CVS repository. That
1066: means that any packages that you created on your own will stay
1067: unmodified. If you change files that are managed by CVS, later
1068: updates will try to merge your changes with those that have been
1069: done by others. See the CVS manual, chapter
1070: “<span class="quote">update</span>” for details.</p>
1071: </div>
1072: </div>
1073: </div>
1074: </div>
1075: <div class="chapter" lang="en">
1076: <div class="titlepage"><div><div><h2 class="title">
1077: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1078: <div class="toc">
1079: <p><b>Table of Contents</b></p>
1080: <dl>
1081: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1082: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1083: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1084: <dd><dl>
1085: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1086: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1087: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1088: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1089: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1090: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1091: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1092: </dl></dd>
1093: </dl>
1094: </div>
1095: <div class="sect1" lang="en">
1096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1097: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1098: <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 1099: </div>
1100: <div class="sect1" lang="en">
1101: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1102: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1103: <p>Installing the bootstrap kit from source should be as simple as:</p>
1104: <pre class="screen">
1105: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1106: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1107: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1108: </pre>
1.10 hubertf 1109: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.1 dsieger 1110: pkgsrc before bootstrapping. The given
1.10 hubertf 1111: <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.1 dsieger 1112: <code class="filename">/usr/pkg</code> for the
1113: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1114: and <code class="filename">/var/db/pkg</code> for the package database
1115: directory where pkgsrc will do its internal bookkeeping.
1116: However, these can also be set using command-line
1117: arguments.</p>
1118: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1119: <h3 class="title">Note</h3>
1.10 hubertf 1120: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1121: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1122: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.1 dsieger 1123: instead of “<span class="quote">make</span>”.</p>
1124: </div>
1125: </div>
1126: <div class="sect1" lang="en">
1127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1128: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1129: <p>Here are some platform-specific notes you should be aware of.</p>
1130: <div class="sect2" lang="en">
1131: <div class="titlepage"><div><div><h3 class="title">
1132: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1133: <p>Darwin 5.x and up are supported. There are two methods of using
1.10 hubertf 1134: pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1135: image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.1 dsieger 1136: partition</a>.</p>
1137: <p>Before you start, you will need to download and install the Mac OS X Developer
1.10 hubertf 1138: Tools from Apple's Developer Connection. See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.1 dsieger 1139: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1.10 hubertf 1140: from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.1 dsieger 1141: if you intend to build packages that use the X11 Window System.</p>
1142: <p>If you already have a UFS or HFSX partition, or have a spare partition
1143: that you can format as UFS or HFSX, it is recommended to use that instead of
1144: the disk image. It'll be somewhat faster and will mount automatically
1145: at boot time, where you must manually mount a disk image.</p>
1146: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1147: <h3 class="title">Note</h3>
1148: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1149: requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1150: </div>
1151: <div class="sect3" lang="en">
1152: <div class="titlepage"><div><div><h4 class="title">
1153: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1154: <p>Create the disk image:</p>
1155: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1156: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1157: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1158: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1159: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1160: <h3 class="title">Note</h3>
1.9 rillig 1161: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journaling.</p>
1.1 dsieger 1162: </div>
1163: <p>Allow suid:</p>
1164: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.5 weinem 1165: <p>Changing the build directory:</p>
1166: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
1167: <pre class="programlisting">
1168: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1169: </pre>
1.1 dsieger 1170: </div>
1171: <div class="sect3" lang="en">
1172: <div class="titlepage"><div><div><h4 class="title">
1173: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1174: <p>By default, <code class="filename">/usr</code> will be on your root file
1175: system, normally HFS+. It is possible to use the default
1176: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1177: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1178: or HFSX file system. Obviously, another symlink is required if you want to
1179: place the package database directory outside the
1180: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1181: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1182: <p>If you created your partitions at the time of installing Mac OS X
1183: and formatted the target partition as UFS or HFSX, it should automatically
1184: mount on <code class="filename">/Volumes/<volume name></code> when the
1185: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1186: to ensure that the partition map correctly reflects
1187: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1188: <p>The problem is that none of the disk tools will let you touch a
1189: disk that is booted from. You can unmount the partition, but even if
1190: you newfs it, the partition type will be incorrect and the
1191: automounter won't mount it. It can be mounted manually, but it won't
1192: appear in Finder.</p>
1193: <p>You'll need to boot off of the OS X Installation (User) CD. When
1194: the Installation program starts, go up to the menu and select Disk
1195: Utility. Now, you will be able to select the partition you want
1196: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1197: installer which will reboot your machine. The new UFS or HFSX file system
1198: will appear in Finder.</p>
1199: <p>Be aware that the permissions on the new file system will be writable
1200: by root only.</p>
1201: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1202: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1203: </div>
1204: </div>
1205: <div class="sect2" lang="en">
1206: <div class="titlepage"><div><div><h3 class="title">
1207: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1208: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1209: other versions may work.</p>
1210: <p>Care should be taken so that the tools that this kit installs do not conflict
1211: with the FreeBSD userland tools. There are several steps:</p>
1212: <div class="orderedlist"><ol type="1">
1213: <li><p>FreeBSD stores its ports pkg database in
1214: <code class="filename">/var/db/pkg</code>. It is therefore
1215: recommended that you choose a different location (e.g.
1216: <code class="filename">/usr/pkgdb</code>) by
1217: using the --pkgdbdir option to the bootstrap script.</p></li>
1218: <li>
1219: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1220: good idea to move them out of the way to avoid confusion, e.g.</p>
1221: <pre class="screen">
1222: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1223: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1224: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1225: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1226: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1227: </pre>
1228: </li>
1.10 hubertf 1229: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1230: <code class="filename">/etc/mk.conf.example</code> file
1231: when you use the bootstrap script.</p></li>
1232: </ol></div>
1233: </div>
1234: <div class="sect2" lang="en">
1235: <div class="titlepage"><div><div><h3 class="title">
1236: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1237: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1238: providing a Unix-like environment with a tighter kernel integration than
1239: available with Cygwin. It is part of the Windows Services for Unix
1240: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1241: (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 1242: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1243: are not officially supported. (The main difference in 3.0/3.1 is lack
1244: of pthreads, but other parts of libc may also be lacking.)</p>
1245: <p>Services for Unix Applications (aka SUA) is an integrated component
1246: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1247: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1248: <div class="sect3" lang="en">
1249: <div class="titlepage"><div><div><h4 class="title">
1250: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1251: <p>At an absolute minimum, the following packages must be installed from
1252: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1253: <div class="itemizedlist"><ul type="disc">
1254: <li><p>Utilities -> Base Utilities</p></li>
1255: <li><p>Interix GNU Components -> (all)</p></li>
1256: <li><p>Remote Connectivity</p></li>
1257: <li><p>Interix SDK</p></li>
1258: </ul></div>
1259: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1260: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1261: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1262: pkgsrc (or from a binary package).</p>
1263: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1264: not need to be installed, but Remote Connectivity itself should be
1265: installed in order to have a working inetd.</p>
1266: <p>During installation you may be asked whether to enable setuid
1267: behavior for Interix programs, and whether to make pathnames default to
1268: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1269: enabled. (Without case-sensitivity, a large number of packages including
1270: perl will not build.)</p>
1271: <p>NOTE: Newer Windows service packs change the way binary execution
1272: works (via the Data Execution Prevention feature). In order to use
1273: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1274: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1275: must be installed. Hotfixes are available from Microsoft through a
1276: support contract; however, a NetBSD developer has made most Interix
1.10 hubertf 1277: hotfixes available for personal use from <a class="ulink" href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.1 dsieger 1278: <p>In addition to the hotfix noted above, it may be necessary to
1279: disable Data Execution Prevention entirely to make Interix functional.
1280: This may happen only with certain types of CPUs; the cause is not fully
1281: understood at this time. If gcc or other applications still segfault
1282: repeatedly after installing one of the hotfixes note above, the
1283: following option can be added to the appropriate "boot.ini" line on the
1284: Windows boot drive: /NoExecute=AlwaysOff
1285: (WARNING, this will disable DEP completely, which may be a security
1286: risk if applications are often run as a user in the Administrators
1287: group!)</p>
1288: </div>
1289: <div class="sect3" lang="en">
1290: <div class="titlepage"><div><div><h4 class="title">
1291: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1292: <p>If SFU is already installed and you wish to alter these settings to work
1293: with pkgsrc, note the following things.</p>
1294: <div class="itemizedlist"><ul type="disc">
1295: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1296: Windows Services for UNIX, then click Change. In the installer, choose
1297: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1298: <li>
1299: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1300: change the following registry key:</p>
1301: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1302: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1303: </li>
1304: <li>
1305: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1306: following registry key:</p>
1307: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1308: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1309: </li>
1310: </ul></div>
1311: </div>
1312: <div class="sect3" lang="en">
1313: <div class="titlepage"><div><div><h4 class="title">
1314: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1315: <p>The package manager (either the pkgsrc "su" user, or the user
1316: running "pkg_add") must be a member of the local Administrators
1317: group. Such a user must also be used to run the bootstrap. This is
1318: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1319: <p>The package manager should use a umask of 002. "make install" will
1320: automatically complain if this is not the case. This ensures that
1321: directories written in /var/db/pkg are Administrators-group writeable.</p>
1322: <p>The popular Interix binary packages from http://www.interopsystems.com/
1323: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1324: NOT be used in conjunction with pkgsrc. If you choose to use them at
1325: the same time as the pkgsrc packages, ensure that you use the proper
1326: pkg_* tools for each type of binary package.</p>
1327: <p>The TERM setting used for DOS-type console windows (including those
1328: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1329: don't have a termcap/terminfo entry for it, but the following .termcap
1330: entry provides adequate emulation in most cases:</p>
1331: <pre class="programlisting">
1332: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1333: </pre>
1334: </div>
1335: <div class="sect3" lang="en">
1336: <div class="titlepage"><div><div><h4 class="title">
1337: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1338: <p>Though Interix suffices as a familiar and flexible substitute
1339: for a full Unix-like platform, it has some drawbacks that should
1340: be noted for those desiring to make the most of Interix.</p>
1341: <div class="itemizedlist"><ul type="disc">
1342: <li>
1343: <p><span class="strong"><strong>X11:</strong></span></p>
1344: <p>Interix comes with the standard set of X11R6 client libraries,
1345: and can run X11 based applications, but it does
1346: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1347: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1348: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1349: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1350: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1351: and the free X11 server included with
1.10 hubertf 1352: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1353: </li>
1354: <li>
1355: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1356: <p>Because Interix runs in a completely different NT subsystem from
1357: Win32 applications, it does not currently support various X11
1358: protocol extensions for acceleration (such as MIT-SHM or DGA).
1359: Most interactive applications to a local X server will run
1360: reasonably fast, but full motion video and other graphics
1361: intensive applications may require a faster-than-expected CPU.</p>
1362: </li>
1363: <li>
1364: <p><span class="strong"><strong>Audio:</strong></span></p>
1365: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1366: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1367: audio system on Interix. Unlike on most platforms, the
1368: <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 1369: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1370: server component. To output audio via an Interix host, the
1371: <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
1372: must also be installed.</p>
1373: </li>
1374: <li>
1375: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1376: <p>Direct device access is not currently supported in Interix, so it
1377: is not currently possible to access CD/DVD drives, USB devices,
1378: or SCSI devices through non-filesystem means. Among other things,
1379: this makes it impossible to use Interix directly for CD/DVD
1380: burning.</p>
1381: </li>
1382: <li>
1383: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1384: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1385: drives are also not directly accessible in Interix. However,
1386: support is in work to make tape drive access possible by using
1387: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1388: esound server).</p>
1389: </li>
1390: </ul></div>
1391: </div>
1392: <div class="sect3" lang="en">
1393: <div class="titlepage"><div><div><h4 class="title">
1394: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1395: <p>It is not necessary, in general, to have a "root" user on the
1396: Windows system; any member of the local Administrators group will
1397: suffice. However, some packages currently assume that the user
1398: named "root" is the privileged user. To accommodate these, you
1399: may create such a user; make sure it is in the local group
1400: Administrators (or your language equivalent).</p>
1.10 hubertf 1401: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1402: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1403: time being, install packages as the local Administrator (or
1404: your language equivalent), or run the following command after
1405: installing a package to work around the issue:</p>
1406: <pre class="screen">
1407: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1408: </pre>
1409: </div>
1410: </div>
1411: <div class="sect2" lang="en">
1412: <div class="titlepage"><div><div><h3 class="title">
1413: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1414: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1415: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1416: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1417: 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 1418: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.10 hubertf 1419: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><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-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1 dsieger 1420: etc.</p>
1421: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1422: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1423: you start out using "abi=n32", that's what all your packages will be built
1424: with.</p>
1425: <p>Therefore, please make sure that you have no conflicting
1426: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1427: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1428: try to link n32 object files with lib64 or vice versa. Check your
1429: <code class="filename">/etc/compiler.defaults</code>!</p>
1430: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1431: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1432: as it appears that IRIX linker occasionally runs into issues when trying to
1433: link over a network-mounted file system.</p>
1434: <p>The bootstrapping process should set all the right options for programs such
1435: as imake(1), but you may want to set some options depending on your local
1436: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1437: course, your compiler's man pages for details.</p>
1438: <p>If you are using SGI's MIPSPro compiler, please set
1439:
1440: </p>
1441: <pre class="programlisting">
1442: PKGSRC_COMPILER= mipspro
1443: </pre>
1444: <p>
1445:
1.10 hubertf 1446: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1447: are using gcc and may end up passing invalid flags to the compiler. Note that
1448: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1449: default.</p>
1450: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1451: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1452: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1453: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1454: '--preserve-path' flag.</p>
1455: </div>
1456: <div class="sect2" lang="en">
1457: <div class="titlepage"><div><div><h3 class="title">
1458: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1459: <p>Some versions of Linux (for example Debian GNU/Linux) need
1460: either libtermcap or libcurses (libncurses). Installing the
1461: distributions libncurses-dev package (or equivalent) should fix
1462: the problem.</p>
1463: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1464: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1465: i386 have been tested.</p>
1466: <p>To bootstrap using icc, assuming the default icc installation
1467: directory:</p>
1468: <pre class="programlisting">
1469: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1470: ac_cv___attribute__=yes ./bootstrap
1471: </pre>
1472: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1473: <h3 class="title">Note</h3>
1474: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1475: </div>
1476: <p>icc supports __attribute__, but the GNU configure test uses a nested
1477: function, which icc does not support. #undef'ing __attribute__ has the
1478: unfortunate side-effect of breaking many of the Linux header files, which
1479: cannot be compiled properly without __attribute__. The test must be
1480: overridden so that __attribute__ is assumed supported by the
1481: compiler.</p>
1482: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.10 hubertf 1483: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1484: <pre class="programlisting">
1485: PKGSRC_COMPILER= icc
1486: </pre>
1487: <p>The default installation directory for icc is
1488: <code class="filename">/opt/intel_cc_80</code>, which
1489: is also the pkgsrc default. If you have installed it into a different
1490: directory, set <code class="varname">ICCBASE</code> in
1.10 hubertf 1491: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1492: <pre class="programlisting">
1493: ICCBASE= /opt/icc
1494: </pre>
1495: <p>pkgsrc uses the static linking method of the runtime libraries
1496: provided by icc, so binaries can be run on other systems which do not
1497: have the shared libraries installed.</p>
1498: <p>Libtool, however, extracts a list of libraries from the
1.10 hubertf 1499: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1 dsieger 1500: records it, throwing away the -Bstatic and -Bdynamic options
1501: interspersed between the libraries. This means that
1502: libtool-linked C++ shared libraries will have a runtime
1503: dependency on the icc libraries until this is fixed in
1504: libtool.</p>
1505: </div>
1506: <div class="sect2" lang="en">
1507: <div class="titlepage"><div><div><h3 class="title">
1508: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1509: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1510: <p>Care should be taken so that the tools that this kit installs do not conflict
1511: with the OpenBSD userland tools. There are several steps:</p>
1512: <div class="orderedlist"><ol type="1">
1513: <li><p>OpenBSD stores its ports pkg database in
1514: <code class="filename">/var/db/pkg</code>. It is therefore
1515: recommended that you choose a different location (e.g.
1516: <code class="filename">/usr/pkgdb</code>) by
1517: using the --pkgdbdir option to the bootstrap script.</p></li>
1518: <li>
1519: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1520: good idea to move them out of the way to avoid confusion, e.g.</p>
1521: <pre class="screen">
1522: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1523: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1524: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1525: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1526: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1527: </pre>
1528: </li>
1529: <li>
1.10 hubertf 1530: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1531: <code class="filename">/etc/mk.conf.example</code> file
1532: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1533: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1534: as well. You can work around this by enclosing all the pkgsrc-specific parts
1535: of the file with:</p>
1536: <pre class="programlisting">
1537: .ifdef BSD_PKG_MK
1538: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1539: .else
1540: # OpenBSD stuff
1541: .endif
1542: </pre>
1543: </li>
1544: </ol></div>
1545: </div>
1546: <div class="sect2" lang="en">
1547: <div class="titlepage"><div><div><h3 class="title">
1548: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1549: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1550: You will need a working C compiler. Both gcc 2.95.3 and
1551: Sun WorkShop 5 have been tested.</p>
1552: <p>The following packages are required on Solaris 8 for the bootstrap
1553: process and to build packages.</p>
1554: <div class="itemizedlist"><ul type="disc">
1555: <li><p>SUNWsprot</p></li>
1556: <li><p>SUNWarc</p></li>
1557: <li><p>SUNWbtool</p></li>
1558: <li><p>SUNWtoo</p></li>
1559: <li><p>SUNWlibm</p></li>
1560: </ul></div>
1561: <p>Please note that the use of GNU binutils on Solaris is
1562: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1563: <p>Whichever compiler you use, please ensure the compiler tools and
1564: your $prefix are in your <code class="varname">PATH</code>. This includes
1565: <code class="filename">/usr/ccs/{bin,lib}</code>
1566: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1567: <div class="sect3" lang="en">
1568: <div class="titlepage"><div><div><h4 class="title">
1569: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1570: <p>It makes life much simpler if you only use the same gcc consistently
1571: for building all packages.</p>
1572: <p>It is recommended that an external gcc be used only for bootstrapping,
1573: then either build gcc from
1574: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1575: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1576: <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 1577: </div>
1578: <div class="sect3" lang="en">
1579: <div class="titlepage"><div><div><h4 class="title">
1580: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1581: <p>You will need at least the following packages installed (from WorkShop
1582: 5.0)</p>
1583: <div class="itemizedlist"><ul type="disc">
1584: <li><p>SPROcc
1585: - Sun WorkShop Compiler C 5.0</p></li>
1586: <li><p>SPROcpl
1587: - Sun WorkShop Compiler C++ 5.0</p></li>
1588: <li><p>SPROild
1589: - Sun WorkShop Incremental Linker</p></li>
1590: <li><p>SPROlang
1591: - Sun WorkShop Compilers common components</p></li>
1592: </ul></div>
1593: <p>You should set the following variables in your
1.10 hubertf 1594: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1595: <pre class="programlisting">
1596: CC= cc
1597: CXX= CC
1598: CPP= cc -E
1599: CXXCPP= CC -E
1600: </pre>
1601: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1602: <h3 class="title">Note</h3>
1603: <p>The <code class="varname">CPP</code> setting might break some
1604: packages that use the C preprocessor for processing things other
1605: than C source code.</p>
1606: </div>
1607: </div>
1608: <div class="sect3" lang="en">
1609: <div class="titlepage"><div><div><h4 class="title">
1610: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1611: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1612: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1613: <pre class="programlisting">
1614: PKGSRC_COMPILER= sunpro
1615: ABI= 64
1616: </pre>
1617: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1618: <h3 class="title">Note</h3>
1619: <p>This setting has been tested for the SPARC
1620: architecture. Intel and AMD machines need some more
1621: work.</p>
1622: </div>
1623: </div>
1624: <div class="sect3" lang="en">
1625: <div class="titlepage"><div><div><h4 class="title">
1626: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.10 hubertf 1627: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1628: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1629: The workaround is to use another shell for the configure
1630: 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 1631: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1632: <pre class="programlisting">
1633: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1634: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1635: </pre>
1636: <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>
1637: </div>
1638: </div>
1639: </div>
1640: </div>
1641: <div class="chapter" lang="en">
1642: <div class="titlepage"><div><div><h2 class="title">
1643: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1644: <div class="toc">
1645: <p><b>Table of Contents</b></p>
1646: <dl>
1647: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1648: <dd><dl>
1649: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1650: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1651: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1652: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1653: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1654: <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>
1655: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1656: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1657: </dl></dd>
1658: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1659: <dd><dl>
1660: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1661: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1662: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1663: </dl></dd>
1664: </dl>
1665: </div>
1666: <p>Basically, there are two ways of using pkgsrc. The first
1667: is to only install the package tools and to use binary packages
1668: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1669: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1670: of pkgsrc, too. Then you are able to build your own packages,
1671: and you can still use binary packages from someone else.</p>
1672: <div class="sect1" lang="en">
1673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1674: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1675: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1676: server and its mirrors, there are collections of binary packages,
1677: ready to be installed. These binary packages have been built using the
1678: default settings for the directories, that is:</p>
1679: <div class="itemizedlist"><ul type="disc">
1680: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1681: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1682: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1683: </ul></div>
1684: <p>If you cannot use these directories for whatever reasons (maybe
1685: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1686: 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.1 dsieger 1687: <div class="sect2" lang="en">
1688: <div class="titlepage"><div><div><h3 class="title">
1689: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1690: <p>To install binary packages, you first need to know from where
1691: to get them. The first place where you should look is on the main
1.10 hubertf 1692: 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 1693: <p>This directory contains binary packages for multiple
1694: platforms. First, select your operating system. (Ignore the
1695: directories with version numbers attached to it, they just exist for
1696: legacy reasons.) Then, select your hardware architecture, and in the
1.9 rillig 1697: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.</p>
1698: <p>In this directory, you often find a file called
1699: <code class="filename">bootstrap.tar.gz</code> which contains the package
1700: management tools. If the file is missing, it is likely that your
1701: operating system already provides those tools. Download the file and
1702: extract it in the <code class="filename">/</code> directory. It will create
1703: the directories <code class="filename">/usr/pkg</code> (containing the tools
1704: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1705: (the database of installed packages).</p>
1.1 dsieger 1706: </div>
1707: <div class="sect2" lang="en">
1708: <div class="titlepage"><div><div><h3 class="title">
1709: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1710: <p>In the directory from the last section, there is a
1711: subdirectory called <code class="filename">All</code>, which contains all the
1712: binary packages that are available for the platform, excluding those
1713: that may not be distributed via FTP or CDROM (depending on which
1714: medium you are using), and the ones that have vulnerabilities and
1715: therefore are considered insecure to install without thinking
1716: before.</p>
1717: <p>To install packages directly from an FTP or HTTP server, run
1718: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1719: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1720: <pre class="screen">
1721: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1722: <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>
1723: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1724: </pre>
1725: <p>Instead of URLs, you can also use local paths, for example if
1726: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1727: repository. If you want to install packages from multiple sources,
1728: you can separate them by a semicolon in
1729: <code class="varname">PKG_PATH</code>.</p>
1730: <p>After these preparations, installing a package is very
1731: easy:</p>
1732: <pre class="screen">
1733: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1734: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1735: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1736: </pre>
1.1 dsieger 1737: <p>Note that any prerequisite packages needed to run the
1738: package in question will be installed, too, assuming they are
1739: present where you install from.</p>
1.9 rillig 1740: <p>As mentioned above, packages for which vulnerabilities get
1741: known are not stored in the <code class="filename">All</code> subdirectory.
1742: They don't get deleted since that could be very frustrating if many
1743: other packages depend on it. Instead, they are moved to the
1744: <code class="filename">vulnerable</code> subdirectory. So you may need to add
1745: this directory to the <code class="varname">PKG_PATH</code> variable.
1746: However, you should run <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> regularly, especially
1747: after installing new packages, and verify that the vulnerabilities
1748: are acceptable for your configuration.</p>
1.1 dsieger 1749: <p>After you've installed packages, be sure to have
1750: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1751: <code class="varname">PATH</code> so you can actually start the just
1752: installed program.</p>
1753: </div>
1754: <div class="sect2" lang="en">
1755: <div class="titlepage"><div><div><h3 class="title">
1756: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1757: <p>To deinstall a package, it does not matter whether it was
1758: installed from source code or from a binary package. The
1.10 hubertf 1759: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1760: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1761: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1762: name can be given with or without version number. Wildcards can
1763: also be used to deinstall a set of packages, for example
1764: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1765: so that the shell does not expand them before
1766: <code class="literal">pkg_delete</code> sees them.</p>
1767: <p>The <code class="option">-r</code> option is very powerful: it
1768: removes all the packages that require the package in question
1769: and then removes the package itself. For example:
1770:
1771: </p>
1772: <pre class="screen">
1773: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1774: </pre>
1775: <p>
1776:
1777: will remove jpeg and all the packages that used it; this allows
1778: upgrading the jpeg package.</p>
1779: </div>
1780: <div class="sect2" lang="en">
1781: <div class="titlepage"><div><div><h3 class="title">
1782: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1783: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1784: installed packages or binary package files.</p>
1785: </div>
1786: <div class="sect2" lang="en">
1787: <div class="titlepage"><div><div><h3 class="title">
1788: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1789: <p>
1790: The NetBSD Security-Officer and Packages Groups maintain a list of
1791: known security vulnerabilities to packages which are (or have been)
1792: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1793: 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 1794: </p>
1795: <p>
1796: Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1797: this list can be downloaded
1798: automatically, and a security audit of all packages installed on a system
1799: can take place.
1800: </p>
1801: <p>
1802: There are two components to
1803: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>. The first
1804: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
1805: the list of vulnerabilities from the NetBSD FTP site. The second
1806: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
1807: installed packages are vulnerable. If a package is vulnerable, you
1808: will see output similar to the following:
1809: </p>
1810: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1811: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1812: <p>
1813: One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.10 hubertf 1814: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.1 dsieger 1815: file daily, and include a package audit in the daily security script.
1.10 hubertf 1816: Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.1 dsieger 1817: file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1818: </p>
1819: </div>
1820: <div class="sect2" lang="en">
1821: <div class="titlepage"><div><div><h3 class="title">
1822: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1823: <p>
1824: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
1.10 hubertf 1825: <span class="command"><strong>lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
1.1 dsieger 1826: argument to check if your packages are up-to-date, e.g.
1827: </p>
1828: <pre class="screen">
1829: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1830: ...
1831: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1832: </pre>
1.10 hubertf 1833: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1834: package on your system and rebuild any dependencies.
1835: </p>
1836: </div>
1837: <div class="sect2" lang="en">
1838: <div class="titlepage"><div><div><h3 class="title">
1839: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1840: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1841: administrative functions on the package system.</p>
1842: </div>
1843: <div class="sect2" lang="en">
1844: <div class="titlepage"><div><div><h3 class="title">
1845: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1846: <p>Please pay very careful attention to the warnings
1.10 hubertf 1847: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1 dsieger 1848: inherent dangers of installing binary packages which you did
1849: not create yourself, and the security holes that can be
1850: introduced onto your system by indiscriminate adding of such
1851: files.</p>
1852: <p>The same warning of course applies to every package you
1853: install from source when you haven't completely read and
1854: understood the source code of the package, the compiler that
1855: is used to build the package and all the other tools that are
1856: involved.</p>
1857: </div>
1858: </div>
1859: <div class="sect1" lang="en">
1860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1861: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1862: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1863: directory now contains a set of packages, organized into
1864: categories. You can browse the online index of packages, or run
1.10 hubertf 1865: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1866: directory to build local <code class="filename">README.html</code> files for
1867: 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>
1868: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1869: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1870: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1871: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1872: different <code class="varname">LOCALBASE</code> definitions on the same
1873: system (inside a chroot is an exception). </p>
1874: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1875: 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 1876: instructions how to create your own packages.</p>
1877: <div class="sect2" lang="en">
1878: <div class="titlepage"><div><div><h3 class="title">
1879: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1880: <p>To build packages from source, you need a working C
1881: compiler. On NetBSD, you need to install the
1882: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
1883: sets. If you want to build X11-related packages, the
1884: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
1885: sets are required, too.</p>
1886: </div>
1887: <div class="sect2" lang="en">
1888: <div class="titlepage"><div><div><h3 class="title">
1889: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1890: <p>The first step for building a package is downloading the
1891: distfiles (i.e. the unmodified source). If they have not yet been
1892: downloaded, pkgsrc will fetch them automatically.</p>
1893: <p>If you have all files that you need in the
1894: <code class="filename">distfiles</code> directory,
1895: you don't need to connect. If the distfiles are on CD-ROM, you can
1896: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1897: </p>
1898: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1899: <p>
1.10 hubertf 1900: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1901: <p>By default a list of distribution sites will be randomly
1902: intermixed to prevent huge load on servers which holding popular
1903: packages (for example, SourceForge.net mirrors). Thus, every
1904: time when you need to fetch yet another distfile all the mirrors
1905: will be tried in new (random) order. You can turn this feature
1906: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1907: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1908: <p>You can overwrite some of the major distribution sites to
1909: fit to sites that are close to your own. By setting one or two
1910: variables you can modify the order in which the master sites are
1911: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1912: delimited list of domain suffixes.
1913: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1914: contains a whitespace delimited list of regular expressions. It
1915: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1916: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1917: some examples. This may save some of your bandwidth and
1918: time.</p>
1919: <p>You can change these settings either in your shell's environment, or,
1920: if you want to keep the settings, by editing the
1.10 hubertf 1921: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1922: and adding the definitions there.</p>
1923: <p>
1924: If a package depends on many other packages (such as
1925: <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
1926: alternate between periods of
1927: downloading source, and compiling. To ensure you have all the source
1928: downloaded initially you can run the command:
1929: </p>
1930: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1931: <p>
1932: which will output and run a set of shell commands to fetch the
1933: necessary files into the <code class="filename">distfiles</code> directory. You can
1934: also choose to download the files manually.
1935: </p>
1936: </div>
1937: <div class="sect2" lang="en">
1938: <div class="titlepage"><div><div><h3 class="title">
1939: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1940: <p>
1941: Once the software has downloaded, any patches will be applied, then it
1942: will be compiled for you. This may take some time depending on your
1943: computer, and how many other packages the software depends on and their
1944: compile time.
1945: </p>
1946: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1947: <h3 class="title">Note</h3>
1948: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1949: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.1 dsieger 1950: “<span class="quote">make</span>” in the examples in this guide.</p>
1951: </div>
1952: <p>For example, type</p>
1953: <pre class="screen">
1954: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1955: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1956: </pre>
1957: <p>at the shell prompt to build the various components of the
1958: package.</p>
1959: <p>The next stage is to actually install the newly compiled
1960: program onto your system. Do this by entering:
1961:
1962: </p>
1963: <pre class="screen">
1964: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1965: </pre>
1966: <p>
1967:
1968: while you are still in the directory for whatever package you
1969: are installing.</p>
1970: <p>Installing the package on your system may require you to
1971: be root. However, pkgsrc has a
1972: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1973: to only become root for the actual installation step.</p>
1974: <p>That's it, the software should now be installed and setup for use.
1975: You can now enter:
1976:
1977: </p>
1978: <pre class="screen">
1979: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1980: </pre>
1981: <p>
1982:
1983: to remove the compiled files in the work directory, as you shouldn't need
1984: them any more. If other packages were also added to your system
1985: (dependencies) to allow your program to compile, you can tidy these up
1986: also with the command:</p>
1987: <pre class="screen">
1988: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1989: </pre>
1990: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 1991: 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 1992: <p>The program is installed under the default root of the
1993: packages tree - <code class="filename">/usr/pkg</code>. Should this not
1994: conform to your tastes, set the <code class="varname">LOCALBASE</code>
1995: variable in your environment, and it will use that value as the
1996: root of your packages tree. So, to use
1997: <code class="filename">/usr/local</code>, set
1998: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1999: Please note that you should use a directory which is dedicated to
2000: packages and not shared with other programs (i.e., do not try and
2001: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2002: to add any of your own files or directories (such as
2003: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2004: <code class="filename">pkgsrc/</code>) below the
2005: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2006: conflicts between programs and other files installed by the
2007: package system and whatever else may have been installed
2008: there.</p>
1.10 hubertf 2009: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2010: alter some configuration options at build time. Have a look at
2011: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2012: of what will be set there by default. Environment variables such
2013: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2014: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2015: set them each time you want to use pkgsrc.</p>
2016: <p>Occasionally, people want to “<span class="quote">look under the
2017: covers</span>” to see what is going on when a package is building
2018: or being installed. This may be for debugging purposes, or out of
2019: simple curiosity. A number of utility values have been added to
2020: help with this.</p>
2021: <div class="orderedlist"><ol type="1">
2022: <li>
1.10 hubertf 2023: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 2024: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2025: information will be displayed. For example,</p>
2026: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2027: <p>will show all the commands that are invoked, up to and
2028: including the “<span class="quote">patch</span>” stage.</p>
2029: </li>
2030: <li>
1.10 hubertf 2031: <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-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2032: definition, then the <code class="varname">VARNAME</code> definition
2033: should be used, in conjunction with the show-var
1.10 hubertf 2034: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2035: variable <code class="varname">LOCALBASE</code>:</p>
2036: <pre class="screen">
2037: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2038: /usr/pkg
2039: <code class="prompt">%</code>
2040: </pre>
2041: </li>
2042: </ol></div>
2043: <p>If you want to install a binary package that you've either
2044: created yourself (see next section), that you put into
2045: pkgsrc/packages manually or that is located on a remote FTP
2046: server, you can use the "bin-install" target. This target will
1.10 hubertf 2047: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
2048: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2049: sites searched is kept in the variable
2050: <code class="varname">BINPKG_SITES</code>, which defaults to
1.10 hubertf 2051: 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-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 2052: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2053: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2054: details.</p>
2055: <p>A final word of warning: If you set up a system that has a
2056: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2057: set that before any packages are installed, as you cannot use
2058: several directories for the same purpose. Doing so will result in
2059: pkgsrc not being able to properly detect your installed packages,
2060: and fail miserably. Note also that precompiled binary packages are
2061: usually built with the default <code class="varname">LOCALBASE</code> of
2062: <code class="filename">/usr/pkg</code>, and that you should
2063: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2064: <code class="varname">LOCALBASE</code>.</p>
2065: </div>
2066: </div>
2067: </div>
2068: <div class="chapter" lang="en">
2069: <div class="titlepage"><div><div><h2 class="title">
2070: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2071: <div class="toc">
2072: <p><b>Table of Contents</b></p>
2073: <dl>
2074: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2075: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2076: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2077: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2078: <dd><dl>
1.4 rillig 2079: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2080: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2081: <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 2082: </dl></dd>
1.4 rillig 2083: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2084: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2085: </dl>
2086: </div>
1.4 rillig 2087: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2088: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2089: that file depends on the installation. On NetBSD, when you use
1.10 hubertf 2090: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 2091: <code class="filename">/etc/</code>. In all other cases the default location is
2092: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2093: bootstrap program to install the binary packages.</p>
2094: <p>During the bootstrap, an example configuration file is created. To
2095: use that, you have to create the directory
2096: <code class="filename">${PREFIX}/etc</code> and copy the example file
2097: there.</p>
2098: <p>The format of the configuration file is that of the usual
2099: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2100: is done by setting variables in this file. Note that you can define all
2101: kinds of variables, and no special error checking (for example for
2102: spelling mistakes) takes place, so you have to try it out to see if it
2103: works.</p>
2104: <div class="sect1" lang="en">
2105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2106: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2107: <p>In this section, you can find some variables that apply to all
2108: pkgsrc packages. A complete list of the variables that can be
2109: configured by the user is available in
2110: <code class="filename">mk/defaults/mk.conf</code>, together with some
2111: comments that describe each variable's intent.</p>
2112: <div class="itemizedlist"><ul type="disc">
2113: <li><p><code class="varname">LOCALBASE</code>: Where
2114: packages will be installed. The default is
2115: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2116: with different <code class="varname">LOCALBASE</code>s!</p></li>
2117: <li><p><code class="varname">CROSSBASE</code>: Where
2118: “<span class="quote">cross</span>” category packages will be
2119: installed. The default is
2120: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
2121: <li><p><code class="varname">X11BASE</code>: Where
2122: X11 is installed on the system. The default is
2123: <code class="filename">/usr/X11R6</code>.</p></li>
2124: <li><p><code class="varname">DISTDIR</code>: Where to store the
2125: downloaded copies of the original source distributions used
2126: for building pkgsrc packages. The default is
2127: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
2128: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2129: database about installed packages is stored. The default is
2130: <code class="filename">/var/db/pkg</code>.</p></li>
2131: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2132: If set, override the packages'
2133: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2134: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2135: Backup location(s) for distribution files and patch files
2136: if not found locally or in
2137: <code class="filename">${MASTER_SITES}</code> or
2138: <code class="filename">${PATCH_SITES}</code> respectively.
2139: The defaults are
2140: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
2141: and
2142: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
2143: <li><p><code class="varname">BINPKG_SITES</code>:
2144: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2145: <em class="replaceable"><code>arch</code></em> are replaced with OS
2146: release (“<span class="quote">2.0</span>”, etc.) and architecture
2147: (“<span class="quote">mipsel</span>”, etc.).</p></li>
2148: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2149: List of acceptable licenses. Whenever you try to build a package
2150: whose license is not in this list, you will get an error message
2151: that includes instructions on how to change this variable.</p></li>
2152: </ul></div>
2153: </div>
2154: <div class="sect1" lang="en">
2155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2156: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2157: <p>XXX
2158: </p>
2159: <div class="itemizedlist"><ul type="disc">
2160: <li><p><code class="varname">PACKAGES</code>: The top level
2161: directory for the binary packages. The default is
2162: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
2163: <li><p><code class="varname">WRKOBJDIR</code>:
2164: The top level directory where, if defined, the separate
2165: working directories will get created, and symbolically
2166: linked to from <code class="filename">${WRKDIR}</code> (see below).
2167: This is useful for building packages on several
2168: architectures, then <code class="filename">${PKGSRCDIR}</code>
2169: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2170: is local to every architecture. (It should be noted that
2171: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.11 ! rillig 2172: — it is an internal definition which refers to the
1.1 dsieger 2173: root of the pkgsrc tree. It is possible to have many
2174: pkgsrc tree instances.)</p></li>
2175: <li><p><code class="varname">LOCALPATCHES</code>:
2176: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2177: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2178: information.</p></li>
2179: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2180: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2181: BSD-style Makefile. If this is not set,
2182: <code class="varname">MAKECONF</code> is set to
2183: <code class="filename">/dev/null</code> to avoid picking up
2184: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
2185: <li><p><code class="varname">DEPENDS_TARGET</code>:
2186: By default, dependencies are only installed, and no binary
2187: package is created for them. You can set this variable to
2188: <code class="literal">package</code> to automatically create binary
2189: packages after installing dependencies.</p></li>
2190: </ul></div>
2191: </div>
2192: <div class="sect1" lang="en">
2193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2194: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.4 rillig 2195: <p>A growing number of packages support installation into a
2196: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2197: to be built, before the actual filesystem is touched. DESTDIR
2198: support exists in two variations:</p>
2199: <div class="itemizedlist"><ul type="disc">
2200: <li><p>Basic DESTDIR support means that the package
2201: installation and packaging is still run as
2202: root.</p></li>
2203: <li><p>Full DESTDIR support can run the complete build,
2204: installation and packaging as normal user. Root privileges are
2205: only needed to add packages.</p></li>
2206: </ul></div>
2207: <p>To use the DESTDIR support, set either
2208: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2209: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2210: get the full support with fallback to basic
2211: support. <code class="varname">USE_DESTDIR=full</code> needs <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> version 20070802 (or
2212: newer). It might become the default DESTDIR support later.</p>
2213: <p>DESTDIR support changes the behaviour of various targets
2214: slightly. To install a package after building it, use
2215: <code class="literal">package-install</code>. <code class="literal">package</code> and
2216: <code class="literal">install</code> don't do that any
2217: longer. <code class="literal">package-install</code> can be used as
2218: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2219: will ask for the root password to install the package and fail,
2220: <code class="literal">package-install</code> will ask again.</p>
2221: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2222: clean</code></strong> needs to be run as root.</p>
2223: </div>
2224: <div class="sect1" lang="en">
2225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2226: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.1 dsieger 2227: <div class="sect2" lang="en">
2228: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2229: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2230: <p>By default, pkgsrc will use GCC to build packages. This may be
2231: overridden by setting the following variables in /etc/mk.conf:</p>
2232: <div class="variablelist"><dl>
2233: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2234: <dd>
2235: <p>This is a list of values specifying the chain of
2236: compilers to invoke when building packages. Valid values
2237: are:</p>
2238: <div class="itemizedlist"><ul type="disc">
2239: <li><p><code class="varname">distcc</code>:
2240: distributed C/C++ (chainable)</p></li>
2241: <li><p><code class="varname">ccache</code>:
2242: compiler cache (chainable)</p></li>
2243: <li><p><code class="varname">gcc</code>:
2244: GNU C/C++ Compiler</p></li>
2245: <li><p><code class="varname">mipspro</code>:
2246: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2247: <li><p><code class="varname">mipspro</code>:
2248: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2249: <li><p><code class="varname">sunpro</code>:
2250: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2251: </ul></div>
2252: <p>The default is
2253: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2254: <code class="varname">ccache</code> and/or
2255: <code class="varname">distcc</code> with an appropriate
2256: <code class="varname">PKGSRC_COMPILER</code> setting,
2257: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
2258: variable should always be terminated with a value for
2259: a real compiler. Note that only one real compiler
2260: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2261: is not allowed).</p>
2262: </dd>
2263: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2264: <dd><p>This specifies the minimum version of GCC to use
2265: when building packages. If the system GCC doesn't
2266: satisfy this requirement, then pkgsrc will build and
2267: install one of the GCC packages to use instead.</p></dd>
2268: </dl></div>
2269: </div>
2270: <div class="sect2" lang="en">
2271: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2272: <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 2273: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2274: please make sure to use the <code class="literal">+=</code> operator
2275: instead of the <code class="literal">=</code> operator:</p>
2276: <pre class="programlisting">
2277: CFLAGS+= -your -flags
2278: </pre>
2279: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2280: “<span class="quote">+</span>”) may lead to problems with packages that need
2281: to add their own flags. Also, you may want to take a look at
2282: the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a> package if
2283: you're interested in optimization for the current CPU.</p>
2284: </div>
2285: <div class="sect2" lang="en">
2286: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2287: <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 2288: <p>If you want to pass flags to the linker, both in the configure
2289: step and the build step, you can do this in two ways. Either set
2290: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2291: between the two is that <code class="varname">LIBS</code> will be appended to
2292: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2293: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2294: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2295: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2296: <code class="varname">CFLAGS</code>, if you do not wish to override these
2297: settings, use the <code class="literal">+=</code> operator:</p>
2298: <pre class="programlisting">
2299: LDFLAGS+= -your -linkerflags
2300: </pre>
2301: </div>
2302: </div>
2303: <div class="sect1" lang="en">
2304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2305: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2306: <p>XXX
2307: </p>
2308: <div class="itemizedlist"><ul type="disc">
2309: <li>
2310: <p><code class="varname">PKG_DEVELOPER</code>:
2311: Run some sanity checks that package developers want:
2312: </p>
2313: <div class="itemizedlist"><ul type="circle">
2314: <li><p>make sure patches apply with zero
2315: fuzz</p></li>
2316: <li><p>run check-shlibs to see that all
2317: binaries will find their shared libs.</p></li>
2318: </ul></div>
2319: <p>
2320: </p>
2321: </li>
2322: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2323: of debugging output which is displayed whilst making and
2324: installing the package. The default value for this is 0,
2325: which will not display the commands as they are executed
2326: (normal, default, quiet operation); the value 1 will display
2327: all shell commands before their invocation, and the value 2
2328: will display both the shell commands before their invocation,
1.10 hubertf 2329: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2330: -x</strong></span> will be displayed.</p></li>
2331: </ul></div>
2332: <p>
2333: </p>
2334: </div>
2335: <div class="sect1" lang="en">
2336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2337: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2338: <p>Some packages have build time options, usually to select
2339: between different dependencies, enable optional support for big
2340: dependencies or enable experimental features.</p>
2341: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2342: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2343: show-options</strong></span>, for example:</p>
2344: <pre class="programlisting">
2345: The following options are supported by this package:
2346: ssl Enable SSL support.
2347: Exactly one of the following gecko options is required:
2348: firefox Use firefox as gecko rendering engine.
2349: mozilla Use mozilla as gecko rendering engine.
2350: At most one of the following database options may be selected:
2351: mysql Enable support for MySQL database.
2352: pgsql Enable support for PostgreSQL database.
2353:
2354: These options are enabled by default: firefox
2355: These options are currently enabled: mozilla ssl
2356: </pre>
2357: <p>The following variables can be defined in
1.10 hubertf 2358: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2359: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2360: which can be used to select or disable options for all packages
2361: that support them, and
2362: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2363: which can be used to select or disable options specifically for
2364: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2365: these variables are selected, options preceded by “<span class="quote">-</span>”
2366: are disabled. A few examples:</p>
2367: <pre class="screen">
1.10 hubertf 2368: <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 2369: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2370: PKG_OPTIONS.kdebase= debug -sasl
2371: PKG_OPTIONS.apache= suexec </pre>
1.11 ! rillig 2372: <p>It is important to note that options that were specifically
! 2373: suggested by the package maintainer must be explicitely removed if
! 2374: you do not wish to include the option. If you are unsure you can view
! 2375: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2376: <p>The following settings are consulted in the order given, and
2377: the last setting that selects or disables an option is
2378: used:</p>
2379: <div class="orderedlist"><ol type="1">
2380: <li><p>the default options as suggested by the package
2381: maintainer</p></li>
2382: <li><p>the options implied by the settings of legacy
2383: variables (see below)</p></li>
2384: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2385: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2386: </ol></div>
2387: <p>For groups of mutually exclusive options, the last option
2388: selected is used, all others are automatically disabled. If an
2389: option of the group is explicitly disabled, the previously
2390: selected option, if any, is used. It is an error if no option
2391: from a required group of options is selected, and building the
2392: package will fail.</p>
2393: <p>Before the options framework was introduced, build options
2394: were selected by setting a variable (often named
2395: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2396: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2397: transition to the options framework for the user, these legacy
2398: variables are converted to the appropriate options setting
2399: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2400: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2401: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2402: directly. Support for the legacy variables will be removed
2403: eventually.</p>
2404: </div>
2405: </div>
2406: <div class="chapter" lang="en">
2407: <div class="titlepage"><div><div><h2 class="title">
2408: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2409: <div class="toc">
2410: <p><b>Table of Contents</b></p>
2411: <dl>
2412: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2413: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2414: </dl>
2415: </div>
2416: <div class="sect1" lang="en">
2417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2418: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2419: <p>Once you have built and installed a package, you can create
2420: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.10 hubertf 2421: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2422: the same package on a group of hosts and wasting CPU time. It also
2423: provides a simple means for others to install your package, should
2424: you distribute it.</p>
2425: <p>To create a binary package, change into the appropriate
1.10 hubertf 2426: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2427: package</strong></span>:</p>
2428: <pre class="screen">
2429: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2430: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2431: </pre>
2432: <p>This will build and install your package (if not already done),
2433: and then build a binary package from what was installed. You can
1.10 hubertf 2434: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2435: it. Binary packages are created by default in
2436: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2437: 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 2438: 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 2439: <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 2440: such a binary package.</p>
2441: </div>
2442: <div class="sect1" lang="en">
2443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2444: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2445: <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 2446: </div>
2447: </div>
2448: <div class="chapter" lang="en">
2449: <div class="titlepage"><div><div><h2 class="title">
2450: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2451: builds)</h2></div></div></div>
2452: <div class="toc">
2453: <p><b>Table of Contents</b></p>
2454: <dl>
2455: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2456: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2457: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2458: <dd><dl>
2459: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2460: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2461: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2462: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2463: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2464: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2465: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2466: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2467: </dl></dd>
2468: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
2469: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
2470: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2471: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2472: </dl>
2473: </div>
2474: <p>When you have multiple machines that should run the same packages,
2475: it is wasted time if they all build their packages themselves from
2476: source. There are two ways of getting a set of binary packages: The old
2477: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2478: system. This chapter describes how to set them up so that the packages
2479: are most likely to be usable later.</p>
2480: <div class="sect1" lang="en">
2481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2482: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2483: <p>Since a bulk build takes several days or even weeks to finish, you
2484: should think about the setup before you start everything. Pay attention
2485: to at least the following points:</p>
2486: <div class="itemizedlist"><ul type="disc">
2487: <li>
2488: <p>If you want to upload the binary packages to
2489: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2490: packages:</p>
2491: <div class="itemizedlist"><ul type="circle">
2492: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2493: by a NetBSD developer on a trusted machine (that is, where you and only
2494: you have root access).</p></li>
2495: <li><p>Packages on ftp.NetBSD.org should only be created from
2496: the stable branches (like 2007Q1), so that users browsing the available
2497: collections can see at a glance how old the packages
2498: are.</p></li>
2499: <li><p>The packages must be built as root, since some packages
2500: require set-uid binaries at runtime, and creating those packages as
2501: unprivileged user doesn't work well at the moment.</p></li>
2502: </ul></div>
2503: </li>
2504: <li><p>Make sure that the bulk build cannot break anything in
2505: your system. Most bulk builds run as root, so they should be run at least
2506: in a chroot environment or something even more restrictive, depending on
2507: what the operating system provides. There have been numerous cases where
2508: certain packages tried to install files outside the
2509: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2510: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2511: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2512: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2513: that you don't need any package during the build.</p></li>
2514: </ul></div>
2515: </div>
2516: <div class="sect1" lang="en">
2517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2518: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2519: <p>A complete bulk build requires lots of disk space. Some of the
2520: disk space can be read-only, some other must be writable. Some can be on
2521: remote filesystems (such as NFS) and some should be local. Some can be
2522: temporary filesystems, others must survive a sudden reboot.</p>
2523: <div class="itemizedlist"><ul type="disc">
2524: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2525: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2526: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2527: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2528: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2529: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2530: </ul></div>
1.1 dsieger 2531: </div>
2532: <div class="sect1" lang="en">
2533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2534: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
2535: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2536: <h3 class="title">Warning</h3>
2537: <p>The rest of this section is rather old. Don't rely on it
2538: too much.</p>
2539: </div>
1.1 dsieger 2540: <div class="sect2" lang="en">
2541: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2542: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.1 dsieger 2543: <div class="sect3" lang="en">
2544: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2545: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1 dsieger 2546: </h4></div></div></div>
2547: <p>The <code class="filename">build.conf</code> file is the main
2548: configuration file for bulk builds. You can configure how your
2549: copy of pkgsrc is kept up to date, how the distfiles are
2550: downloaded, how the packages are built and how the report is
2551: generated. You can find an annotated example file in
2552: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2553: it, copy <code class="filename">build.conf-example</code> to
2554: <code class="filename">build.conf</code> and edit it, following the
2555: comments in that file.</p>
2556: </div>
2557: <div class="sect3" lang="en">
2558: <div class="titlepage"><div><div><h4 class="title">
1.10 hubertf 2559: <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 2560: </h4></div></div></div>
1.10 hubertf 2561: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1 dsieger 2562: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2563: details of the default settings. You will want to ensure that
2564: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2565: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.4 rillig 2566: completely bypasses the license check.</p>
1.1 dsieger 2567: <pre class="programlisting">
2568: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2569: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2570: BSDSRCDIR= /usr/src
2571: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2572: OBJHOSTNAME?= yes # use work.`hostname`
2573: FAILOVER_FETCH= yes # insist on the correct checksum
2574: PKG_DEVELOPER?= yes
2575: _ACCEPTABLE= yes
2576: </pre>
2577: <p>Some options that are especially useful for bulk builds
2578: can be found at the top lines of the file
2579: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2580: options of these are briefly described here.</p>
2581: <div class="itemizedlist"><ul type="disc">
2582: <li><p>If you are on a slow machine, you may want to
2583: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2584: “<span class="quote">no</span>”.</p></li>
2585: <li><p>If you are doing bulk builds from a read-only
2586: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2587: to the directory where all log files are created. Otherwise the
2588: log files are created in the pkgsrc directory.</p></li>
2589: <li><p>Another important variable is
2590: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2591: should be always available while building other
2592: packages.</p></li>
2593: </ul></div>
2594: <p>Some other options are scattered in the pkgsrc
2595: infrastructure:</p>
2596: <div class="itemizedlist"><ul type="disc">
2597: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2598: should be set to <code class="literal">yes</code>. The purpose of the bulk
2599: builds is creating binary packages, no matter if they are
2600: vulnerable or not. When uploading the packages to a public
2601: server, the vulnerable packages will be put into a directory of
2602: their own. Leaving this variable unset would prevent the bulk
2603: build system from even trying to build them, so possible
2604: building errors would not show up.</p></li>
2605: <li><p><code class="varname">CHECK_FILES</code>
2606: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
2607: “<span class="quote">yes</span>” to check that the installed set of files
2608: matches the <code class="filename">PLIST</code>.</p></li>
2609: <li><p><code class="varname">CHECK_INTERPRETER</code>
2610: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
2611: “<span class="quote">yes</span>” to check that the installed
2612: “<span class="quote">#!</span>”-scripts will find their
2613: interpreter.</p></li>
2614: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2615: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2616: package's self-test before installing it. Note that some
2617: packages make heavy use of “<span class="quote">good</span>” random
2618: numbers, so you need to assure that the machine on which you
2619: are doing the bulk builds is not completely idle. Otherwise
2620: some test programs will seem to hang, while they are just
2621: waiting for new random data to be
2622: available.</p></li>
2623: </ul></div>
2624: </div>
2625: <div class="sect3" lang="en">
2626: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2627: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1 dsieger 2628: </h4></div></div></div>
2629: <p>It is possible to configure the bulk build to perform
2630: certain site-specific tasks at the end of the pre-build
2631: stage. If the file
2632: <code class="filename">pre-build.local</code> exists in
2633: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.10 hubertf 2634: (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.1 dsieger 2635: stage. An example use of
2636: <code class="filename">pre-build.local</code> is to have the line:</p>
2637: <pre class="screen">echo "I do not have enough disk space to build this pig." \
2638: > misc/openoffice/$BROKENF</pre>
2639: <p>to prevent the system from trying to build a particular package
2640: which requires nearly 3 GB of disk space.</p>
2641: </div>
2642: </div>
2643: <div class="sect2" lang="en">
2644: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2645: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1 dsieger 2646: <p>As <code class="filename">/usr/pkg</code> will be completely
2647: deleted at the start of bulk builds, make sure your login
2648: shell is placed somewhere else. Either drop it into
2649: <code class="filename">/usr/local/bin</code> (and adjust your login
2650: shell in the passwd file), or (re-)install it via
1.10 hubertf 2651: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.1 dsieger 2652: you can login after a reboot (remember that your current
2653: process won't die if the package is removed, you just can't
2654: start any new instances of the shell any more). Also, if you
2655: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2656: version of ssh for some reason, be sure to install ssh before
2657: starting it from <code class="filename">rc.local</code>:</p>
2658: <pre class="programlisting">
2659: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2660: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2661: /usr/pkg/etc/rc.d/sshd
2662: fi
2663: </pre>
2664: <p>Not doing so will result in you being not able to log in
2665: via ssh after the bulk build is finished or if the machine
2666: gets rebooted or crashes. You have been warned! :)</p>
2667: </div>
2668: <div class="sect2" lang="en">
2669: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2670: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1 dsieger 2671: <p>Make sure you don't need any of the packages still
2672: installed.</p>
2673: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2674: <h3 class="title">Warning</h3>
2675: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2676: configuration files and some more files from
2677: <code class="filename">/var</code>, <code class="filename">/home</code> and
2678: possibly other locations will be removed! So don't run a bulk
2679: build with privileges that might harm your
2680: system.</em></span></p>
2681: </div>
2682: <p>Be sure to remove all other things that might
2683: interfere with builds, like some libs installed in
2684: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2685: <pre class="screen">
2686: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2687: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2688: </pre>
2689: <p>If for some reason your last build didn't complete (power
2690: failure, system panic, ...), you can continue it by
2691: running:</p>
2692: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2693: <p>At the end of the bulk build, you will get a summary via mail,
2694: and find build logs in the directory specified by
2695: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2696: file.</p>
2697: </div>
2698: <div class="sect2" lang="en">
2699: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2700: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1 dsieger 2701: <p>The bulk builds consist of three steps:</p>
2702: <div class="variablelist"><dl>
2703: <dt><span class="term">1. pre-build</span></dt>
2704: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2705: cleans out any broken distfiles, and removes all
2706: packages installed.</p></dd>
2707: <dt><span class="term">2. the bulk build</span></dt>
2708: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2709: an optimised order in which packages will be
2710: built. Packages that don't require other packages will
2711: be built first, and packages with many dependencies will
2712: be built later.</p></dd>
2713: <dt><span class="term">3. post-build</span></dt>
2714: <dd><p>Generates a report that's placed in the directory
2715: specified in the <code class="filename">build.conf</code> file
2716: named <code class="filename">broken.html</code>, a short version
2717: of that report will also be mailed to the build's
2718: admin.</p></dd>
2719: </dl></div>
2720: <p>During the build, a list of broken packages will be compiled
2721: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2722: <code class="filename">.../.broken.${MACHINE}</code> if
2723: <code class="varname">OBJMACHINE</code> is set), individual build logs
2724: of broken builds can be found in the package's
2725: directory. These files are used by the bulk-targets to mark
2726: broken builds to not waste time trying to rebuild them, and
2727: they can be used to debug these broken package builds
2728: later.</p>
2729: </div>
2730: <div class="sect2" lang="en">
2731: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2732: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1 dsieger 2733: <p>Currently, roughly the following requirements are valid for
2734: NetBSD 2.0/i386:</p>
2735: <div class="itemizedlist"><ul type="disc">
2736: <li><p>10 GB - distfiles (NFS ok)</p></li>
2737: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2738: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2739: </ul></div>
2740: <p>Note that all pkgs will be de-installed as soon as they are
2741: turned into a binary package, and that sources are removed,
2742: so there is no excessively huge demand to disk
2743: space. Afterwards, if the package is needed again, it will
1.10 hubertf 2744: be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.1 dsieger 2745: there are no cycles wasted by recompiling.</p>
2746: </div>
2747: <div class="sect2" lang="en">
2748: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2749: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1 dsieger 2750: <p>If you don't want all the packages nuked from a machine
2751: (rendering it useless for anything but pkg compiling), there
2752: is the possibility of doing the package bulk build inside a
2753: chroot environment.</p>
2754: <p>The first step is to set up a chroot sandbox,
2755: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2756: using null mounts, or manually.</p>
2757: <p>There is a shell script called
2758: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2759: up the sandbox environment using null mounts. It will also
2760: create a script called <code class="filename">sandbox</code> in the
2761: root of the sandbox environment, which will allow the null
1.10 hubertf 2762: mounts to be activated using the <span class="command"><strong>sandbox
1.1 dsieger 2763: mount</strong></span> command and deactivated using the
1.10 hubertf 2764: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1 dsieger 2765: <p>To set up a sandbox environment by hand, after extracting all
1.10 hubertf 2766: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1 dsieger 2767: distribution DESTDIR=/usr/sandbox</strong></span> in
2768: <code class="filename">/usr/src/etc</code>, be sure the following items
2769: are present and properly configured:</p>
2770: <div class="procedure"><ol type="1">
2771: <li>
2772: <p>Kernel</p>
2773: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2774: </li>
2775: <li>
2776: <p><code class="filename">/dev/*</code></p>
2777: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2778: </li>
2779: <li>
2780: <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>
2781: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2782: </li>
2783: <li>
2784: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2785: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2786: </li>
2787: <li>
2788: <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>
2789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2790: </li>
2791: <li>
2792: <p><code class="filename">/usr/src</code> (system sources,
1.11 ! rillig 2793: 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 2794: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2795: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2796: </li>
2797: <li>
2798: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2800: </li>
2801: <li>
2802: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
2803: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2804: </li>
2805: <li>
2806: <p>Checkout pkgsrc via cvs into
2807: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2808: <pre class="screen">
2809: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2810: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2811: </pre>
2812: <p>Do not mount/link this to the copy of your pkgsrc tree
2813: you do development in, as this will likely cause problems!</p>
2814: </li>
2815: <li><p>Make
2816: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2817: <code class="filename">.../distfiles</code> point somewhere
2818: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.10 hubertf 2819: <li><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>
1.1 dsieger 2820: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
2821: </ol></div>
2822: <p>When the chroot sandbox is set up, you can start
2823: the build with the following steps:</p>
2824: <pre class="screen">
2825: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2826: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2827: </pre>
2828: <p>This will just jump inside the sandbox and start building. At
2829: the end of the build, mail will be sent with the results of
2830: the build. Created binary pkgs will be in
2831: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2832: (wherever that points/mounts to/from).</p>
2833: </div>
2834: <div class="sect2" lang="en">
2835: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2836: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1 dsieger 2837: <p>In addition to building a complete set of all packages in
2838: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2839: may be used to build a subset of the packages contained in
2840: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.10 hubertf 2841: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.1 dsieger 2842: <div class="itemizedlist"><ul type="disc">
2843: <li><p>SITE_SPECIFIC_PKGS</p></li>
2844: <li><p>HOST_SPECIFIC_PKGS</p></li>
2845: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2846: <li><p>USER_SPECIFIC_PKGS</p></li>
2847: </ul></div>
2848: <p>will define the set of packages which should be built.
2849: The bulk build code will also include any packages which are
2850: needed as dependencies for the explicitly listed packages.</p>
2851: <p>One use of this is to do a bulk build with
2852: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2853: periodically to have a complete set of the binary packages
2854: needed for your site available without the overhead of
2855: building extra packages that are not needed.</p>
2856: </div>
2857: <div class="sect2" lang="en">
2858: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2859: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1 dsieger 2860: <p>This section describes how pkgsrc developers can upload binary
2861: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2862: <p>If you would like to automatically create checksum files for the
2863: binary packages you intend to upload, remember to set
2864: <code class="varname">MKSUMS=yes</code> in your
2865: <code class="filename">mk/bulk/build.conf</code>.</p>
2866: <p>If you would like to PGP sign the checksum files (highly
2867: recommended!), remember to set
2868: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2869: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2870: your GPG password to sign the files before uploading everything.</p>
2871: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2872: set properly in your <code class="filename">mk/bulk/build.conf</code>
2873: file, i.e. adjust it to something like one of the following:</p>
2874: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
2875: <p>Please use appropriate values for "packages-200xQy",
2876: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2877: is different from your local login, write your login directly
2878: into the variable, e.g. my local account is "feyrer", but for my
2879: login "hubertf", I use:</p>
2880: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
2881: <p>A separate <code class="filename">upload</code> directory is used
2882: here to allow "closing" the directory during upload. To do
2883: so, run the following command on ftp.NetBSD.org next:</p>
2884: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
2885: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2886: only appropriate for packages for the NetBSD operating
2887: system. Binary packages for other operating systems should go
2888: into <code class="filename">/pub/pkgsrc</code>.</p>
2889: <p>Before uploading the binary pkgs, ssh authentication needs
2890: to be set up. This example shows how to set up temporary keys
2891: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2892: (assuming that no keys should be present there usually):</p>
2893: <pre class="screen">
2894: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
2895: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2896: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
2897: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2898: </pre>
2899: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2900: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2901: file on ftp.NetBSD.org. You can remove the key after the
2902: upload is done!</p>
2903: <p>Next, test if your ssh connection really works:</p>
2904: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
2905: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2906: <p>Now after all this works, you can exit the sandbox and start
2907: the upload:</p>
2908: <pre class="screen">
2909: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
2910: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2911: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2912: </pre>
1.10 hubertf 2913: <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-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
2914: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.1 dsieger 2915: upload. The upload script will take care of not uploading
2916: restricted packages and putting vulnerable packages into the
2917: <code class="filename">vulnerable</code> subdirectory.</p>
2918: <p>After the upload has ended, first thing is to revoke ssh access:</p>
2919: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
2920: Gdd:x! </pre>
2921: <p>Use whatever is needed to remove the key you've entered
2922: before! Last, move the uploaded packages out of the
2923: <code class="filename">upload</code> directory to have them accessible
2924: to everyone:</p>
2925: <pre class="screen">
2926: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
2927: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2928: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
2929: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2930: </pre>
2931: </div>
2932: </div>
2933: <div class="sect1" lang="en">
2934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2935: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
2936: <div class="sect2" lang="en">
2937: <div class="titlepage"><div><div><h3 class="title">
2938: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
1.10 hubertf 2939: <p>TODO; see <a class="ulink" href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
1.6 rillig 2940: more information.</p>
2941: </div>
2942: </div>
2943: <div class="sect1" lang="en">
2944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2945: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 2946: <p>After your pkgsrc bulk-build has completed, you may wish to
2947: create a CD-ROM set of the resulting binary packages to assist
2948: in installing packages on other machines. The
2949: <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
2950: a simple tool for creating the ISO 9660 images.
1.10 hubertf 2951: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 2952: way that keeps all the dependencies for a given package on the same
2953: CD as that package.</p>
2954: <div class="sect2" lang="en">
2955: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2956: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 2957: <p>Complete documentation for cdpack is found in the cdpack(1)
2958: man page. The following short example assumes that the binary
2959: packages are left in
2960: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2961: sufficient disk space exists in <code class="filename">/u2</code> to
2962: hold the ISO 9660 images.</p>
2963: <pre class="screen">
2964: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2965: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2966: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2967: </pre>
2968: <p>If you wish to include a common set of files
2969: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2970: etc.) on each CD in the collection, then you need to create a
2971: directory which contains these files. e.g.</p>
2972: <pre class="screen">
2973: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2974: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2975: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2976: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2977: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2978: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
2979: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2980: </pre>
2981: <p>Now create the images:</p>
2982: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
2983: <p>Each image will contain <code class="filename">README</code>,
2984: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2985: in their root directories.</p>
2986: </div>
2987: </div>
2988: </div>
2989: <div class="chapter" lang="en">
2990: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 2991: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 2992: <div class="toc">
2993: <p><b>Table of Contents</b></p>
2994: <dl>
1.6 rillig 2995: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
2996: <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 2997: </dl>
2998: </div>
2999: <p>The files that are installed by pkgsrc are organized in a way that
3000: is similar to what you find in the <code class="filename">/usr</code> directory
3001: of the base system. But some details are different. This is because
3002: pkgsrc initially came from FreeBSD and had adopted its file system
3003: hierarchy. Later it was largely influenced by NetBSD. But no matter
3004: which operating system you are using pkgsrc with, you can expect the
3005: same layout for pkgsrc.</p>
3006: <p>There are mainly four root directories for pkgsrc, which are all
3007: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3008: When pkgsrc has been installed as root, the default locations
3009: are:</p>
3010: <pre class="programlisting">
3011: LOCALBASE= /usr/pkg
3012: PKG_SYSCONFBASE= /usr/pkg/etc
3013: VARBASE= /var
3014: PKG_DBDIR= /var/db/pkg
3015: </pre>
3016: <p>In unprivileged mode (when pkgsrc has been installed as any other
3017: user), the default locations are:</p>
3018: <pre class="programlisting">
3019: LOCALBASE= ${HOME}/pkg
3020: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3021: VARBASE= ${HOME}/pkg/var
3022: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
3023: </pre>
3024: <p>What these four directories are for, and what they look like is
3025: explained below.</p>
3026: <div class="itemizedlist"><ul type="disc">
3027: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3028: <code class="filename">/usr</code> directory in the base system. It is the
3029: “<span class="quote">main</span>” directory where the files are installed and contains
3030: the well-known subdirectories like <code class="filename">bin</code>,
3031: <code class="filename">include</code>, <code class="filename">lib</code>,
3032: <code class="filename">share</code> and
3033: <code class="filename">sbin</code>.</p></li>
3034: <li><p><code class="varname">VARBASE</code> corresponds to
3035: <code class="filename">/var</code> in the base system. Some programs (especially
3036: games, network daemons) need write access to it during normal
3037: operation.</p></li>
3038: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3039: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 3040: 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 3041: itself.</p></li>
3042: </ul></div>
3043: <div class="sect1" lang="en">
3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3045: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 3046: </h2></div></div></div>
3047: <p>The following directories exist in a typical pkgsrc installation
3048: in <code class="filename">${LOCALBASE}</code>.</p>
3049: <div class="variablelist"><dl>
3050: <dt><span class="term"><code class="filename">bin</code></span></dt>
3051: <dd><p>Contains executable programs that are intended to be
3052: directly used by the end user.</p></dd>
3053: <dt><span class="term"><code class="filename">emul</code></span></dt>
3054: <dd><p>Contains files for the emulation layers of various other
3055: operating systems, especially for
3056: NetBSD.</p></dd>
3057: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3058: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3059: <dd><p>Contains
3060: the configuration files.</p></dd>
3061: <dt><span class="term"><code class="filename">include</code></span></dt>
3062: <dd><p>Contains headers for the C and C++ programming
3063: languages.</p></dd>
3064: <dt><span class="term"><code class="filename">info</code></span></dt>
3065: <dd><p>Contains GNU info files of various
3066: packages.</p></dd>
3067: <dt><span class="term"><code class="filename">lib</code></span></dt>
3068: <dd><p>Contains shared and static
3069: libraries.</p></dd>
3070: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3071: <dd><p>Contains data files that don't change after
3072: installation. Other data files belong into
3073: <code class="filename">${VARBASE}</code>.</p></dd>
3074: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3075: <dd><p>Contains programs that are not intended to be used by
3076: end users, such as helper programs or network
3077: daemons.</p></dd>
3078: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3079: <dd><p>Contains programs that are intended to be executed as
3080: CGI scripts by a web server.</p></dd>
3081: <dt><span class="term"><code class="filename">man</code> (the usual value of
3082: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3083: <dd><p>Contains brief
3084: documentation in form of manual pages.</p></dd>
3085: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3086: <dd><p>Contains programs that are intended to be used only by
3087: the super-user.</p></dd>
3088: <dt><span class="term"><code class="filename">share</code></span></dt>
3089: <dd><p>Contains platform-independent data files that don't
3090: change after installation.</p></dd>
3091: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3092: <dd><p>Contains documentation files provided by the
3093: packages.</p></dd>
3094: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3095: <dd><p>Contains example files provided by the packages. Among
3096: others, the original configuration files are saved here and copied to
3097: <code class="filename">${PKG_SYSCONFDIR}</code> during
3098: installation.</p></dd>
3099: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3100: <dd><p>Contains the original files for rc.d
3101: scripts.</p></dd>
3102: <dt><span class="term"><code class="filename">var</code> (the usual location of
3103: <code class="filename">${VARBASE}</code>)</span></dt>
3104: <dd><p>Contains files
3105: that may be modified after
3106: installation.</p></dd>
3107: </dl></div>
3108: </div>
3109: <div class="sect1" lang="en">
3110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3111: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 3112: </h2></div></div></div>
3113: <div class="variablelist"><dl>
3114: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3115: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3116: <dd><p>Contains
3117: information about the currently installed
3118: packages.</p></dd>
3119: <dt><span class="term"><code class="filename">games</code></span></dt>
3120: <dd><p>Contains highscore
3121: files.</p></dd>
3122: <dt><span class="term"><code class="filename">log</code></span></dt>
3123: <dd><p>Contains log files.</p></dd>
3124: <dt><span class="term"><code class="filename">run</code></span></dt>
3125: <dd><p>Contains informational files about daemons that are
3126: currently running.</p></dd>
3127: </dl></div>
3128: </div>
3129: </div>
3130: <div class="chapter" lang="en">
3131: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3132: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 3133: <div class="toc">
3134: <p><b>Table of Contents</b></p>
3135: <dl>
1.6 rillig 3136: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3137: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3138: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3139: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3140: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3141: <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>
3142: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.10 hubertf 3143: <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 3144: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
3145: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 3146: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 3147: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
3148: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3149: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3150: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
3151: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3152: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
3153: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.1 dsieger 3154: </dl>
3155: </div>
3156: <p>This section contains hints, tips & tricks on special things in
3157: pkgsrc that we didn't find a better place for in the previous chapters, and
3158: it contains items for both pkgsrc users and developers.</p>
3159: <div class="sect1" lang="en">
3160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3161: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 3162: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3163: <div class="itemizedlist"><ul type="disc">
1.10 hubertf 3164: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 3165: This is a general purpose list for most issues regarding
3166: pkgsrc, regardless of platform, e.g. soliciting user help
3167: for pkgsrc configuration, unexpected build failures, using
3168: particular packages, upgrading pkgsrc installations,
3169: questions regarding the pkgsrc release branches, etc. General announcements or
3170: proposals for changes that impact the pkgsrc user community,
3171: e.g. major infrastructure changes, new features, package
3172: removals, etc., may also be posted.</p></li>
1.10 hubertf 3173: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 3174: A list where the results of pkgsrc bulk builds are sent and
3175: discussed.</p></li>
1.10 hubertf 3176: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 3177: This list is for those who are interested in getting a
3178: commit message for every change committed to pkgsrc. It is
3179: also available in digest form, meaning one daily message
3180: containing all commit messages for changes to the package
3181: source tree in that 24 hour period.</p></li>
3182: </ul></div>
3183: <p>To subscribe, do:</p>
3184: <pre class="programlisting">
3185: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3186: </pre>
3187: <p>Archives for all these mailing lists are available from
1.10 hubertf 3188: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 3189: </div>
3190: <div class="sect1" lang="en">
3191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3192: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 3193: <p>Pkgviews is tightly integrated with buildlink. You can find a
3194: pkgviews User's guide in
3195: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3196: </div>
3197: <div class="sect1" lang="en">
3198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3199: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 3200: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3201: a number of useful utilities for both users and developers of pkgsrc. This
3202: section attempts only to make the reader aware of the utilities and when
3203: they might be useful, and not to duplicate the documentation that comes
3204: with each package.</p>
3205: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
3206: <div class="itemizedlist"><ul type="disc"><li><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>:
3207: Symlinks for use by buildlink.</p></li></ul></div>
3208: <p>OS tool augmentation (automatically installed when needed):</p>
3209: <div class="itemizedlist"><ul type="disc">
3210: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
3211: Calculates various kinds of checksums (including SHA1).</p></li>
3212: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
3213: Compatibility library for pkgsrc tools.</p></li>
3214: <li><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
3215: non-BSD systems due to lack of native mtree.</p></li>
3216: <li><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>:
3217: Up-to-date replacement for
3218: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3219: systems where pkg_install is not present.</p></li>
3220: </ul></div>
3221: <p>Utilities used by pkgsrc (not automatically installed):</p>
3222: <div class="itemizedlist"><ul type="disc">
3223: <li><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>:
3224: Create a binary package from an
1.10 hubertf 3225: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 3226: save the old package.</p></li>
3227: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
3228: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3229: from multiple locations. It currently supports the following
3230: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
3231: <li><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
3232: packages someplace else (enabled by default).</p></li>
3233: <li><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 the
3234: best compiler flags to optimise code for your current CPU and
3235: compiler.</p></li>
3236: </ul></div>
3237: <p>Utilities for keeping track of installed packages, being up to date,
3238: etc:</p>
3239: <div class="itemizedlist"><ul type="disc">
3240: <li><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
3241: packages whose installed versions do not match the latest pkgsrc
3242: entries.</p></li>
3243: <li><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
3244: dependency graphs of packages, to aid in choosing a strategy for
3245: updating.</p></li>
3246: <li><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
3247: 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>
3248: <li><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
3249: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3250: does various checks on the complete pkgsrc system.</p></li>
3251: <li><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
3252: packages you have installed.</p></li>
3253: </ul></div>
3254: <p>Utilities for people maintaining or creating individual packages:</p>
3255: <div class="itemizedlist"><ul type="disc">
3256: <li><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
3257: making and maintaining patches for a package (includes pkgdiff,
3258: pkgvi, mkpatches, etc.).</p></li>
3259: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
3260: <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
3261: converting to pkgsrc.</p></li>
3262: <li><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
3263: pkgsrc to a Solaris package.</p></li>
3264: </ul></div>
3265: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3266: utilities)</p>
3267: <div class="itemizedlist"><ul type="disc">
3268: <li><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
3269: packages in a chrooted area.</p></li>
3270: <li><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
3271: kernel version for chrooted cross builds.</p></li>
3272: </ul></div>
3273: </div>
3274: <div class="sect1" lang="en">
3275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3276: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3277: <p>If you want to use pkgsrc as non-root user, you can set some
3278: variables to make pkgsrc work under these conditions. At the very least,
3279: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3280: will turn on unprivileged mode and set multiple related variables to allow
3281: installation of packages as non-root.</p>
3282: <p>In case the defaults are not enough, you may want to tune some other
3283: variables used. For example, if the automatic user/group detection leads
3284: to incorrect values (or not the ones you would like to use), you can change
3285: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3286: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3287: <p>As regards bootstrapping, please note that the
1.10 hubertf 3288: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.1 dsieger 3289: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
3290: use multiple default directories under <code class="filename">~/pkg</code> as the
3291: installation targets. These directories can be overridden by the
3292: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3293: that allow finer tuning of the tree layout.</p>
3294: </div>
3295: <div class="sect1" lang="en">
3296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3297: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3298: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3299: enable this feature by adding the option
3300: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3301: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3302: distfile is found, pkgsrc will try to resume it.</p>
3303: <p>You can also
1.10 hubertf 3304: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.1 dsieger 3305: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3306: <code class="varname">FETCH_RESUME_ARGS</code> and
3307: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3308: values.</p>
3309: <p>For example, if you want to use
3310: <code class="filename">wget</code> to resume downloads, you'll have to use something
3311: like:</p>
3312: <pre class="programlisting">
3313: FETCH_CMD= wget
3314: FETCH_BEFORE_ARGS= --passive-ftp
3315: FETCH_RESUME_ARGS= -c
1.10 hubertf 3316: FETCH_OUTPUT_ARGS= -O -nc
1.1 dsieger 3317: </pre>
3318: </div>
3319: <div class="sect1" lang="en">
3320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3321: <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 3322: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3323: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3324: you will have to add the following line into
1.10 hubertf 3325: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3326: <pre class="programlisting">
1.4 rillig 3327: X11_TYPE=modular
1.1 dsieger 3328: </pre>
3329: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3330: <h3 class="title">Note</h3>
1.4 rillig 3331: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3332: </p>
1.1 dsieger 3333: </div>
3334: </div>
3335: <div class="sect1" lang="en">
3336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3337: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3338: <p>If you are sitting behind a firewall which does not allow direct
3339: connections to Internet hosts (i.e. non-NAT), you may specify the
3340: relevant proxy hosts. This is done using an environment variable in the
3341: form of a URL, e.g. in Amdahl, the machine
3342: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3343: port 80 as the proxy port number. So the proxy environment variables
3344: are:</p>
3345: <pre class="programlisting">
3346: ftp_proxy=ftp://orpheus.amdahl.com:80/
3347: http_proxy=http://orpheus.amdahl.com:80/
3348: </pre>
3349: </div>
3350: <div class="sect1" lang="en">
3351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 3352: <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 3353: <p>This depends on which utility is used to retrieve distfiles. From
3354: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3355: the first available command from the following list:</p>
3356: <div class="itemizedlist"><ul type="disc">
3357: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3358: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
3359: </ul></div>
3360: <p>On a default NetBSD installation, this will be
3361: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3362: connections first, and falls back to active connections if the server
3363: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3364: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3365: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3366: <p>Having that option present will prevent
3367: <code class="filename">/usr/bin/ftp</code> from falling back to active
3368: transfers.</p>
3369: </div>
3370: <div class="sect1" lang="en">
3371: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3372: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3373: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3374: from work or university, where you can't run a <span class="command"><strong>make
3375: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 3376: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3377: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3378: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3379: resulting list to your machine at work/school and use it there. If you
1.10 hubertf 3380: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3381: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3382: URL:</p>
3383: <p>At home:</p>
3384: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3385: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3386: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3387: <p>At work:</p>
3388: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3389: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3390: home.</p>
3391: <p>If you have a machine running NetBSD, and you want to get
3392: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3393: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3394: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3395: directly by running:</p>
3396: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3397: <p>If you even decide to ignore
3398: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3399: by running:</p>
3400: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3401: </div>
3402: <div class="sect1" lang="en">
3403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3404: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 3405: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
3406: <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>
3407: package, you get the error from make that it doesn't know how to make
3408: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
3409: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3410: the NetBSD base distribution on your machine. It is recommended to do
3411: that to format man pages.</p>
3412: <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
3413: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3414: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3415: </div>
3416: <div class="sect1" lang="en">
3417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3418: <a name="bsd.own.mk-missing"></a>9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</h2></div></div></div>
1.1 dsieger 3419: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3420: when you installed your NetBSD machine. Please get and install it, by
3421: extracting it in <code class="filename">/</code>:</p>
3422: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3423: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3424: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3425: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3426: -r</strong></span>).</p>
3427: </div>
3428: <div class="sect1" lang="en">
3429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3430: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3431: <p>When installing packages as non-root user and using the just-in-time
1.10 hubertf 3432: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><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 3433: password for each required package installed. To avoid this, the sudo
3434: package can be used, which does password caching over a limited time. To
3435: use it, install sudo (either as binary package or from
3436: <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 3437: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3438: <span class="emphasis"><em>after</em></span> the definition of the
3439: <code class="varname">LOCALBASE</code> variable:</p>
3440: <pre class="programlisting">
3441: .if exists(${LOCALBASE}/bin/sudo)
3442: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3443: .endif
3444: </pre>
3445: </div>
3446: <div class="sect1" lang="en">
3447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3448: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3449: <p>As the system administrator, you can choose where configuration files
3450: are installed. The default settings make all these files go into
3451: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3452: be suboptimal depending on your expectations (e.g., a read-only,
3453: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3454: configuration of the provided packages).</p>
3455: <p>In order to change the defaults, you can modify the
3456: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3457: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3458: directory; some common examples include <code class="filename">/etc</code> or
3459: <code class="filename">/etc/pkg</code>.</p>
3460: <p>Furthermore, you can change this value on a per-package basis by
3461: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3462: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3463: package you would like to modify, that is, the contents of
3464: <code class="varname">PKGBASE</code>.</p>
3465: <p>Note that after changing these settings, you must rebuild and
3466: reinstall any affected packages.</p>
3467: </div>
3468: <div class="sect1" lang="en">
3469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3470: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3471: <p>Please be aware that there can often be bugs in third-party software,
3472: and some of these bugs can leave a machine vulnerable to exploitation by
3473: attackers. In an effort to lessen the exposure, the NetBSD packages team
3474: maintains a database of known-exploits to packages which have at one time
3475: been included in pkgsrc. The database can be downloaded automatically, and
3476: a security audit of all packages installed on a system can take place. To
3477: do this, install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> package. It has two
3478: components:</p>
3479: <div class="orderedlist"><ol type="1">
3480: <li>
1.10 hubertf 3481: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.1 dsieger 3482: download a list of the security vulnerabilities information. This list
3483: is kept up to date by the NetBSD security officer and the NetBSD
3484: packages team, and is distributed from the NetBSD ftp server:</p>
1.10 hubertf 3485: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.1 dsieger 3486: </li>
1.10 hubertf 3487: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.1 dsieger 3488: current machine, checking each vulnerability which is known. If a
3489: vulnerable package is installed, it will be shown by output to stdout,
3490: including a description of the type of vulnerability, and a URL
3491: containing more information.</p></li>
3492: </ol></div>
3493: <p>Use of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>
3494: package is strongly recommended! After
3495: “<span class="quote">audit-packages</span>” is installed, please read
3496: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3497: audit-packages</code></strong>.</p>
3498: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3499: 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 3500: check.</p>
3501: </div>
3502: <div class="sect1" lang="en">
3503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3504: <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 3505: <p>When you add your own preferences to the
3506: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3507: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3508: environment variables to the <code class="filename">./configure</code>
1.10 hubertf 3509: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3510: <code class="varname">CFLAGS</code> from the environment variable by
3511: overriding them in the <code class="filename">Makefile</code>s of their
3512: package.</p>
3513: <p>Currently there is no solution to this problem. If you
3514: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3515: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3516: directory and then inspect any <code class="filename">Makefile</code> and
3517: <code class="filename">Makefile.in</code> for whether they define
3518: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3519: these lines. But be aware that some “<span class="quote">smart</span>”
3520: programmers write so bad code that it only works for the
3521: specific combination of <code class="varname">CFLAGS</code> they have
3522: chosen.</p>
3523: </div>
3524: <div class="sect1" lang="en">
3525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3526: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.1 dsieger 3527: <div class="procedure"><ol type="1">
3528: <li><p>Make sure that your copy of pkgsrc is consistent. A
3529: case that occurs often is that people only update pkgsrc in
3530: parts, because of performance reasons. Since pkgsrc is one large
3531: system, not a collection of many small systems, there are
3532: sometimes changes that only work when the whole pkgsrc tree is
3533: updated.</p></li>
3534: <li><p>Make sure that you don't have any CVS conflicts.
3535: Search for “<span class="quote"><<<<<<</span>” or
3536: “<span class="quote">>>>>>></span>” in all your pkgsrc
3537: files.</p></li>
3538: <li><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3539: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3540: verify this.</p></li>
3541: <li><p>If the problem still exists, write a mail to the
3542: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3543: </ol></div>
3544: </div>
3545: <div class="sect1" lang="en">
3546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3547: <a name="faq.rcs-conflicts"></a>9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</h2></div></div></div>
1.1 dsieger 3548: <p>You have modified a file from pkgsrc, and someone else has
3549: modified that same file afterwards in the CVS repository. Both changes
3550: are in the same region of the file, so when you updated pkgsrc, the
3551: <code class="literal">cvs</code> command marked the conflicting changes in the
3552: file. Because of these markers, the file is no longer a valid
3553: <code class="filename">Makefile</code>.</p>
3554: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3555: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3556: -dP</strong></span> in that directory to download the current version.</p>
3557: </div>
3558: </div>
3559: </div>
3560: <div class="part" lang="en">
3561: <div class="titlepage"><div><div><h1 class="title">
3562: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
3563: <div class="partintro" lang="en">
3564: <div></div>
3565: <p>This part of the book deals with creating and
3566: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3567: guide on creating a new package. The remaining chapters are more
3568: like a reference manual for pkgsrc.</p>
3569: <div class="toc">
3570: <p><b>Table of Contents</b></p>
3571: <dl>
1.6 rillig 3572: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3573: <dd><dl>
1.6 rillig 3574: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3575: <dd><dl>
1.6 rillig 3576: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3577: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 3578: </dl></dd>
1.6 rillig 3579: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3580: <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>
3581: </dl></dd>
3582: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3583: <dd><dl>
3584: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3585: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
3586: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3587: <dd><dl>
3588: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3589: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3590: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3591: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3592: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3593: </dl></dd>
3594: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3595: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3596: <dd><dl>
3597: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3598: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3599: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3600: </dl></dd>
3601: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3602: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
3603: </dl></dd>
3604: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3605: <dd><dl>
3606: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
3607: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
3608: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3609: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3610: <dd><dl>
3611: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3612: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3613: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3614: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3615: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3616: </dl></dd>
3617: </dl></dd>
3618: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3619: <dd><dl>
3620: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
3621: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.10 hubertf 3622: <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 3623: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3624: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
3625: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3626: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3627: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3628: </dl></dd>
3629: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3630: <dd><dl>
3631: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
3632: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3633: <dd><dl>
3634: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3635: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
3636: </dl></dd>
3637: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3638: <dd><dl>
3639: <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>
3640: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3641: </dl></dd>
3642: </dl></dd>
3643: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3644: <dd><dl>
3645: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3646: <dd><dl>
3647: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3648: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3649: </dl></dd>
3650: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3651: <dd><dl>
3652: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3653: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3654: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3655: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3656: </dl></dd>
3657: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3658: <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>
3659: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3660: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3661: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3662: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3663: <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>
3664: </dl></dd>
3665: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3666: <dd><dl>
3667: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3668: <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>
3669: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3670: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3671: </dl></dd>
3672: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3673: <dd><dl>
3674: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3675: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3676: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3677: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
3678: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3679: <dd><dl>
3680: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3681: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3682: </dl></dd>
3683: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3684: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3685: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3686: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3687: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3688: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3689: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3690: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3691: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3692: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3693: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3694: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3695: </dl></dd>
3696: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3697: <dd><dl>
3698: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3699: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3700: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3701: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3702: </dl></dd>
3703: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3704: <dd><dl>
3705: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3706: <dd><dl>
3707: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
3708: <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>
3709: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3710: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3711: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3712: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3713: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3714: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3715: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3716: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3717: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3718: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3719: </dl></dd>
3720: <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>
3721: <dd><dl>
3722: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3723: <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>
3724: </dl></dd>
3725: <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>
3726: <dd><dl>
3727: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3728: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3729: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3730: </dl></dd>
3731: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3732: <dd><dl>
3733: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3734: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3735: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3736: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3737: </dl></dd>
3738: <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>
3739: <dd><dl>
3740: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3741: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
3742: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3743: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3744: </dl></dd>
3745: <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>
3746: <dd><dl>
3747: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3748: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3749: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3750: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3751: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3752: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3753: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3754: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3755: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 3756: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
3757: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3758: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3759: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3760: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3761: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3762: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3763: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3764: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3765: emulation</a></span></dt>
1.6 rillig 3766: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3767: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3768: </dl></dd>
1.6 rillig 3769: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3770: </dl></dd>
1.6 rillig 3771: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3772: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3773: <dd><dl>
1.6 rillig 3774: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3775: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3776: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3777: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3778: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3779: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
3780: </dl></dd>
3781: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3782: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3783: <dd><dl>
3784: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3785: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3786: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3787: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3788: </dl></dd>
3789: </dl>
3790: </div>
3791: </div>
3792: <div class="chapter" lang="en">
3793: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3794: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3795: <div class="toc">
3796: <p><b>Table of Contents</b></p>
3797: <dl>
1.6 rillig 3798: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3799: <dd><dl>
1.6 rillig 3800: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3801: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 3802: </dl></dd>
1.6 rillig 3803: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3804: <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 3805: </dl>
3806: </div>
3807: <p>When you find a package that is not yet in pkgsrc, you
3808: most likely have a URL from where you can download the source
3809: code. Starting with this URL, creating a package involves only a
3810: few steps.</p>
3811: <div class="procedure"><ol type="1">
3812: <li><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>
3813: <li><p>Then, choose one of the top-level directories as the
3814: category in which you want to place your package. You can also create a
3815: directory of your own (maybe called <code class="filename">local</code>). In that
3816: category directory, create another directory for your package and change
3817: into it.</p></li>
1.10 hubertf 3818: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3819: you for a URL. Enter the URL of the distribution file (in most cases a
3820: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3821: of your package are created automatically. The distribution file is
3822: extracted automatically to fill in some details in the
3823: <code class="filename">Makefile</code> that would otherwise have to be done
3824: manually.</p></li>
3825: <li>
3826: <p>Examine the extracted files to determine the dependencies of
3827: your package. Ideally, this is mentioned in some
3828: <code class="filename">README</code> file, but things may differ. For each of
3829: these dependencies, look where it exists in pkgsrc, and if there is a
3830: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3831: line to your package <code class="filename">Makefile</code> which includes that
3832: file just before the last line. If the
3833: <code class="filename">buildlink3.mk</code> file does not exist, add a
3834: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3835: version of the dependency and where it can be found in pkgsrc. This line
3836: should be placed in the third paragraph. If the dependency is only
3837: needed for building the package, but not when using it, use
3838: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3839: Your package may then look like this:</p>
3840: <pre class="programlisting">
3841: [...]
3842:
3843: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3844: DEPENDS+= screen-[0-9]*:../../misc/screen
3845: DEPENDS+= screen>=4.0:../../misc/screen
3846:
3847: [...]
3848:
3849: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3850: .include "../../devel/glib2/buildlink3.mk"
3851: .include "../../mk/bsd.pkg.mk"
3852: </pre>
3853: </li>
1.10 hubertf 3854: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.1 dsieger 3855: to be done to make your package a “<span class="quote">good</span>” one. If you don't
1.10 hubertf 3856: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3857: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3858: -e</strong></span>, which outputs additional
3859: explanations.</p></li>
3860: <li><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3861: 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 3862: over there, you can hopefully continue here.</p></li>
1.10 hubertf 3863: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3864: directory from the extracted files. Besides these files, a lot of cache
3865: files and other system information has been saved in the working
3866: directory, which may become wrong after you edited the
3867: <code class="filename">Makefile</code>.</p></li>
1.10 hubertf 3868: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3869: 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.1 dsieger 3870: <li><p>When the package builds fine, the next step is to install
1.10 hubertf 3871: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 3872: everything works.</p></li>
3873: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3874: contains a list of the files that are installed by the package, is
1.10 hubertf 3875: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 3876: >PLIST</strong></span> to generate a probably correct list. Check
3877: the file using your preferred text editor to see if the list of
3878: files looks plausible.</p></li>
1.10 hubertf 3879: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 3880: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.10 hubertf 3881: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 3882: has been registered in the database of installed files, but with an
1.10 hubertf 3883: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3884: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 3885: registered with the list of files from
3886: <code class="filename">PLIST</code>.</p></li>
1.10 hubertf 3887: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 3888: package from the set of installed files.</p></li>
3889: </ol></div>
3890: <div class="sect1" lang="en">
3891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3892: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.1 dsieger 3893: <div class="sect2" lang="en">
3894: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3895: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 3896: <p>Simple Perl modules are handled automatically by
1.10 hubertf 3897: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 3898: </div>
3899: <div class="sect2" lang="en">
3900: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3901: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1 dsieger 3902: <p>KDE applications should always include
3903: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3904: settings that are typical of KDE packages.</p>
3905: </div>
3906: </div>
3907: <div class="sect1" lang="en">
3908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3909: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.1 dsieger 3910: <div class="sect2" lang="en">
3911: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3912: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.1 dsieger 3913: <div class="sect3" lang="en">
3914: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3915: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 3916: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
3917: that the “<span class="quote">nvu</span>” package has not yet been imported into
3918: pkgsrc. As the description says it has to do with the web, the obvious
3919: choice for the category is “<span class="quote">www</span>”.</p>
3920: <pre class="programlisting">
3921: <code class="prompt">$</code> mkdir www/nvu
3922: <code class="prompt">$</code> cd www/nvu
3923: </pre>
3924: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 3925: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 3926: <pre class="programlisting">
3927: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3928: </pre>
3929: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3930: below the <code class="varname">DISTNAME</code> line, as the package name should
3931: not have the word “<span class="quote">sources</span>” in it. I also filled in the
3932: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3933: <code class="varname">COMMENT</code> fields. Then the package
3934: <code class="filename">Makefile</code> looked like that:</p>
3935: <pre class="programlisting">
3936: # $NetBSD$
3937: #
3938:
3939: DISTNAME= nvu-1.0-sources
3940: PKGNAME= nvu-1.0
3941: CATEGORIES= www
3942: MASTER_SITES= http://cvs.nvu.com/download/
3943: EXTRACT_SUFX= .tar.bz2
3944:
3945: MAINTAINER= rillig@NetBSD.org
3946: HOMEPAGE= http://cvs.nvu.com/
3947: COMMENT= Web Authoring System
3948:
3949: # url2pkg-marker (please do not remove this line.)
3950: .include "../../mk/bsd.pkg.mk"
3951: </pre>
3952: <p>Then, I quit the editor and watched pkgsrc downloading a large
3953: source archive:</p>
3954: <pre class="programlisting">
3955: url2pkg> Running "make makesum" ...
3956: => Required installed package digest>=20010302: digest-20060826 found
3957: => Fetching nvu-1.0-sources.tar.bz2
3958: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3959: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3960: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3961: url2pkg> Running "make extract" ...
3962: => Required installed package digest>=20010302: digest-20060826 found
3963: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3964: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3965: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3966: ===> Installing dependencies for nvu-1.0
3967: ===> Overriding tools for nvu-1.0
3968: ===> Extracting for nvu-1.0
3969: url2pkg> Adjusting the Makefile.
3970:
3971: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3972:
3973: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3974: </pre>
3975: </div>
3976: <div class="sect3" lang="en">
3977: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 3978: <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 3979: <p>Now that the package has been extracted, let's see what's inside
3980: it. The package has a <code class="filename">README.txt</code>, but that only
3981: says something about mozilla, so it's probably useless for seeing what
3982: dependencies this package has. But since there is a GNU configure script
3983: in the package, let's hope that it will complain about everything it
3984: needs.</p>
3985: <pre class="programlisting">
3986: <code class="prompt">$</code> bmake
3987: => Required installed package digest>=20010302: digest-20060826 found
3988: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3989: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3990: ===> Patching for nvu-1.0
3991: ===> Creating toolchain wrappers for nvu-1.0
3992: ===> Configuring for nvu-1.0
3993: [...]
3994: configure: error: Perl 5.004 or higher is required.
3995: [...]
3996: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3997: [...]
3998: </pre>
3999: <p>That worked quite well. So I opened the package Makefile in my
4000: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4001: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4002: package have changed now, and since a perl wrapper is automatically
4003: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4004: from scratch.</p>
4005: <pre class="programlisting">
4006: <code class="prompt">$</code> bmake clean
4007: ===> Cleaning for nvu-1.0
4008: <code class="prompt">$</code> bmake
4009: [...]
4010: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4011: GNU Make. You will not be able to build Mozilla without GNU Make.
4012: [...]
4013: </pre>
4014: <p>So I added “<span class="quote">gmake</span>” to the
4015: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4016: <pre class="programlisting">
4017: [...]
4018: checking for GTK - version >= 1.2.0... no
4019: *** Could not run GTK test program, checking why...
4020: [...]
4021: </pre>
4022: <p>Now to the other dependencies. The first question is: Where is the
4023: GTK package hidden in pkgsrc?</p>
4024: <pre class="programlisting">
4025: <code class="prompt">$</code> echo ../../*/gtk*
4026: [many packages ...]
4027: <code class="prompt">$</code> echo ../../*/gtk
4028: ../../x11/gtk
4029: <code class="prompt">$</code> echo ../../*/gtk2
4030: ../../x11/gtk2
4031: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4032: ../../x11/gtk2/buildlink3.mk
4033: </pre>
4034: <p>The first try was definitely too broad. The second one had exactly
4035: one result, which is very good. But there is one pitfall with GNOME
4036: packages. Before GNOME 2 had been released, there were already many
4037: GNOME 1 packages in pkgsrc. To be able to continue to use these
4038: packages, the GNOME 2 packages were imported as separate packages, and
4039: their names usually have a “<span class="quote">2</span>” appended. So I checked
4040: whether this was the case here, and indeed it was.</p>
4041: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4042: file, adding the dependency is very easy. I just inserted an
4043: <code class="literal">.include</code> line before the last line of the package
4044: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4045: <pre class="programlisting">
4046: [...]
4047: .include "../../x11/gtk2/buildlink3.mk"
4048: .include "../../mk/bsd.pkg.mk
4049: </pre>
1.10 hubertf 4050: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 4051: was:</p>
4052: <pre class="programlisting">
4053: [...]
4054: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4055: checking for GTK - version >= 1.2.0... no
4056: *** Could not run GTK test program, checking why...
4057: *** The test program failed to compile or link. See the file config.log for the
4058: *** exact error that occured. This usually means GTK was incorrectly installed
4059: *** or that you have moved GTK since it was installed. In the latter case, you
4060: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4061: configure: error: Test for GTK failed.
4062: [...]
4063: </pre>
4064: <p>In this particular case, the assumption that “<span class="quote">every package
4065: prefers GNOME 2</span>” had been wrong. The first of the lines above
4066: told me that this package really wanted to have the GNOME 1 version of
4067: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 4068: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 4069: So I changed the <code class="literal">x11/gtk2</code> to
4070: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4071: and tried again.</p>
4072: <pre class="programlisting">
4073: [...]
4074: 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
4075: In file included from xpidl.c:42:
4076: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4077: In file included from xpidl.c:42:
4078: xpidl.h:132: error: parse error before "IDL_ns"
4079: [...]
4080: </pre>
4081: <p>The package still does not find all of its dependencies. Now the
4082: question is: Which package provides the
4083: <code class="filename">libIDL/IDL.h</code> header file?</p>
4084: <pre class="programlisting">
4085: <code class="prompt">$</code> echo ../../*/*idl*
4086: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4087: <code class="prompt">$</code> echo ../../*/*IDL*
4088: ../../net/libIDL
4089: </pre>
4090: <p>Let's take the one from the second try. So I included the
4091: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4092: again. But the error didn't change. After digging through some of the
4093: code, I concluded that the build process of the package was broken and
4094: couldn't have ever worked, but since the Mozilla source tree is quite
4095: large, I didn't want to fix it. So I added the following to the package
4096: <code class="filename">Makefile</code> and tried again:</p>
4097: <pre class="programlisting">
4098: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4099: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4100: </pre>
4101: <p>The latter line is needed because the package expects the library
4102: <code class="filename">libIDL.so</code>, but only
4103: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4104: wrapper to rewrite that on the fly.</p>
4105: <p>The next problem was related to a recent change of the FreeType
4106: 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>
4107: which patch files were relevant for this issue and copied them to the
4108: <code class="filename">patches</code> directory. Then I retried, fixed the
4109: patches so that they applied cleanly and retried again. This time,
4110: everything worked.</p>
4111: </div>
4112: <div class="sect3" lang="en">
4113: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4114: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 4115: <pre class="programlisting">
4116: <code class="prompt">$</code> bmake CHECK_FILES=no install
4117: [...]
4118: <code class="prompt">$</code> bmake print-PLIST >PLIST
4119: <code class="prompt">$</code> bmake deinstall
4120: <code class="prompt">$</code> bmake install
4121: </pre>
4122: </div>
4123: </div>
4124: </div>
4125: </div>
4126: <div class="chapter" lang="en">
4127: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4128: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 4129: <div class="toc">
4130: <p><b>Table of Contents</b></p>
4131: <dl>
1.6 rillig 4132: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4133: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
4134: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4135: <dd><dl>
4136: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4137: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4138: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4139: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4140: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4141: </dl></dd>
4142: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4143: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4144: <dd><dl>
4145: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4146: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4147: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 4148: </dl></dd>
1.6 rillig 4149: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4150: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 4151: </dl>
4152: </div>
4153: <p>Whenever you're preparing a package, there are a number of
4154: files involved which are described in the following
4155: sections.</p>
4156: <div class="sect1" lang="en">
4157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4158: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 4159: </h2></div></div></div>
4160: <p>Building, installation and creation of a binary package are all
4161: controlled by the package's <code class="filename">Makefile</code>.
4162: The <code class="filename">Makefile</code> describes various things about
4163: a package, for example from where to get it, how to configure,
4164: build, and install it.</p>
4165: <p>A package <code class="filename">Makefile</code> contains several
4166: sections that describe the package.</p>
4167: <p>In the first section there are the following variables, which
4168: should appear exactly in the order given here. The order and
4169: grouping of the variables is mostly historical and has no further
4170: meaning.</p>
4171: <div class="itemizedlist"><ul type="disc">
4172: <li><p><code class="varname">DISTNAME</code> is the basename of the
4173: distribution file to be downloaded from the package's
4174: website.</p></li>
4175: <li><p><code class="varname">PKGNAME</code> is the name of the
4176: package, as used by pkgsrc. You only need to provide it if
4177: <code class="varname">DISTNAME</code> (which is the default) is not a good
4178: name for the package in pkgsrc. Usually it is the pkgsrc
4179: directory name together with the version number. It must match the
4180: regular expression
4181: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4182: starts with a letter or digit, and contains only letters, digits,
4183: dashes, underscores, dots and plus signs.</p></li>
4184: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4185: the package file to create if the <code class="varname">PKGNAME</code>
4186: isn't unique on a SVR4 system. The default is
4187: <code class="varname">PKGNAME</code>, which may be shortened when you use
4188: <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
4189: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4190: does not produce an unique package name on a SVR4 system.
4191: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4192: characters.</p></li>
4193: <li>
4194: <p><code class="varname">CATEGORIES</code> is a list of categories
4195: which the package fits in. You can choose any of the top-level
4196: directories of pkgsrc for it.</p>
4197: <p>Currently the following values are available for
4198: <code class="varname">CATEGORIES</code>. If more than
4199: one is used, they need to be separated by spaces:</p>
4200: <pre class="programlisting">
4201: archivers cross geography meta-pkgs security
4202: audio databases graphics misc shells
4203: benchmarks devel ham multimedia sysutils
4204: biology editors inputmethod net textproc
4205: cad emulators lang news time
4206: chat finance mail parallel wm
4207: comms fonts math pkgtools www
4208: converters games mbone print x11
4209: </pre>
4210: </li>
4211: <li><p><code class="varname">MASTER_SITES</code>,
4212: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4213: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4214: and <code class="varname">DISTFILES</code> are discussed in detail in
1.10 hubertf 4215: <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 4216: </ul></div>
4217: <p>The second section contains information about separately
4218: downloaded patches, if any.
4219: </p>
4220: <div class="itemizedlist"><ul type="disc">
4221: <li><p><code class="varname">PATCHFILES:</code>
4222: Name(s) of additional files that contain distribution patches.
4223: There is no default. pkgsrc will look for them at
4224: <code class="varname">PATCH_SITES</code>.
4225: They will automatically be uncompressed before patching if
4226: the names end with <code class="filename">.gz</code> or
4227: <code class="filename">.Z</code>.</p></li>
4228: <li><p><code class="varname">PATCH_SITES</code>:
4229: Primary location(s) for distribution patch files (see
4230: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4231: </ul></div>
4232: <p>The third section contains the following variables.
4233: </p>
4234: <div class="itemizedlist"><ul type="disc">
4235: <li><p><code class="varname">MAINTAINER</code> is the email address
4236: of the person who feels responsible for this package, and who is
4237: most likely to look at problems or questions regarding this
1.10 hubertf 4238: package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>. Other
1.1 dsieger 4239: developers should contact the <code class="varname">MAINTAINER</code> before
4240: making major changes to the package. When packaging a new program,
4241: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4242: maintain the package for future updates, set it to
1.10 hubertf 4243: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.1 dsieger 4244: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
4245: find more information about the package.</p></li>
4246: <li><p><code class="varname">COMMENT</code> is a one-line
4247: description of the package (should not include the package
4248: name).</p></li>
4249: </ul></div>
4250: <p>Other variables that affect the build:
4251: </p>
4252: <div class="itemizedlist"><ul type="disc"><li>
4253: <p><code class="varname">WRKSRC</code>: The directory where the
4254: interesting distribution files of the package are found. The
4255: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4256: works for most packages.</p>
4257: <p>If a package doesn't create a subdirectory for itself
4258: (most GNU software does, for instance), but extracts itself in
4259: the current directory, you should set
4260: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4261: <p>If a package doesn't create a subdirectory with the
4262: name of <code class="varname">DISTNAME</code> but some different name,
4263: set <code class="varname">WRKSRC</code> to point to the proper name in
4264: <code class="filename">${WRKDIR}</code>, for example
4265: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4266: <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>
4267: <p>The name of the working directory created by pkgsrc is
4268: taken from the <code class="varname">WRKDIR_BASENAME</code>
4269: variable. By default, its value is
4270: <code class="filename">work</code>. If you want to use the same
4271: pkgsrc tree for building different kinds of binary packages,
4272: you can change the variable according to your needs. Two
4273: other variables handle common cases of setting
4274: <code class="varname">WRKDIR_BASENAME</code> individually. If
4275: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4276: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4277: the host's name is attached to the directory name. If
4278: <code class="varname">OBJMACHINE</code> is defined, the platform name
4279: is attached, which might look like
4280: <code class="filename">work.i386</code> or
4281: <code class="filename">work.sparc</code>.</p>
4282: </li></ul></div>
4283: <p>Please pay attention to the following gotchas:</p>
4284: <div class="itemizedlist"><ul type="disc">
4285: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
4286: installed in compressed form by the package. For packages using
4287: BSD-style makefiles which honor MANZ, there is
4288: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
4289: <li><p>Replace <code class="filename">/usr/local</code> with
4290: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4291: below).</p></li>
1.10 hubertf 4292: <li><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 4293: </ul></div>
4294: </div>
4295: <div class="sect1" lang="en">
4296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4297: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4298: </h2></div></div></div>
4299: <p>The <code class="filename">distinfo</code> file contains the message
4300: digest, or checksum, of each distfile needed for the package. This
4301: ensures that the distfiles retrieved from the Internet have not been
4302: corrupted during transfer or altered by a malign force to introduce
4303: a security hole. Due to recent rumor about weaknesses of digest
4304: algorithms, all distfiles are protected using both SHA1 and RMD160
4305: message digests, as well as the file size.</p>
4306: <p>The <code class="filename">distinfo</code> file also contains the
4307: checksums for all the patches found in the
1.10 hubertf 4308: <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 4309: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4310: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4311: command.</p>
4312: <p>Some packages have different sets of distfiles depending on
4313: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
4314: <code class="filename">distinfo</code> file and care should be taken when
4315: upgrading such a package to ensure distfile information is not
4316: lost.</p>
4317: </div>
4318: <div class="sect1" lang="en">
4319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4320: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4321: <p>Many packages still don't work out-of-the box on the various
4322: platforms that are supported by pkgsrc. Therefore, a number of custom
4323: patch files are needed to make the package work. These patch files are
4324: found in the <code class="filename">patches/</code> directory.</p>
4325: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4326: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4327: 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.1 dsieger 4328: order</a>, so <code class="filename">patch-aa</code> is applied before
4329: <code class="filename">patch-ab</code>, etc.</p>
4330: <div class="sect2" lang="en">
4331: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4332: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4333: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4334: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4335: problems. (To force patches to apply with fuzz you can set
4336: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4337: should contain only changes for a single file, and no file should be
4338: patched by more than one patch file. This helps to keep future
4339: modifications simple.</p>
4340: <p>Each patch file is structured as follows: In the first line,
4341: there is the RCS Id of the patch itself. The second line should be
4342: empty for aesthetic reasons. After that, there should be a comment for
4343: each change that the patch does. There are a number of standard
4344: cases:</p>
4345: <div class="itemizedlist"><ul type="disc">
4346: <li><p>Patches that replace the <code class="literal">==</code>
1.10 hubertf 4347: operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.11 ! rillig 4348: are so common that they don't need a comment at all.</p></li>
1.1 dsieger 4349: <li><p>Patches for commonly known vulnerabilities should
4350: mention the vulnerability ID (CAN, CVE).</p></li>
4351: <li><p>Patches that change source code should mention the
4352: platform and other environment (for example, the compiler) that the
4353: patch is needed for.</p></li>
4354: </ul></div>
4355: <p>In all other cases, the patch should be commented so that any
4356: developer who knows the code of the application can make some use of
4357: the patch. Special care should be taken for the upstream developers,
4358: since we generally want that they accept our patches, so we have less
4359: work in the future.</p>
4360: </div>
4361: <div class="sect2" lang="en">
4362: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4363: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4364: <p>One important thing to mention is to pay attention that no RCS
4365: IDs get stored in the patch files, as these will cause problems when
4366: later checked into the NetBSD CVS tree. Use the
1.10 hubertf 4367: <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 4368: problems.</p>
4369: <p>For even more automation, we recommend using
1.10 hubertf 4370: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4371: whole set of patches. You just have to backup files before you
4372: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4373: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4374: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4375: you upgrade a package this way, you can easily compare the new
4376: set of patches with the previously existing one with
1.10 hubertf 4377: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.1 dsieger 4378: or update from the <code class="filename">work/.newpatches</code>
4379: directory to <code class="filename">patches/</code>.</p>
4380: <p>When you have finished a package, remember to generate
1.10 hubertf 4381: the checksums for the patch files by using the <span class="command"><strong>make
4382: 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 4383: <p>When adding a patch that corrects a problem in the
4384: distfile (rather than e.g. enforcing pkgsrc's view of where
4385: man pages should go), send the patch as a bug report to the
4386: maintainer. This benefits non-pkgsrc users of the package,
4387: and usually makes it possible to remove the patch in future
4388: version.</p>
1.2 rillig 4389: <p>The file names of the patch files are usually of the form
4390: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1 dsieger 4391: </div>
4392: <div class="sect2" lang="en">
4393: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4394: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4395: <p>If you want to share patches between multiple packages
4396: in pkgsrc, e.g. because they use the same distfiles, set
4397: <code class="varname">PATCHDIR</code> to the path where the patch files
4398: can be found, e.g.:</p>
4399: <pre class="programlisting">
4400: PATCHDIR= ${.CURDIR}/../xemacs/patches
4401: </pre>
4402: <p>Patch files that are distributed by the author or other
4403: maintainers can be listed in
4404: <code class="varname">PATCHFILES</code>.</p>
4405: <p>If it is desired to store any patches that should not be
4406: committed into pkgsrc, they can be kept outside the pkgsrc
4407: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4408: directory tree there is expected to have the same
4409: “<span class="quote">category/package</span>” structure as pkgsrc, and
4410: patches are expected to be stored inside these dirs (also
4411: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4412: example, if you want to keep a private patch for
4413: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4414: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4415: files in the named directory are expected to be patch files,
4416: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4417: applied</em></span>.</p>
4418: </div>
4419: <div class="sect2" lang="en">
4420: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4421: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4422: <p>When fixing a portability issue in the code do not use
4423: preprocessor magic to check for the current operating system nor
4424: platform. Doing so hurts portability to other platforms because
4425: the OS-specific details are not abstracted appropriately.</p>
4426: <p>The general rule to follow is: instead of checking for the
4427: operating system the application is being built on, check for the
4428: specific <span class="emphasis"><em>features</em></span> you need. For example,
4429: instead of assuming that kqueue is available under NetBSD and
4430: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.11 ! rillig 4431: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4432: yes, this generally involves patching the
1.10 hubertf 4433: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4434: that prevents some OSes from adopting interfaces from other OSes
4435: (e.g. Linux implementing kqueue), something that the above checks
4436: cannot take into account.</p>
4437: <p>Of course, checking for features generally involves more
4438: work on the developer's side, but the resulting changes are
4439: cleaner and there are chances they will work on many other
4440: platforms. Not to mention that there are higher chances of being
4441: later integrated into the mainstream sources. Remember:
4442: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4443: <p>Some typical examples:</p>
4444: <div class="table">
1.6 rillig 4445: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4446: <div class="table-contents"><table summary="Patching examples" border="1">
4447: <colgroup>
4448: <col>
4449: <col>
4450: <col>
4451: </colgroup>
4452: <thead><tr>
4453: <th>Where</th>
4454: <th>Incorrect</th>
4455: <th>Correct</th>
4456: </tr></thead>
4457: <tbody>
4458: <tr>
4459: <td>configure script</td>
4460: <td>
4461: <pre class="programlisting">
4462: case ${target_os} in
4463: netbsd*) have_kvm=yes ;;
4464: *) have_kvm=no ;;
4465: esac
4466: </pre>
4467: </td>
4468: <td>
4469: <pre class="programlisting">
4470: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4471: </pre>
4472: </td>
4473: </tr>
4474: <tr>
4475: <td>C source file</td>
4476: <td>
4477: <pre class="programlisting">
4478: #if defined(__NetBSD__)
4479: # include <sys/event.h>
4480: #endif
4481: </pre>
4482: </td>
4483: <td>
4484: <pre class="programlisting">
4485: #if defined(HAVE_SYS_EVENT_H)
4486: # include <sys/event.h>
4487: #endif
4488: </pre>
4489: </td>
4490: </tr>
4491: <tr>
4492: <td>C source file</td>
4493: <td>
4494: <pre class="programlisting">
4495: int
4496: monitor_file(...)
4497: {
4498: #if defined(__NetBSD__)
4499: int fd = kqueue();
4500: ...
4501: #else
4502: ...
4503: #endif
4504: }
4505: </pre>
4506: </td>
4507: <td>
4508: <pre class="programlisting">
4509: int
4510: monitor_file(...)
4511: {
4512: #if defined(HAVE_KQUEUE)
4513: int fd = kqueue();
4514: ...
4515: #else
4516: ...
4517: #endif
4518: }
4519: </pre>
4520: </td>
4521: </tr>
4522: </tbody>
4523: </table></div>
4524: </div>
4525: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4526: 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
4527: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4528: 2</a>). It summarizes multiple details on how to make
4529: software easier to package; all the suggestions in it were
4530: collected from our experience in pkgsrc work, so they are possibly
4531: helpful when creating patches too.</p>
4532: </div>
4533: <div class="sect2" lang="en">
4534: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4535: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4536: <p>Always, always, <span class="strong"><strong>always</strong></span>
4537: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4538: improvements you do to a package to the mainstream developers.
4539: This is the only way to get their attention on portability issues
4540: and to ensure that future versions can be built out-of-the box on
4541: NetBSD. Furthermore, any user that gets newer distfiles will get
4542: the fixes straight from the packaged code.</p>
4543: <p>This generally involves cleaning up the patches
4544: (because sometimes the patches that are
4545: added to pkgsrc are quick hacks), filling bug reports in the
4546: appropriate trackers for the projects and working with the
4547: mainstream authors to accept your changes. It is
4548: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4549: the packages in pkgsrc are kept simple and thus further changes
4550: can be done without much hassle.</p>
4551: <p>Support the idea of free software!</p>
4552: </div>
4553: </div>
4554: <div class="sect1" lang="en">
4555: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4556: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1 dsieger 4557: <div class="variablelist"><dl>
4558: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4559: <dd><p>A multi-line description of the piece of software. This should include
4560: any credits where they are due. Please bear in mind that others do not
4561: share your sense of humour (or spelling idiosyncrasies), and that others
4562: will read everything that you write here.</p></dd>
4563: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4564: <dd><p>This file governs the files that are installed on your
4565: system: all the binaries, manual pages, etc. There are other
4566: directives which may be entered in this file, to control the
4567: creation and deletion of directories, and the location of
1.10 hubertf 4568: 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 4569: information.</p></dd>
4570: </dl></div>
4571: </div>
4572: <div class="sect1" lang="en">
4573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4574: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1 dsieger 4575: <div class="sect2" lang="en">
4576: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4577: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1 dsieger 4578: <div class="variablelist"><dl>
4579: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.10 hubertf 4580: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 4581: First time after package extraction and before files are
4582: moved in place, the second time after the files to install
4583: are moved in place. This can be used to do any custom
4584: procedures not possible with @exec commands in
1.10 hubertf 4585: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4586: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><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>.</p></dd>
1.1 dsieger 4587: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4588: <dd><p>This script is executed before and after any files are removed. It is
4589: this script's responsibility to clean up any additional messy details
4590: around the package's installation, since all pkg_delete knows is how to
4591: delete the files created in the original distribution.
1.10 hubertf 4592: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4593: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.1 dsieger 4594: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4595: <dd>
4596: <p>This file is displayed after installation of the package.
4597: Useful for things like legal notices on almost-free
4598: software and hints for updating config files after
4599: installing modules for apache, PHP etc.
4600: Please note that you can modify variables in it easily by using
4601: <code class="varname">MESSAGE_SUBST</code> in the package's
4602: <code class="filename">Makefile</code>:</p>
4603: <pre class="programlisting">
4604: MESSAGE_SUBST+= SOMEVAR="somevalue"
4605: </pre>
4606: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
4607: <code class="filename">MESSAGE</code>. By default, substitution is
4608: performed for <code class="varname">PKGNAME</code>,
4609: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4610: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4611: <code class="varname">X11BASE</code>,
4612: <code class="varname">PKG_SYSCONFDIR</code>,
4613: <code class="varname">ROOT_GROUP</code>, and
4614: <code class="varname">ROOT_GROUP</code>.</p>
4615: <p>You can display a different or additional files by
4616: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4617: default is <code class="filename">MESSAGE</code>, if the file
4618: exists.</p>
4619: </dd>
4620: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4621: <dd><p>FIXME: There is no documentation on the
4622: alternatives framework.</p></dd>
4623: </dl></div>
4624: </div>
4625: <div class="sect2" lang="en">
4626: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4627: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1 dsieger 4628: <div class="variablelist"><dl>
4629: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4630: <dd><p>This file contains arbitrary things that could
4631: also go into a <code class="filename">Makefile</code>, but its purpose is
4632: to be used by more than one package. This file should only be
4633: used when the packages that will use the file are known in
4634: advance. For other purposes it is often better to write a
4635: <code class="filename">*.mk</code> file and give it a good name that
4636: describes what it does.</p></dd>
4637: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4638: <dd><p>This file contains the dependency information
1.10 hubertf 4639: 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 4640: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4641: <dd><p>This file contains workarounds for compiler bugs
4642: and similar things. It is included automatically by the pkgsrc
4643: infrastructure, so you don't need an extra
4644: <code class="literal">.include</code> line for
4645: it.</p></dd>
4646: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4647: <dd><p>This file contains the code for the
1.10 hubertf 4648: 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 4649: selected by the user. If a package has only one or two options,
4650: it is equally acceptable to put the code directly into the
4651: <code class="filename">Makefile</code>.</p></dd>
4652: </dl></div>
4653: </div>
4654: <div class="sect2" lang="en">
4655: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4656: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1 dsieger 4657: <div class="variablelist"><dl>
4658: <dt><span class="term"><code class="filename">README*</code></span></dt>
4659: <dd><p>These files do not take place in the creation of
4660: a package and thus are purely informative to the package
4661: developer.</p></dd>
4662: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4663: <dd><p>This file contains things that need to be done
4664: to make the package even
4665: better.</p></dd>
4666: </dl></div>
4667: </div>
4668: </div>
4669: <div class="sect1" lang="en">
4670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4671: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4672: </h2></div></div></div>
1.10 hubertf 4673: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4674: unpacked into the directory denoted by
4675: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4676: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4677: directory is also used to keep various timestamp files.
4678: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4679: The default is <code class="filename">${.CURDIR}/work</code>
4680: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4681: if <code class="varname">OBJMACHINE</code> is set.</p>
4682: </div>
4683: <div class="sect1" lang="en">
4684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4685: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4686: </h2></div></div></div>
4687: <p>If you have any files that you wish to be placed in the package prior
4688: to configuration or building, you could place these files here and use
1.10 hubertf 4689: a <span class="command"><strong>${CP}</strong></span> command in the
1.1 dsieger 4690: “<span class="quote">pre-configure</span>” target to achieve
4691: this. Alternatively, you could simply diff the file against
4692: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4693: the creation of this file.</p>
4694: <p>If you want to share files in this way with other
4695: packages, set the <code class="varname">FILESDIR</code> variable to point
4696: to the other package's <code class="filename">files</code> directory,
4697: e.g.:</p>
4698: <pre class="programlisting">
4699: FILESDIR=${.CURDIR}/../xemacs/files
4700: </pre>
4701: </div>
4702: </div>
4703: <div class="chapter" lang="en">
4704: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4705: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4706: <div class="toc">
4707: <p><b>Table of Contents</b></p>
4708: <dl>
1.6 rillig 4709: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
4710: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
4711: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4712: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4713: <dd><dl>
4714: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4715: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4716: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4717: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4718: <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 4719: </dl></dd>
4720: </dl>
4721: </div>
4722: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4723: each of which forms a well-defined part of the pkgsrc system. Using
1.10 hubertf 4724: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4725: like pkgsrc requires some discipline to keep the code correct and
4726: understandable.</p>
4727: <p>The basic ingredients for <code class="filename">Makefile</code>
4728: programming are variables (which are actually macros) and shell
4729: commands. Among these shell commands may even be more complex ones
1.10 hubertf 4730: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4731: as intended it is necessary to quote all variables correctly when they
4732: are used.</p>
4733: <p>This chapter describes some patterns, that appear quite often in
4734: <code class="filename">Makefile</code>s, including the pitfalls that come along
4735: with them.</p>
4736: <div class="sect1" lang="en">
4737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4738: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.1 dsieger 4739: <div class="itemizedlist"><ul type="disc"><li>
4740: <p>When you are creating a file as a
4741: target of a rule, always write the data to a temporary file first
4742: and finally rename that file. Otherwise there might occur an error
4743: in the middle of generating the file, and when the user runs
1.10 hubertf 4744: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><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 4745: regenerated properly. Example:</p>
4746: <pre class="programlisting">
4747: wrong:
4748: @echo "line 1" > ${.TARGET}
4749: @echo "line 2" >> ${.TARGET}
4750: @false
4751:
4752: correct:
4753: @echo "line 1" > ${.TARGET}.tmp
4754: @echo "line 2" >> ${.TARGET}.tmp
4755: @false
4756: @mv ${.TARGET}.tmp ${.TARGET}
4757: </pre>
1.10 hubertf 4758: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4759: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4760: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4761: correct</strong></span> gives an error message twice, as expected.</p>
1.10 hubertf 4762: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4763: <code class="literal">${.TARGET}</code> in case of error, but this only
4764: happens when it is interrupted, for example by pressing
4765: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.10 hubertf 4766: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4767: </li></ul></div>
4768: </div>
4769: <div class="sect1" lang="en">
4770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4771: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4772: <p><code class="filename">Makefile</code> variables contain strings that
4773: can be processed using the five operators ``='', ``+='', ``?='',
1.10 hubertf 4774: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4775: page.</p>
4776: <p>When a variable's value is parsed from a
4777: <code class="filename">Makefile</code>, the hash character ``#'' and the
4778: backslash character ``\'' are handled specially. If a backslash is
4779: followed by a newline, any whitespace immediately in front of the
4780: backslash, the backslash, the newline, and any whitespace
4781: immediately behind the newline are replaced with a single space. A
4782: backslash character and an immediately following hash character are
4783: replaced with a single hash character. Otherwise, the backslash is
4784: passed as is. In a variable assignment, any hash character that is
4785: not preceded by a backslash starts a comment that continues upto the
4786: end of the logical line.</p>
4787: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4788: the only way to create a variable consisting of a single backslash
4789: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4790: <p>So far for defining variables. The other thing you can do with
4791: variables is evaluating them. A variable is evaluated when it is
4792: part of the right side of the ``:='' or the ``!='' operator, or
4793: directly before executing a shell command which the variable is part
1.10 hubertf 4794: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.1 dsieger 4795: is, variables are not evaluated until there's no other way. The
4796: ``modifiers'' mentioned in the man page also evaluate the
4797: variable.</p>
4798: <p>Some of the modifiers split the string into words and then
4799: operate on the words, others operate on the string as a whole. When
4800: a string is split into words, it is split as you would expect
1.10 hubertf 4801: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.11 ! rillig 4802: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 4803: loop does not follow the shell quoting rules but splits at sequences
4804: of whitespace.</p>
4805: <p>There are several types of variables that should be handled
4806: differently. Strings and two types of lists.</p>
4807: <div class="itemizedlist"><ul type="disc">
4808: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4809: characters. Nevertheless, you should restrict yourself to only
4810: using printable characters. Examples are
4811: <code class="varname">PREFIX</code> and
4812: <code class="varname">COMMENT</code>.</p></li>
4813: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4814: are never exported to any shell command. Their elements are
4815: separated by whitespace. Therefore, the elements themselves cannot
4816: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 4817: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 4818: Examples are <code class="varname">DEPENDS</code> and
4819: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4820: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4821: may be exported to a shell command. Their elements can contain any
4822: characters, including whitespace. That's why they cannot be used
1.10 hubertf 4823: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 4824: <code class="varname">DISTFILES</code> and
4825: <code class="varname">MASTER_SITES</code>.</p></li>
4826: </ul></div>
4827: <div class="sect2" lang="en">
4828: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4829: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.1 dsieger 4830: <div class="itemizedlist"><ul type="disc">
4831: <li><p>All variable names starting with an underscore
4832: are reserved for use by the pkgsrc infrastructure. They shall
4833: not be used by package
4834: <code class="filename">Makefile</code>s.</p></li>
1.10 hubertf 4835: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 4836: lowercase variable names for the iteration
4837: variables.</p></li>
4838: <li><p>All list variables should have a ``plural''
4839: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4840: <code class="varname">DISTFILES</code>.</p></li>
4841: </ul></div>
4842: </div>
4843: </div>
4844: <div class="sect1" lang="en">
4845: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4846: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 4847: <p>This section presents you with some code snippets you should
4848: use in your own code. If you don't find anything appropriate here,
4849: you should test your code and add it here.</p>
4850: <div class="sect2" lang="en">
4851: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4852: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 4853: <pre class="programlisting">
4854: STRING= foo * bar `date`
4855: INT_LIST= # empty
4856: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4857: EXT_LIST= # empty
4858: ANOTHER_EXT_LIST= a=b c=d
4859:
4860: INT_LIST+= ${STRING} # 1
4861: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4862: EXT_LIST+= ${STRING:Q} # 3
4863: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4864: </pre>
4865: <p>When you add a string to an external list (example 3), it
4866: must be quoted. In all other cases, you must not add a quoting
4867: level. You must not merge internal and external lists, unless you
4868: are sure that all entries are correctly interpreted in both
4869: lists.</p>
4870: </div>
4871: <div class="sect2" lang="en">
4872: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4873: <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 4874: <pre class="programlisting">
4875: EXT_LIST= # empty
4876: .for i in ${INT_LIST}
4877: EXT_LIST+= ${i:Q}""
4878: .endfor
4879: </pre>
4880: <p>This code converts the internal list
4881: <code class="varname">INT_LIST</code> into the external list
4882: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4883: are unquoted they must be quoted here. The reason for appending
4884: <code class="varname">""</code> is explained below.</p>
4885: </div>
4886: <div class="sect2" lang="en">
4887: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4888: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 4889: <p>Sometimes you may want to print an arbitrary string. There
4890: are many ways to get it wrong and only few that can handle every
4891: nastiness.</p>
4892: <pre class="programlisting">
4893: STRING= foo bar < > * `date` $$HOME ' "
4894: EXT_LIST= string=${STRING:Q} x=second\ item
4895:
4896: all:
4897: echo ${STRING} # 1
4898: echo "${STRING}" # 2
4899: echo "${STRING:Q}" # 3
4900: echo ${STRING:Q} # 4
4901: echo x${STRING:Q} | sed 1s,.,, # 5
4902: printf "%s\\n" ${STRING:Q}"" # 6
4903: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4904: </pre>
4905: <p>Example 1 leads to a syntax error in the shell, as the
4906: characters are just copied.</p>
4907: <p>Example 2 leads to a syntax error too, and if you leave out
4908: the last " character from <code class="varname">${STRING}</code>,
1.10 hubertf 4909: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.1 dsieger 4910: variable would be evaluated, too.</p>
4911: <p>Example 3 outputs each space character preceded by a
4912: backslash (or not), depending on the implementation of the
1.10 hubertf 4913: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.1 dsieger 4914: <p>Example 4 handles correctly every string that does not start
4915: with a dash. In that case, the result depends on the
1.10 hubertf 4916: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.1 dsieger 4917: guarantee that your input does not start with a dash, this form is
4918: appropriate.</p>
4919: <p>Example 5 handles even the case of a leading dash
4920: correctly.</p>
4921: <p>Example 6 also works with every string and is the
4922: light-weight solution, since it does not involve a pipe, which has
4923: its own problems.</p>
4924: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4925: because the quoting has already been done when adding elements to
4926: the list.</p>
4927: <p>As internal lists shall not be passed to the shell, there is
4928: no example for it.</p>
4929: </div>
4930: <div class="sect2" lang="en">
4931: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4932: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 4933: <p>There are many possible sources of wrongly quoted variables.
4934: This section lists some of the commonly known ones.</p>
4935: <div class="itemizedlist"><ul type="disc">
4936: <li>
4937: <p>Whenever you use the value of a list, think
4938: about what happens to leading or trailing whitespace. If the
4939: list is a well-formed shell expression, you can apply the
4940: <code class="varname">:M*</code> modifier to strip leading and trailing
4941: whitespace from each word. The <code class="varname">:M</code> operator
4942: first splits its argument according to the rules of the shell,
4943: and then creates a new list consisting of all words that match
4944: the shell glob expression <code class="varname">*</code>, that is: all.
4945: One class of situations where this is needed is when adding a
4946: variable like <code class="varname">CPPFLAGS</code> to
4947: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4948: invokes other configure scripts, it strips the leading and
4949: trailing whitespace from the variable and then passes it to the
4950: other configure scripts. But these configure scripts expect the
4951: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4952: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4953: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4954: here is how we do it:</p>
4955: <pre class="programlisting">
4956: CPPFLAGS= # empty
4957: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4958: CPPFLAGS+= ${MY_CPPFLAGS}
4959:
4960: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4961:
4962: all:
4963: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4964: echo x${CONFIGURE_ARGS}x # properly trimmed
4965: </pre>
4966: </li>
4967: <li><p>The example above contains one bug: The
4968: <code class="varname">${PREFIX}</code> is a properly quoted shell
4969: expression, but there is the C compiler after it, which also
4970: expects a properly quoted string (this time in C syntax). The
4971: version above is therefore only correct if
4972: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4973: or double quotes. If you want to allow these, you have to add
4974: another layer of quoting to each variable that is used as a C
4975: string literal. You cannot use the <code class="varname">:Q</code>
4976: operator for it, as this operator only works for the
4977: shell.</p></li>
4978: <li>
4979: <p>Whenever a variable can be empty, the
4980: <code class="varname">:Q</code> operator can have surprising results. Here
4981: are two completely different cases which can be solved with the
4982: same trick.</p>
4983: <pre class="programlisting">
4984: EMPTY= # empty
4985: empty_test:
4986: for i in a ${EMPTY:Q} c; do \
4987: echo "$$i"; \
4988: done
4989:
4990: for_test:
4991: .for i in a:\ a:\test.txt
4992: echo ${i:Q}
4993: echo "foo"
4994: .endfor
4995: </pre>
4996: <p>The first example will only print two of the three lines
4997: we might have expected. This is because
4998: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
4999: the shell cannot see. The workaround is to write
5000: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5001: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5002: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5003: <p>The second example will only print three lines instead of
5004: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5005: This is because the backslash of the value
5006: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.10 hubertf 5007: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
5008: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.1 dsieger 5009: <code class="varname">${i:Q}""</code>.</p>
5010: </li>
5011: </ul></div>
5012: </div>
5013: <div class="sect2" lang="en">
5014: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5015: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 5016: <p>The pkgsrc bmake program does not handle the following
5017: assignment correctly. In case <code class="varname">_othervar_</code>
5018: contains a ``-'' character, one of the closing braces is included
5019: in <code class="varname">${VAR}</code> after this code executes.</p>
5020: <pre class="programlisting">
5021: VAR:= ${VAR:N${_othervar_:C/-//}}
5022: </pre>
5023: <p>For a more complex code snippet and a workaround, see the
5024: 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
5025: <code class="varname">bug1</code>.</p>
5026: </div>
5027: </div>
5028: </div>
5029: <div class="chapter" lang="en">
5030: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5031: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 5032: <div class="toc">
5033: <p><b>Table of Contents</b></p>
5034: <dl>
1.6 rillig 5035: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
5036: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.10 hubertf 5037: <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 5038: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5039: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
5040: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5041: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5042: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 5043: </dl>
5044: </div>
5045: <p>The <code class="filename">PLIST</code> file contains a package's
5046: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5047: the package (relative to the <code class="filename">${PREFIX}</code>
5048: directory it's been installed in) plus some additional statements
1.10 hubertf 5049: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 5050: This chapter addresses some issues that need attention when
5051: dealing with the <code class="filename">PLIST</code> file (or files, see
5052: below!).</p>
5053: <div class="sect1" lang="en">
5054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5055: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 5056: <p>Be sure to add a RCS ID line as the first thing in any
5057: <code class="filename">PLIST</code> file you write:</p>
5058: <pre class="programlisting">
5059: @comment $NetBSD$
5060: </pre>
5061: </div>
5062: <div class="sect1" lang="en">
5063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5064: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 5065: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 5066: to output a PLIST that matches any new files since the package
1.10 hubertf 5067: 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 5068: more information on this target.</p>
5069: </div>
5070: <div class="sect1" lang="en">
5071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 5072: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 5073: </h2></div></div></div>
5074: <p>If you have used any of the *-dirs packages, as explained in
1.10 hubertf 5075: <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
5076: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1 dsieger 5077: <code class="varname">@comment</code>s instead of real
5078: <code class="varname">@dirrm</code> lines. You can also do this for
5079: specific directories and files, so that the results of that
5080: command are very close to reality. This helps <span class="emphasis"><em>a
5081: lot</em></span> during the update of packages.</p>
5082: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5083: of AWK patterns and actions that are used to filter the output of
5084: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5085: scripting you like to it, but be careful with quoting.</p>
5086: <p>For example, to get all files inside the
5087: <code class="filename">libdata/foo</code> directory removed from the
5088: resulting PLIST:</p>
5089: <pre class="programlisting">
5090: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5091: </pre>
5092: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5093: to a specific (shared) directory converted to
5094: <code class="varname">@comment</code>s:</p>
5095: <pre class="programlisting">
5096: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5097: </pre>
5098: </div>
5099: <div class="sect1" lang="en">
5100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5101: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 5102: <p>A number of variables are substituted automatically in
5103: PLISTs when a package is installed on a system. This includes the
5104: following variables:</p>
5105: <div class="variablelist"><dl>
5106: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5107: <dd>
5108: <p>Some packages like emacs and perl embed information
5109: about which architecture they were built on into the
5110: pathnames where they install their files. To handle this
5111: case, PLIST will be preprocessed before actually used, and
5112: the symbol
5113: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
1.10 hubertf 5114: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 5115: same is done if the string
5116: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5117: PLIST somewhere - use this on packages that have GNU
5118: autoconf-created configure scripts.</p>
5119: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5120: <h3 class="title">Legacy note</h3>
5121: <p>There used to be a symbol
5122: “<span class="quote"><code class="varname">$ARCH</code></span>” that
1.10 hubertf 5123: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 5124: -m</strong></span>, but that's no longer supported and has
5125: been removed.</p>
5126: </div>
5127: </dd>
5128: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5129: <dd>
5130: <p>Some packages want to embed the OS name and version
5131: into some paths. To do this, use these variables in the
5132: <code class="filename">PLIST</code>:
5133: </p>
5134: <div class="itemizedlist"><ul type="disc">
1.10 hubertf 5135: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</p></li>
1.1 dsieger 5136: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
1.10 hubertf 5137: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</p></li>
1.1 dsieger 5138: </ul></div>
5139: </dd>
5140: </dl></div>
5141: <p>For a complete list of values which are replaced by
5142: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5143: search for <code class="varname">PLIST_SUBST</code>).</p>
5144: <p>If you want to change other variables not listed above, you
5145: can add variables and their expansions to this variable in the
1.10 hubertf 5146: 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 5147: <pre class="programlisting">
5148: PLIST_SUBST+= SOMEVAR="somevalue"
5149: </pre>
5150: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
5151: in the <code class="filename">PLIST</code> with
5152: “<span class="quote">somevalue</span>”.</p>
5153: </div>
5154: <div class="sect1" lang="en">
5155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5156: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5157: <p>Man pages should be installed in compressed form if
5158: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5159: and uncompressed otherwise. To handle this in the
5160: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5161: appended/removed automatically for man pages according to
5162: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5163: or not, see above for details. This modification of the
5164: <code class="filename">PLIST</code> file is done on a copy of it, not
5165: <code class="filename">PLIST</code> itself.</p>
5166: </div>
5167: <div class="sect1" lang="en">
5168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5169: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5170: </h2></div></div></div>
5171: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5172: in generating the binary package, set the variable
5173: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.10 hubertf 5174: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 5175: important. The default for <code class="varname">PLIST_SRC</code> is
5176: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5177: </div>
5178: <div class="sect1" lang="en">
5179: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5180: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5181: <p>Some packages decide to install a different set of files based on
5182: the operating system being used. These differences can be
5183: automatically handled by using the following files:</p>
5184: <div class="itemizedlist"><ul type="disc">
5185: <li><p><code class="filename">PLIST.common</code></p></li>
5186: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5187: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5188: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5189: <li><p><code class="filename">PLIST.common_end</code></p></li>
5190: </ul></div>
5191: </div>
5192: <div class="sect1" lang="en">
5193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5194: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.1 dsieger 5195: <p>A “<span class="quote">shared directory</span>” is a directory where
5196: multiple (and unrelated) packages install files. These
5197: directories are problematic because you have to add special tricks
5198: in the PLIST to conditionally remove them, or have some
5199: centralized package handle them.</p>
5200: <p>Within pkgsrc, you'll find both approaches. If a directory
5201: is shared by a few unrelated packages, it's often not worth to add
5202: an extra package to remove it. Therefore, one simply does:</p>
5203: <pre class="programlisting">
5204: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5205: </pre>
5206: <p>in the PLISTs of all affected packages, instead of the
5207: regular "@dirrm" line.</p>
5208: <p>However, if the directory is shared across many packages, two
5209: different solutions are available:</p>
5210: <div class="orderedlist"><ol type="1">
5211: <li><p>If the packages have a common dependency, the directory
5212: can be removed in that. For example, see
5213: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
5214: removes the shared directory
5215: <code class="filename">share/omf</code>.</p></li>
5216: <li><p>If the packages using the directory are not related at
5217: all (they have no common dependencies), a *-dirs package is
5218: used.</p></li>
5219: </ol></div>
5220: <p>From now on, we'll discuss the second solution. To get an
5221: idea of the *-dirs packages available, issue:</p>
5222: <pre class="programlisting">
5223: <code class="prompt">%</code> cd .../pkgsrc
5224: <code class="prompt">%</code> ls -d */*-dirs
5225: </pre>
5226: <p>Their use from other packages is very simple. The
5227: <code class="varname">USE_DIRS</code> variable takes a list of package names
5228: (without the “<span class="quote">-dirs</span>” part) together with the required
5229: version number (always pick the latest one when writing new
5230: packages).</p>
5231: <p>For example, if a package installs files under
5232: <code class="filename">share/applications</code>, it should have the
5233: following line in it:</p>
5234: <pre class="programlisting">
5235: USE_DIRS+= xdg-1.1
5236: </pre>
1.10 hubertf 5237: <p>After regenerating the PLIST using <span class="command"><strong>make
1.1 dsieger 5238: print-PLIST</strong></span>, you should get the right (commented out)
5239: lines.</p>
5240: <p>Note that even if your package is using
5241: <code class="filename">$X11BASE</code>, it must not depend on the
5242: *-x11-dirs packages. Just specify the name without that part and
5243: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5244: care of it.</p>
5245: </div>
5246: </div>
5247: <div class="chapter" lang="en">
5248: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5249: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5250: <div class="toc">
5251: <p><b>Table of Contents</b></p>
5252: <dl>
1.6 rillig 5253: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
5254: <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 5255: <dd><dl>
1.6 rillig 5256: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5257: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5258: </dl></dd>
1.6 rillig 5259: <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 5260: <dd><dl>
1.6 rillig 5261: <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>
5262: <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 5263: </dl></dd>
5264: </dl>
5265: </div>
5266: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5267: are seen by a package's configure and build processes. This is implemented
5268: in a two step process:</p>
5269: <div class="orderedlist"><ol type="1">
5270: <li><p>Symlink headers and libraries for dependencies into
5271: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5272: of <code class="varname">WRKDIR</code>.</p></li>
5273: <li><p>Create wrapper scripts that are used in place of the normal compiler
5274: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5275: <code class="option">-L${LOCALBASE}/lib</code> into references to
5276: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5277: native compiler on some operating systems look like GCC, so that
5278: packages that expect GCC won't require modifications to build with
5279: those native compilers.</p></li>
5280: </ol></div>
5281: <p>This normalizes the environment in which a package is built so that the
5282: package may be built consistently despite what other software may be
5283: installed. Please note that the normal system header and library paths,
5284: e.g. <code class="filename">/usr/include</code>,
5285: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5286: designed to insulate the package build from non-system-supplied
5287: software.</p>
5288: <div class="sect1" lang="en">
5289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5290: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5291: <p>The process of converting packages to use the buildlink3
5292: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5293: The things to keep in mind are:</p>
5294: <div class="orderedlist"><ol type="1">
5295: <li><p>Ensure that the build always calls the wrapper scripts
5296: instead of the actual toolchain. Some packages are tricky,
5297: and the only way to know for sure is the check
5298: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5299: wrappers are being invoked.</p></li>
5300: <li><p>Don't override <code class="varname">PREFIX</code> from within
5301: the package Makefile, e.g. Java VMs, standalone shells,
5302: etc., because the code to symlink files into
5303: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5304: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5305: </p></li>
5306: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5307: <code class="filename">buildlink3.mk</code> files that you list in a
5308: package's Makefile are added as dependencies for that package.
5309: </p></li>
5310: </ol></div>
5311: <p>If a dependency on a particular package is required for its libraries and
5312: headers, then we replace:</p>
5313: <pre class="programlisting">
5314: DEPENDS+= foo>=1.1.0:../../category/foo
5315: </pre>
5316: <p>with</p>
5317: <pre class="programlisting">
5318: .include "../../category/foo/buildlink3.mk"
5319: </pre>
5320: <p>The buildlink3.mk files usually define the required dependencies.
5321: If you need a newer version of the dependency when using buildlink3.mk
5322: files, then you can define it in your Makefile; for example:</p>
5323: <pre class="programlisting">
5324: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5325: .include "../../category/foo/buildlink3.mk"
5326: </pre>
5327: <p>There are several <code class="filename">buildlink3.mk</code>
5328: files in <code class="filename">pkgsrc/mk</code>
5329: that handle special package issues:</p>
5330: <div class="itemizedlist"><ul type="disc">
5331: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
5332: the native or a pkgsrc Berkeley DB implementation based on
5333: the values of <code class="varname">BDB_ACCEPTED</code> and
5334: <code class="varname">BDB_DEFAULT</code>.</p></li>
5335: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
5336: comes with neither Curses nor NCurses, this will take care
5337: 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>
5338: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
5339: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5340: adding a dependency on Heimdal or MIT-krb5 for packages that
5341: require a Kerberos 5 implementation.</p></li>
5342: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5343: system-provided Motif installation or adds a dependency on
5344: <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
5345: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5346: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5347: which Motif version will be used.</p></li>
5348: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
5349: variables that may be used by packages that use the
5350: Open Sound System (OSS) API.</p></li>
5351: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
5352: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
5353: the file for more information.</p></li>
5354: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
5355: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5356: 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>
5357: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
5358: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5359: library.</p></li>
5360: </ul></div>
5361: <p>The comments in those <code class="filename">buildlink3.mk</code>
5362: files provide a more complete
5363: description of how to use them properly.</p>
5364: </div>
5365: <div class="sect1" lang="en">
5366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5367: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5368: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5369: included by Makefiles to indicate the need to compile and link
5370: against header files and libraries provided by the package. A
5371: <code class="filename">buildlink3.mk</code> file should always provide
5372: enough information to add the correct type of dependency
5373: relationship and include any other
5374: <code class="filename">buildlink3.mk</code> files that it needs to find
5375: headers and libraries that it needs in turn.</p>
5376: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5377: 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>
5378: package is highly recommended. For most packages, the following
5379: command will generate a good starting point for
5380: <code class="filename">buildlink3.mk</code> files:</p>
5381: <pre class="screen">
5382: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5383: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5384: </pre>
5385: <div class="sect2" lang="en">
5386: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5387: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5388: <p>The following real-life example
5389: <code class="filename">buildlink3.mk</code> is taken
5390: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5391: <pre class="programlisting">
5392: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
5393:
5394: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5395: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
5396:
5397: .if ${BUILDLINK_DEPTH} == "+"
5398: BUILDLINK_DEPENDS+= tiff
5399: .endif
5400:
5401: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5402: BUILDLINK_PACKAGES+= tiff
5403:
5404: .if ${TIFF_BUILDLINK3_MK} == "+"
5405: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5406: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5407: .endif # TIFF_BUILDLINK3_MK
5408:
5409: .include "../../devel/zlib/buildlink3.mk"
5410: .include "../../graphics/jpeg/buildlink3.mk"
5411:
5412: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5413: </pre>
5414: <p>The header and footer manipulate
5415: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5416: <code class="filename">buildlink3.mk</code> files and is used to track
5417: at what depth we are including
5418: <code class="filename">buildlink3.mk</code> files.</p>
5419: <p>The first section controls if the dependency on
5420: <em class="replaceable"><code>pkg</code></em> is added.
5421: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5422: packages for which dependencies are added by
5423: buildlink3.</p>
5424: <p>The second section advises pkgsrc that the
5425: <code class="filename">buildlink3.mk</code> file for
5426: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5427: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5428: packages for which <code class="filename">buildlink3.mk</code> files
5429: have been included. It must <span class="emphasis"><em>always</em></span> be
5430: appended to within a <code class="filename">buildlink3.mk</code>
5431: file.</p>
5432: <p>The third section is protected from multiple inclusion
5433: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5434: added. Several important variables are set in the section:</p>
5435: <div class="itemizedlist"><ul type="disc">
5436: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5437: is the actual dependency recorded in the installed
5438: package; this should always be set using
1.10 hubertf 5439: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5440: we're appending to any pre-existing list of values. This
5441: variable should be set to the first version of the
5442: package that had an API change.
5443: </p></li>
5444: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5445: is the location of the <em class="replaceable"><code>pkg</code></em>
5446: pkgsrc directory.</p></li>
5447: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5448: (not shown above) controls whether we use
5449: <code class="varname">BUILD_DEPENDS</code> or
5450: <code class="varname">DEPENDS</code> to add the dependency on
5451: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5452: selected by setting
5453: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5454: to “<span class="quote">build</span>”. By default, the full dependency is
5455: used.</p></li>
5456: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
5457: and
5458: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5459: (not shown above) are lists of subdirectories of
5460: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5461: to add to the header and library search paths. These
5462: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
5463: respectively.</p></li>
5464: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
5465: (not shown above) is the list of preprocessor flags to add
5466: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5467: configure and build phases. The “<span class="quote">-I</span>” option
5468: should be avoided and instead be handled using
5469: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5470: above.</p></li>
5471: </ul></div>
5472: <p>The following variables are all optionally defined within
5473: this second section (protected against multiple inclusion) and
5474: control which package files are symlinked into
5475: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5476: transformed during the symlinking:</p>
5477: <div class="itemizedlist"><ul type="disc">
5478: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
5479: (not shown above) is a shell glob pattern relative to
5480: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5481: to be symlinked into
5482: <code class="filename">${BUILDLINK_DIR}</code>,
5483: e.g. <code class="filename">include/*.h</code>.</p></li>
5484: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5485: (not shown above) is a shell pipeline that
5486: outputs to stdout a list of files relative to
5487: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5488: The resulting files are to be symlinked
5489: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5490: this takes the <code class="filename">+CONTENTS</code> of a
5491: <em class="replaceable"><code>pkg</code></em> and filters it through
5492: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5493: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5494: (not shown above) is a filter command that filters
5495: <code class="filename">+CONTENTS</code> input into a list of files
5496: relative to
5497: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5498: on stdout. By default for overwrite packages,
5499: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5500: outputs the contents of the <code class="filename">include</code>
5501: and <code class="filename">lib</code> directories in the package
5502: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5503: it outputs any libtool archives in
5504: <code class="filename">lib</code> directories.</p></li>
5505: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
5506: (not shown above) is a list of sed arguments used to
5507: transform the name of the source filename into a
1.10 hubertf 5508: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5509: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5510: </ul></div>
5511: <p>The last section includes any
5512: <code class="filename">buildlink3.mk</code> needed for
5513: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5514: Including these <code class="filename">buildlink3.mk</code> files
5515: means that the headers and libraries for these
5516: dependencies are also symlinked into
5517: <code class="filename">${BUILDLINK_DIR}</code>
5518: whenever the <em class="replaceable"><code>pkg</code></em>
5519: <code class="filename">buildlink3.mk</code>
5520: file is included.</p>
5521: </div>
5522: <div class="sect2" lang="en">
5523: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5524: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.1 dsieger 5525: <p>The situation that requires increasing the dependency listed in
5526: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5527: after a package update is when the API or interface to the
5528: header files change.</p>
5529: <p>In this case,
5530: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5531: should be adjusted to require at least the new package
5532: version. In some cases, the packages that depend on this new
5533: version may need their <code class="varname">PKGREVISION</code>s
5534: increased and, if they have <code class="filename">buildlink3.mk</code>
5535: files, their
5536: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5537: adjusted, too. This is needed so pkgsrc will require the
5538: correct package dependency and not settle for an older one
5539: when building the source.</p>
5540: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5541: should be increased when the binary interface or sonames
5542: (major number of the library version) of any installed
5543: shared libraries change. This is needed so that binary
5544: packages made using it will require the correct package
5545: dependency and not settle for an older one which will not
5546: contain the necessary shared libraries.</p>
1.10 hubertf 5547: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.1 dsieger 5548: more information about dependencies on other packages,
5549: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
5550: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5551: <p>Please take careful consideration before adjusting
5552: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5553: or
5554: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5555: as we don't want to cause unneeded package deletions and
5556: rebuilds. In many cases, new versions of packages work just
5557: fine with older dependencies.</p>
5558: <p>Also it is not needed to set
5559: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5560: when it is identical to
5561: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5562: </div>
5563: </div>
5564: <div class="sect1" lang="en">
5565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5566: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5567: <p>Some packages in pkgsrc install headers and libraries that
5568: coincide with headers and libraries present in the base system.
5569: Aside from a <code class="filename">buildlink3.mk</code> file, these
5570: packages should also include a <code class="filename">builtin.mk</code>
5571: file that includes the necessary checks to decide whether using
5572: the built-in software or the pkgsrc software is
5573: appropriate.</p>
5574: <p>The only requirements of a builtin.mk file for
5575: <em class="replaceable"><code>pkg</code></em> are:</p>
5576: <div class="orderedlist"><ol type="1">
5577: <li><p>It should set
5578: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5579: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5580: after it is included.</p></li>
5581: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5582: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5583: which is already set before the
5584: <code class="filename">builtin.mk</code> file is included.</p></li>
5585: <li><p>It should be written to allow multiple inclusion. This
5586: is <span class="emphasis"><em>very</em></span> important and takes careful
5587: attention to <code class="filename">Makefile</code> coding.</p></li>
5588: </ol></div>
5589: <div class="sect2" lang="en">
5590: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5591: <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 5592: <p>The following is the recommended template for builtin.mk
5593: files:</p>
5594: <pre class="programlisting">
5595: .if !defined(IS_BUILTIN.foo)
5596: #
5597: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5598: # genuinely exists in the system or not.
5599: #
5600: IS_BUILTIN.foo?= no
5601:
5602: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5603: # version can be determined.
5604: #
5605: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5606: BUILTIN_PKG.foo?= foo-1.0
5607: . endif
5608: .endif # IS_BUILTIN.foo
5609:
5610: .if !defined(USE_BUILTIN.foo)
5611: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5612: . if defined(BUILTIN_PKG.foo)
5613: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5614: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5615: USE_BUILTIN.foo!= \
5616: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5617: && ${ECHO} "yes" || ${ECHO} "no"
5618: . endif
5619: . endfor
5620: . endif
5621: .endif # USE_BUILTIN.foo
5622:
5623: CHECK_BUILTIN.foo?= no
5624: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5625: #
5626: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5627: # "yes" or "no".
5628: #
5629: .endif # CHECK_BUILTIN.foo
5630: </pre>
5631: <p>The first section sets
5632: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5633: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5634: in the base system. This should not be a base system software
5635: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5636: it should only be “<span class="quote">yes</span>” if the actual package is
5637: included as part of the base system. This variable is only
5638: used internally within the <code class="filename">builtin.mk</code>
5639: file.</p>
5640: <p>The second section sets
5641: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5642: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5643: system if it exists (if
5644: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5645: is “<span class="quote">yes</span>”). This variable is only used internally
5646: within the <code class="filename">builtin.mk</code> file.</p>
5647: <p>The third section sets
5648: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5649: and is <span class="emphasis"><em>required</em></span> in all
5650: <code class="filename">builtin.mk</code> files. The code in this
5651: section must make the determination whether the built-in
5652: software is adequate to satisfy the dependencies listed in
5653: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5654: This is typically done by comparing
5655: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5656: against each of the dependencies in
5657: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5658: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5659: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5660: end of the <code class="filename">builtin.mk</code> file. Note that
5661: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5662: may be “<span class="quote">yes</span>” even if
5663: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5664: is “<span class="quote">no</span>” because we may make the determination
5665: that the built-in version of the software is similar enough to
5666: be used as a replacement.</p>
5667: <p>The last section is guarded by
5668: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5669: and includes code that uses the value of
5670: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5671: set in the previous section. This typically includes, e.g.,
5672: adding additional dependency restrictions and listing additional
5673: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5674: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5675: </div>
5676: <div class="sect2" lang="en">
5677: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5678: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5679: <p>When building packages, it's possible to choose whether to set
5680: a global preference for using either the built-in (native)
5681: version or the pkgsrc version of software to satisfy a
5682: dependency. This is controlled by setting
5683: <code class="varname">PREFER_PKGSRC</code> and
5684: <code class="varname">PREFER_NATIVE</code>. These variables take values
5685: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5686: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5687: use the pkgsrc versions of software, while
5688: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5689: built-in versions. Preferences are determined by the most
5690: specific instance of the package in either
5691: <code class="varname">PREFER_PKGSRC</code> or
5692: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5693: in neither or in both variables, then
5694: <code class="varname">PREFER_PKGSRC</code> has precedence over
5695: <code class="varname">PREFER_NATIVE</code>. For example, to require
5696: using pkgsrc versions of software for all but the most basic
5697: bits on a NetBSD system, you can set:</p>
5698: <pre class="programlisting">
5699: PREFER_PKGSRC= yes
5700: PREFER_NATIVE= getopt skey tcp_wrappers
5701: </pre>
5702: <p>A package <span class="emphasis"><em>must</em></span> have a
5703: <code class="filename">builtin.mk</code>
5704: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5705: otherwise it is simply ignored in that list.</p>
5706: </div>
5707: </div>
5708: </div>
5709: <div class="chapter" lang="en">
5710: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5711: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5712: <div class="toc">
5713: <p><b>Table of Contents</b></p>
5714: <dl>
1.6 rillig 5715: <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 5716: <dd><dl>
1.6 rillig 5717: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5718: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5719: </dl></dd>
1.6 rillig 5720: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5721: <dd><dl>
1.6 rillig 5722: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5723: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5724: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5725: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5726: </dl></dd>
5727: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5728: <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>
5729: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5730: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5731: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5732: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5733: <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 5734: </dl>
5735: </div>
5736: <p>This chapter describes the framework known as
5737: <code class="literal">pkginstall</code>, whose key features are:</p>
5738: <div class="itemizedlist"><ul type="disc">
5739: <li><p>Generic installation and manipulation of directories and files
5740: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5741: <li><p>Automatic handling of configuration files during installation,
5742: provided that packages are correctly designed.</p></li>
5743: <li><p>Generation and installation of system startup scripts.</p></li>
5744: <li><p>Registration of system users and groups.</p></li>
5745: <li><p>Registration of system shells.</p></li>
5746: <li><p>Automatic updating of fonts databases.</p></li>
5747: </ul></div>
5748: <p>The following sections inspect each of the above points in detail.</p>
5749: <p>You may be thinking that many of the things described here could be
5750: easily done with simple code in the package's post-installation target
5751: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5752: as the code in them is only executed when building from source. Machines
5753: using binary packages could not benefit from it at all (as the code itself
5754: could be unavailable). Therefore, the only way to achieve any of the items
5755: described above is by means of the installation scripts, which are
5756: automatically generated by pkginstall.</p>
5757: <div class="sect1" lang="en">
5758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5759: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5760: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5761: of files and directories that belong to a package. The names used in it
5762: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5763: which means that it cannot register files outside this directory (absolute
5764: path names are not allowed). Despite this restriction, some packages need
5765: to install files outside this location; e.g., under
5766: <code class="filename">${VARBASE}</code> or
5767: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5768: is to create such files during installation time by using
5769: installation scripts.</p>
5770: <p>The generic installation scripts are shell scripts that can
5771: contain arbitrary code. The list of scripts to execute is taken from
5772: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5773: <code class="filename">INSTALL</code>. A similar variable exists for package
5774: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5775: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5776: commands, so they have the potential to create and manage files
5777: anywhere in the file system.</p>
5778: <p>Using these general installation files is not recommended, but
5779: may be needed in some special cases. One reason for avoiding them is
5780: that the user has to trust the packager that there is no unwanted or
5781: simply erroneous code included in the installation script. Also,
5782: previously there were many similar scripts for the same functionality,
5783: and fixing a common error involved finding and changing all of
5784: them.</p>
5785: <p>The pkginstall framework offers another, standardized way. It
5786: provides generic scripts to abstract the manipulation of such files
5787: and directories based on variables set in the package's
5788: <code class="filename">Makefile</code>. The rest of this section describes
5789: these variables.</p>
5790: <div class="sect2" lang="en">
5791: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5792: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5793: <p>The following variables can be set to request the creation of
5794: directories anywhere in the file system:</p>
5795: <div class="itemizedlist"><ul type="disc">
5796: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5797: contain a list of directories that should be created and should attempt
5798: to be destroyed by the installation scripts. The difference between
5799: the two is that the latter prompts the administrator to remove any
5800: directories that may be left after deinstallation (because they were
5801: not empty), while the former does not.</p></li>
5802: <li>
5803: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5804: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5805: which directories should be created and should attempt to be destroyed
5806: by the installation scripts. Each tuple holds the following values,
5807: separated by spaces: the directory name, its owner, its group and its
5808: numerical mode. For example:</p>
5809: <pre class="programlisting">
5810: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5811: </pre>
5812: <p>The difference between the two is exactly the same as their
5813: non-<code class="varname">PERMS</code> counterparts.</p>
5814: </li>
5815: </ul></div>
5816: </div>
5817: <div class="sect2" lang="en">
5818: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5819: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 5820: <p>Creating non-empty files outside the installation prefix is tricky
5821: because the <code class="filename">PLIST</code> forces all files to be inside it.
5822: To overcome this problem, the only solution is to extract the file in the
5823: known place (i.e., inside the installation prefix) and copy it to the
5824: appropriate location during installation (done by the installation scripts
5825: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5826: file</em></span> in the following paragraphs, which describe the variables
5827: that can be used to automatically and consistently handle files outside the
5828: installation prefix:</p>
5829: <div class="itemizedlist"><ul type="disc">
5830: <li>
5831: <p><code class="varname">CONF_FILES</code> and
5832: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5833: During installation time, the master file is copied to the target one
5834: if and only if the latter does not exist. Upon deinstallation, the
5835: target file is removed provided that it was not modified by the
5836: installation.</p>
5837: <p>The difference between the two is that the latter prompts the
5838: administrator to remove any files that may be left after
5839: deinstallation (because they were not empty), while the former does
5840: not.</p>
5841: </li>
5842: <li>
5843: <p><code class="varname">CONF_FILES_PERMS</code> and
5844: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5845: files as well as their target locations. For each of them, it also
5846: specifies their owner, their group and their numeric permissions, in
5847: this order. For example:</p>
5848: <pre class="programlisting">
5849: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
5850: </pre>
5851: <p>The difference between the two is exactly the same as their
5852: non-<code class="varname">PERMS</code> counterparts.</p>
5853: </li>
5854: </ul></div>
5855: </div>
5856: </div>
5857: <div class="sect1" lang="en">
5858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5859: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 5860: <p>Configuration files are special in the sense that they are installed
5861: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5862: need special treatment during installation (most of which is automated by
5863: pkginstall). The main concept you must bear in mind is that files marked
5864: as configuration files are automatically copied to the right place (somewhere
5865: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5866: and only if</em></span> they didn't exist before. Similarly, they will not
5867: be removed if they have local modifications. This ensures that
5868: administrators never lose any custom changes they may have made.</p>
5869: <div class="sect2" lang="en">
5870: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5871: <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 5872: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5873: specifies where configuration files shall be installed. Its contents are
5874: set based upon the following variables:</p>
5875: <div class="itemizedlist"><ul type="disc">
5876: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
5877: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5878: be overridden by the user to point to his preferred location (e.g.,
5879: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5880: Packages must not use it directly.</p></li>
5881: <li>
5882: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5883: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5884: for the package being built shall be installed. The definition of this
5885: variable only makes sense in the package's
5886: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5887: <p>As an example, consider the Apache package,
5888: <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
5889: configuration files under the
5890: <code class="filename">httpd/</code> subdirectory of
5891: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5892: Makefile.</p>
5893: </li>
5894: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5895: variable that holds this package's configuration directory (if
5896: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5897: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5898: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5899: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5900: directory where the configuration files for the package identified by
5901: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5902: </ul></div>
5903: <p>Based on the above variables, pkginstall determines the value of
5904: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5905: variable that can be used within a package to refer to its configuration
5906: directory. The algorithm used to set its value is basically the
5907: following:</p>
5908: <div class="orderedlist"><ol type="1">
5909: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5910: its value is used.</p></li>
5911: <li><p>If the previous variable is not defined but
5912: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5913: <code class="filename">Makefile</code>, the resulting value is
5914: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
5915: <li><p>Otherwise, it is set to
5916: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5917: </ol></div>
5918: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.10 hubertf 5919: 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.</p>
1.1 dsieger 5920: </div>
5921: <div class="sect2" lang="en">
5922: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5923: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 5924: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5925: known place, you need to teach each package where it shall install its
5926: files. In some cases you will have to patch the package Makefiles to
5927: achieve it. If you are lucky, though, it may be as easy as passing an
5928: extra flag to the configuration script; this is the case of GNU Autoconf-
5929: generated files:</p>
5930: <pre class="programlisting">
5931: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5932: </pre>
5933: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5934: for</em></span> its configuration files, not where they will be originally
5935: installed (although the difference is never explicit,
5936: unfortunately).</p>
5937: </div>
5938: <div class="sect2" lang="en">
5939: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5940: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 5941: <p>As said before, pkginstall automatically handles configuration files.
5942: This means that <span class="strong"><strong>the packages themselves must not
5943: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
5944: directly</strong></span>. Bad news is that many software installation scripts
5945: will, out of the box, mess with the contents of that directory. So what is
5946: the correct procedure to fix this issue?</p>
5947: <p>You must teach the package (usually by manually patching it) to
5948: install any configuration files under the examples hierarchy,
5949: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5950: <code class="filename">PLIST</code> registers them and the administrator always
5951: has the original copies available.</p>
5952: <p>Once the required configuration files are in place (i.e., under the
5953: examples hierarchy), the pkginstall framework can use them as master copies
5954: during the package installation to update what is in
5955: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
5956: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 5957: 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 5958: about their syntax and their purpose. Here is an example, taken from the
5959: <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>
5960: <pre class="programlisting">
5961: EGDIR= ${PREFIX}/share/doc/mutt/samples
5962: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5963: </pre>
5964: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5965: package and has no meaning outside it.</p>
5966: </div>
5967: <div class="sect2" lang="en">
5968: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5969: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 5970: <p>The automatic copying of config files can be toggled by setting the
5971: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5972: installation.</p>
5973: </div>
5974: </div>
5975: <div class="sect1" lang="en">
5976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5977: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 5978: <p>System startup scripts are special files because they must be
5979: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 5980: 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 5981: can be used. However, pkginstall provides a special mechanism to handle
5982: these files.</p>
5983: <p>In order to provide system startup scripts, the package has
5984: to:</p>
5985: <div class="orderedlist"><ol type="1">
5986: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
5987: the <code class="literal">.sh</code> suffix appended. Considering the
5988: <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
5989: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
5990: <li>
5991: <p>Tell pkginstall to handle it, appending the name of the script,
5992: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
5993: Continuing the previous example:</p>
5994: <pre class="programlisting">
5995: RCD_SCRIPTS+= cupsd
5996: </pre>
5997: </li>
5998: </ol></div>
5999: <p>Once this is done, pkginstall will do the following steps for each
6000: script in an automated fashion:</p>
6001: <div class="orderedlist"><ol type="1">
6002: <li><p>Process the file found in the files directory applying all the
6003: substitutions described in the <code class="filename">FILES_SUBST</code>
6004: variable.</p></li>
6005: <li><p>Copy the script from the files directory to the examples
6006: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
6007: that this master file must be explicitly registered in the
6008: <code class="filename">PLIST</code>.</p></li>
6009: <li><p>Add code to the installation scripts to copy the startup script
6010: from the examples hierarchy into the system-wide startup scripts
6011: directory.</p></li>
6012: </ol></div>
6013: <div class="sect2" lang="en">
6014: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6015: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 6016: <p>The automatic copying of config files can be toggled by setting the
6017: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6018: installation. Note that the scripts will be always copied inside the
6019: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6020: matter what the value of this variable is.</p>
6021: </div>
6022: </div>
6023: <div class="sect1" lang="en">
6024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6025: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 6026: <p>If a package needs to create special users and/or groups during
6027: installation, it can do so by using the pkginstall framework.</p>
6028: <p>Users can be created by adding entries to the
6029: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6030: syntax:</p>
6031: <pre class="programlisting">
6032: user:group
6033: </pre>
6034: <p>Further specification of user details may be done by setting
6035: per-user variables.
6036: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6037: numeric UID for the user.
6038: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6039: user's description or comment.
6040: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6041: user's home directory, and defaults to
6042: <code class="filename">/nonexistent</code> if not specified.
6043: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6044: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6045: not specified.</p>
6046: <p>Similarly, groups can be created by adding entries to the
6047: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6048: <pre class="programlisting">
6049: group
6050: </pre>
6051: <p>The numeric GID of the group may be set by defining
6052: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6053: <p>If a package needs to create the users and groups at an earlier
6054: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6055: either <code class="literal">configure</code> or <code class="literal">build</code> to
6056: indicate the phase before which the users and groups are created. In
6057: this case, the numeric UIDs and GIDs of the created users and groups
6058: are automatically hardcoded into the final installation scripts.</p>
6059: </div>
6060: <div class="sect1" lang="en">
6061: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6062: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 6063: <p>Packages that install system shells should register them in the shell
6064: database, <code class="filename">/etc/shells</code>, to make things easier to the
6065: administrator. This must be done from the installation scripts to keep
6066: binary packages working on any system. pkginstall provides an easy way to
6067: accomplish this task.</p>
6068: <p>When a package provides a shell interpreter, it has to set the
6069: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6070: add some hooks to the installation scripts to handle it. Consider the
6071: 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>
6072: <pre class="programlisting">
6073: PKG_SHELL= ${PREFIX}/bin/zsh
6074: </pre>
6075: <div class="sect2" lang="en">
6076: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6077: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 6078: <p>The automatic registration of shell interpreters can be disabled by
6079: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6080: environment variable to <code class="literal">NO</code>.</p>
6081: </div>
6082: </div>
6083: <div class="sect1" lang="en">
6084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6085: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 6086: <p>Packages that install X11 fonts should update the database files
6087: that index the fonts within each fonts directory. This can easily be
6088: accomplished within the pkginstall framework.</p>
6089: <p>When a package installs X11 fonts, it must list the directories in
6090: which fonts are installed in the
6091: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6092: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6093: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6094: installation scripts to run the appropriate commands to update the fonts
6095: database files within each of those directories. For convenience, if the
6096: directory path is relative, it is taken to be relative to the package's
6097: 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>
6098: <pre class="programlisting">
6099: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6100: </pre>
6101: <div class="sect2" lang="en">
6102: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6103: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6104: <p>The automatic update of fonts databases can be disabled by
6105: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6106: environment variable to <code class="literal">NO</code>.</p>
6107: </div>
6108: </div>
6109: </div>
6110: <div class="chapter" lang="en">
6111: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6112: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6113: <div class="toc">
6114: <p><b>Table of Contents</b></p>
6115: <dl>
1.6 rillig 6116: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
6117: <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>
6118: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 6119: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6120: </dl>
6121: </div>
6122: <p>Many packages have the ability to be built to support different
6123: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6124: in pkgsrc that provides generic handling of those options that
6125: determine different ways in which the packages can be built. It's
6126: possible for the user to specify exactly which sets of options will be
6127: built into a package or to allow a set of global default options
6128: apply.</p>
1.7 rillig 6129: <p>There are two broad classes of behaviors that one might want to
6130: control via options. One is whether some particular feature is
6131: enabled in a program that will be built anyway, often by including or
6132: not including a dependency on some other package. The other is
6133: whether or not an additional program will be built as part of the
6134: package. Generally, it is better to make a split package for such
6135: additional programs instead of using options, because it enables
6136: binary packages to be built which can then be added separately. For
6137: example, the foo package might have minimal dependencies (those
6138: packages without which foo doesn't make sense), and then the foo-gfoo
6139: package might include the GTK frontend program gfoo. This is better
6140: than including a gtk option to foo that adds gfoo, because either that
6141: option is default, in which case binary users can't get foo without
6142: gfoo, or not default, in which case they can't get gfoo. With split
6143: packages, they can install foo without having GTK, and later decide to
6144: install gfoo (pulling in GTK at that time). This is an advantage to
6145: source users too, avoiding the need for rebuilds.</p>
6146: <p>Plugins with widely varying dependencies should usually be split
6147: instead of options.</p>
6148: <p>It is often more work to maintain split packages, especially if
6149: the upstream package does not support this. The decision of split
6150: vs. option should be made based on the likelihood that users will want
6151: or object to the various pieces, the size of the dependencies that are
6152: included, and the amount of work.</p>
6153: <p>A further consideration is licensing. Non-free parts, or parts
6154: that depend on non-free dependencies (especially plugins) should
6155: almost always be split if feasible.</p>
1.1 dsieger 6156: <div class="sect1" lang="en">
6157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6158: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6159: <p>Global default options are listed in
6160: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6161: that should be built into every package if that option is supported.
1.10 hubertf 6162: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6163: </div>
6164: <div class="sect1" lang="en">
6165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6166: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6167: </h2></div></div></div>
6168: <p>The following example shows how
6169: <code class="filename">bsd.options.mk</code> should be used
6170: by the hypothetical ``wibble'' package, either in the package
6171: <code class="filename">Makefile</code>, or in a file,
6172: e.g. <code class="filename">options.mk</code>, that is included by the
6173: main package <code class="filename">Makefile</code>.</p>
6174: <pre class="programlisting">
6175: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6176: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6177: PKG_OPTIONS_OPTIONAL_GROUPS= database
6178: PKG_OPTIONS_GROUP.database= mysql pgsql
6179: PKG_SUGGESTED_OPTIONS= wibble-foo
6180: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6181: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6182:
6183: .include "../../mk/bsd.prefs.mk"
6184:
6185: # this package was previously named wibble2
6186: .if defined(PKG_OPTIONS.wibble2)
6187: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6188: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6189: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6190: .endif
6191:
6192: .include "../../mk/bsd.options.mk"
6193:
6194: # Package-specific option-handling
6195:
6196: ###
6197: ### FOO support
6198: ###
6199: .if !empty(PKG_OPTIONS:Mwibble-foo)
6200: CONFIGURE_ARGS+= --enable-foo
6201: .endif
6202:
6203: ###
6204: ### LDAP support
6205: ###
6206: .if !empty(PKG_OPTIONS:Mldap)
6207: . include "../../databases/openldap-client/buildlink3.mk"
6208: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6209: .endif
6210:
6211: ###
6212: ### database support
6213: ###
6214: .if !empty(PKG_OPTIONS:Mmysql)
6215: . include "../../mk/mysql.buildlink3.mk"
6216: .endif
6217: .if !empty(PKG_OPTIONS:Mpgsql)
6218: . include "../../mk/pgsql.buildlink3.mk"
6219: .endif
6220: </pre>
6221: <p>The first section contains the information about which build
6222: options are supported by the package, and any default options settings
6223: if needed.</p>
6224: <div class="orderedlist"><ol type="1">
6225: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.10 hubertf 6226: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 6227: options. It should be set to
6228: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6229: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6230: at the point where the options are processed.</p></li>
6231: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6232: build options supported by the package.</p></li>
6233: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6234: list of names of groups of mutually exclusive options. The options in
6235: each group are listed in
6236: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6237: The most specific setting of any option from the group takes
6238: precedence over all other options in the group. Options from the
6239: groups will be automatically added to
6240: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6241: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6242: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6243: packages will fail if no option from the group is
6244: selected.</p></li>
6245: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6246: of names of sets of options. At least one option from each set must
6247: be selected. The options in each set are listed in
6248: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6249: Options from the sets will be automatically added to
6250: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6251: fail if no option from the set is selected.</p></li>
6252: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6253: build options which are enabled by default.</p></li>
6254: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6255: of
6256: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.10 hubertf 6257: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6258: their option counterparts. Pairs should be added with
6259: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6260: warning will be issued if the user uses a legacy
6261: variable.</p></li>
6262: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6263: of
6264: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6265: pairs that map options that have been renamed to their new
6266: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6267: the listing of global legacy options. A warning will be issued if
6268: the user uses a legacy option.</p></li>
6269: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6270: options implied by deprecated variables used. This can be used for
6271: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6272: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6273: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6274: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6275: a list of warnings about deprecated variables or options used, and
6276: what to use instead.</p></li>
6277: </ol></div>
6278: <p>A package should never modify
6279: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6280: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6281: To suggest a default set of options, use
6282: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6283: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6284: including <code class="filename">bsd.options.mk</code>. If none of
6285: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6286: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6287: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6288: happen with platform-specific options if none of them is supported on
6289: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6290: empty list and the package is otherwise treated as not using the
6291: options framework.</p>
6292: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6293: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6294: build options, properly filtered to remove unsupported and duplicate
6295: options.</p>
6296: <p>The remaining sections contain the logic that is specific to
6297: each option. The correct way to check for an option is to check
6298: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6299: <pre class="programlisting">
6300: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6301: </pre>
6302: </div>
6303: <div class="sect1" lang="en">
6304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6305: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6306: <p>Options that enable similar features in different packages (like
6307: optional support for a library) should use a common name in all
6308: packages that support it (like the name of the library). If another
6309: package already has an option with the same meaning, use the same
6310: name.</p>
6311: <p>Options that enable features specific to one package, where it's
6312: unlikely that another (unrelated) package has the same (or a similar)
6313: optional feature, should use a name prefixed with
6314: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6315: <p>If a group of related packages share an optional feature
6316: specific to that group, prefix it with the name of the
6317: “<span class="quote">main</span>” package
6318: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6319: <p>For new options, add a line to
6320: <code class="filename">mk/defaults/options.description</code>. Lines have two
6321: fields, separated by tab. The first field is the option name, the
6322: second its description. The description should be a whole sentence
6323: (starting with an uppercase letter and ending with a period) that
6324: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6325: support.</span>” The file is sorted by option names.</p>
6326: </div>
1.7 rillig 6327: <div class="sect1" lang="en">
6328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6329: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6330: <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 6331: different dependencies based on the options with which the package was
6332: built. For querying these options, the file
6333: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6334: typical example looks like this:</p>
6335: <pre class="programlisting">
6336: pkgbase := libpurple
6337: .include "../../mk/pkg-build-options.mk"
6338:
6339: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6340: ...
6341: .endif
6342: </pre>
6343: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6344: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6345: options of the libpurple package, which can then be queried like
6346: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6347: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6348: details.</p>
6349: </div>
1.1 dsieger 6350: </div>
6351: <div class="chapter" lang="en">
6352: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6353: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6354: <div class="toc">
6355: <p><b>Table of Contents</b></p>
6356: <dl>
1.6 rillig 6357: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6358: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6359: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6360: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
6361: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6362: <dd><dl>
6363: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6364: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6365: </dl></dd>
6366: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6367: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6368: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6369: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6370: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6371: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6372: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6373: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6374: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6375: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6376: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6377: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6378: </dl>
6379: </div>
6380: <div class="sect1" lang="en">
6381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6382: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6383: <p>This chapter gives a detailed description on how a package is
6384: built. Building a package is separated into different
6385: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6386: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6387: described in the following sections. Each phase is splitted into
6388: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6389: containing phase, prefixed by one of <code class="varname">pre-</code>,
6390: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6391: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6392: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6393: <p>Never override the regular targets (like
6394: <code class="varname">fetch</code>), if you have to, override the
6395: <code class="varname">do-*</code> ones instead.</p>
6396: <p>The basic steps for building a program are always the same. First
6397: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6398: the local system and then extracted. After any pkgsrc-specific patches
6399: to compile properly are applied, the software can be configured, then
6400: built (usually by compiling), and finally the generated binaries, etc.
6401: can be put into place on the system.</p>
6402: <p>To get more details about what is happening at each step,
6403: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6404: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6405: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6406: </div>
6407: <div class="sect1" lang="en">
6408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6409: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6410: <p>Before outlining the process performed by the NetBSD package system in
6411: the next section, here's a brief discussion on where programs are
6412: installed, and which variables influence this.</p>
6413: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6414: where all files of the final program shall be installed. It is
6415: usually set to <code class="varname">LOCALBASE</code>
6416: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6417: for pkgs in the <code class="filename">cross</code> category. The value of
6418: <code class="varname">PREFIX</code> needs to be put
6419: into the various places in the program's source where paths to
1.10 hubertf 6420: 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 6421: <p>When choosing which of these variables to use,
6422: follow the following rules:</p>
6423: <div class="itemizedlist"><ul type="disc">
6424: <li><p><code class="varname">PREFIX</code> always points to the location
6425: where the current pkg will be installed. When referring to a
6426: pkg's own installation path, use
6427: “<span class="quote">${PREFIX}</span>”.</p></li>
6428: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6429: are installed. If you need to construct a -I or -L argument
6430: to the compiler to find includes and libraries installed by
6431: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
6432: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6433: installed all packages in <code class="filename">/usr/local</code>. As
6434: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6435: administrator, this variable is a misnomer.</p></li>
6436: <li><p><code class="varname">X11BASE</code> is where the actual X11
6437: distribution (from xsrc, etc.) is installed. When looking for
6438: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6439: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6440: <li>
6441: <p>X11-based packages are special in that they may be
6442: installed in either <code class="varname">X11BASE</code> or
6443: <code class="varname">LOCALBASE</code>.</p>
6444: <p>Usually, X11 packages should be installed under
6445: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6446: will need to include
6447: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6448: request the presence of X11 and to get the right compilation
6449: flags.</p>
6450: <p>Even though, there are some packages that cannot be installed
6451: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6452: files. These packages are special and they must be placed under
6453: <code class="varname">X11BASE</code>. To accomplish this, set either
6454: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6455: your package.</p>
6456: <p>Some notes: If you need
6457: to find includes or libraries installed by a pkg that has
6458: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6459: its pkg <code class="filename">Makefile</code>, you need to look in
6460: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6461: <code class="filename">${LOCALBASE}</code>. To force installation of
6462: all X11 packages in <code class="varname">LOCALBASE</code>, the
6463: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6464: is enabled by default.</p>
6465: </li>
6466: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6467: the installed location of an X11
6468: package. <code class="varname">X11PREFIX</code> will be set to
6469: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6470: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6471: installed.</p></li>
6472: <li>
6473: <p>If xpkgwedge is installed, it is possible to have some
6474: packages installed in <code class="varname">X11BASE</code> and some in
6475: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6476: installed package, the <code class="varname">EVAL_PREFIX</code>
6477: definition can be used. It takes pairs in the format
1.10 hubertf 6478: “<span class="quote">DIRNAME=<package></span>”, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 6479: variable <code class="varname">DIRNAME</code> will be set to the prefix
6480: of the installed package <package>, or
6481: “<span class="quote">${X11PREFIX}</span>” if the package is not
6482: installed.</p>
6483: <p>This is best illustrated by example.</p>
6484: <p>The following lines are taken from
6485: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6486: <pre class="programlisting">
6487: EVAL_PREFIX+= GTKDIR=gtk+
6488: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6489: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6490: CONFIGURE_ARGS+= --enable-multibyte
6491: </pre>
6492: <p>Specific defaults can be defined for the packages
6493: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6494: definition of the form:</p>
6495: <pre class="programlisting">
6496: GTKDIR_DEFAULT= ${LOCALBASE}
6497: </pre>
6498: <p>where <code class="varname">GTKDIR</code> corresponds
6499: to the first definition in
6500: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6501: </li>
6502: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.10 hubertf 6503: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 6504: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6505: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6506: </ul></div>
6507: </div>
6508: <div class="sect1" lang="en">
6509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6510: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.1 dsieger 6511: <p>When building a package, a number of directories is used to store
6512: source files, temporary files, pkgsrc-internal files, and so on. These
6513: directories are explained here.</p>
6514: <p>Some of the directory variables contain relative pathnames. There
6515: are two common base directories for these relative directories:
6516: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6517: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6518: inside the package itself.</p>
6519: <div class="variablelist"><dl>
6520: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6521: <dd><p>This is an absolute pathname that points to the pkgsrc
6522: root directory. Generally, you don't need
6523: it.</p></dd>
6524: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6525: <dd><p>This is an absolute pathname that points to the
6526: current package.</p></dd>
6527: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6528: <dd><p>This is a pathname relative to
6529: <code class="varname">PKGSRCDIR</code> that points to the current
6530: package.</p></dd>
6531: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6532: <dd><p>This is an absolute pathname pointing to the directory
6533: where all work takes place. The distfiles are extracted to this
6534: directory. It also contains temporary directories and log files used by
6535: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6536: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6537: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6538: <dd><p>This is an absolute pathname pointing to the directory
6539: where the distfiles are extracted. It is usually a direct subdirectory
6540: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6541: that isn't hidden. This variable may be changed by a package
6542: <code class="filename">Makefile</code>.</p></dd>
6543: </dl></div>
6544: </div>
6545: <div class="sect1" lang="en">
6546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6547: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6548: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6549: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6550: phase. This will automatically run all phases that are required for this
6551: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6552: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6553: the package will be built, but not installed.</p>
6554: </div>
6555: <div class="sect1" lang="en">
6556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6557: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6558: <p>The first step in building a package is to fetch the
6559: distribution files (distfiles) from the sites that are providing
6560: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6561: phase.</p>
6562: <div class="sect2" lang="en">
6563: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6564: <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 6565: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6566: defines all URLs from where the distfile, whose name is
6567: derived from the <code class="varname">DISTNAME</code> variable, is
6568: fetched. The more complicated cases are described
6569: below.</p>
6570: <p>The variable <code class="varname">DISTFILES</code> specifies
6571: the list of distfiles that have to be fetched. Its value
6572: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6573: so that most packages don't need to define it at all.
6574: <code class="varname">EXTRACT_SUFX</code> is
6575: <code class="literal">.tar.gz</code> by default, but can be changed
6576: freely. Note that if your package requires additional
6577: distfiles to the default one, you cannot just append the
6578: additional filenames using the <code class="literal">+=</code>
6579: operator, but you have write for example:</p>
6580: <pre class="programlisting">
6581: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6582: </pre>
6583: <p>Each distfile is fetched from a list of sites, usually
6584: <code class="varname">MASTER_SITES</code>. If the package has multiple
6585: <code class="varname">DISTFILES</code> or multiple
6586: <code class="varname">PATCHFILES</code> from different sites, you can
6587: set
6588: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6589: to the list of URLs where the file
6590: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6591: (including the suffix) can be found.</p>
6592: <pre class="programlisting">
6593: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6594: DISTFILES+= foo-file.tar.gz
6595: SITES.foo-file.tar.gz= \
6596: http://www.somewhere.com/somehow/ \
6597: http://www.somewhereelse.com/mirror/somehow/
6598: </pre>
6599: <p>When actually fetching the distfiles, each item from
6600: <code class="varname">MASTER_SITES</code> or
6601: <code class="varname">SITES.*</code> gets the name of each distfile
6602: appended to it, without an intermediate slash. Therefore,
6603: all site values have to end with a slash or other separator
6604: character. This allows for example to set
6605: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6606: that gets the name of the distfile as a parameter. In this
6607: case, the definition would look like:</p>
6608: <pre class="programlisting">
6609: MASTER_SITES= http://www.example.com/download.cgi?file=
6610: </pre>
6611: <p>There are some predefined values for
6612: <code class="varname">MASTER_SITES</code>, which can be used in
6613: packages. The names of the variables should speak for
6614: themselves.</p>
6615: <pre class="programlisting">
6616: ${MASTER_SITE_APACHE}
6617: ${MASTER_SITE_BACKUP}
6618: ${MASTER_SITE_CYGWIN}
6619: ${MASTER_SITE_DEBIAN}
6620: ${MASTER_SITE_FREEBSD}
6621: ${MASTER_SITE_FREEBSD_LOCAL}
6622: ${MASTER_SITE_GENTOO}
6623: ${MASTER_SITE_GNOME}
6624: ${MASTER_SITE_GNU}
6625: ${MASTER_SITE_GNUSTEP}
6626: ${MASTER_SITE_IFARCHIVE}
6627: ${MASTER_SITE_KDE}
6628: ${MASTER_SITE_MOZILLA}
6629: ${MASTER_SITE_MYSQL}
6630: ${MASTER_SITE_OPENOFFICE}
6631: ${MASTER_SITE_PERL_CPAN}
6632: ${MASTER_SITE_PGSQL}
6633: ${MASTER_SITE_R_CRAN}
6634: ${MASTER_SITE_SOURCEFORGE}
6635: ${MASTER_SITE_SOURCEFORGE_JP}
6636: ${MASTER_SITE_SUNSITE}
6637: ${MASTER_SITE_SUSE}
6638: ${MASTER_SITE_TEX_CTAN}
6639: ${MASTER_SITE_XCONTRIB}
6640: ${MASTER_SITE_XEMACS}
6641: </pre>
6642: <p>Some explanations for the less self-explaining ones:
6643: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.10 hubertf 6644: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
6645: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.1 dsieger 6646: <p>If you choose one of these predefined sites, you may
6647: want to specify a subdirectory of that site. Since these
6648: macros may expand to more than one actual site, you
6649: <span class="emphasis"><em>must</em></span> use the following construct to
6650: specify a subdirectory:</p>
6651: <pre class="programlisting">
6652: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6653: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6654: </pre>
6655: <p>Note the trailing slash after the subdirectory
6656: name.</p>
6657: </div>
6658: <div class="sect2" lang="en">
6659: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6660: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6661: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6662: all the distfiles exist in a local directory
6663: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6664: user). If the files do not exist, they are fetched using
6665: commands of the form</p>
6666: <pre class="programlisting">
6667: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6668: </pre>
6669: <p>where <code class="literal">${site}</code> varies through
6670: several possibilities in turn: first,
6671: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6672: sites specified in either <code class="varname">SITES.file</code> if
6673: defined, else <code class="varname">MASTER_SITES</code> or
6674: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6675: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6676: all except the first and the last can be optionally sorted
6677: by the user, via setting either
6678: <code class="varname">MASTER_SORT_RANDOM</code>, and
6679: <code class="varname">MASTER_SORT_AWK</code> or
6680: <code class="varname">MASTER_SORT_REGEX</code>.</p>
6681: <p>The distfiles mirror run by the NetBSD Foundation uses the
6682: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6683: distfiles, if they are freely distributable. Packages setting
6684: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6685: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6686: mirrored.</p>
6687: </div>
6688: </div>
6689: <div class="sect1" lang="en">
6690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6691: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6692: <p>After the distfile(s) are fetched, their checksum is
6693: generated and compared with the checksums stored in the
6694: distinfo file. If the checksums don't match, the build is
6695: aborted. This is to ensure the same distfile is used for
6696: building, and that the distfile wasn't changed, e.g. by some
6697: malign force, deliberately changed distfiles on the master
6698: distribution site or network lossage.</p>
6699: </div>
6700: <div class="sect1" lang="en">
6701: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6702: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6703: <p>When the distfiles are present on the local system, they
6704: need to be extracted, as they usually come in the form of some
6705: compressed archive format.</p>
6706: <p>By default, all <code class="varname">DISTFILES</code> are
6707: extracted. If you only need some of them, you can set the
6708: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6709: files.</p>
6710: <p>Extracting the files is usually done by a little
6711: program, <code class="filename">mk/extract/extract</code>, which
6712: already knows how to extract various archive formats, so most
6713: likely you will not need to change anything here. But if you
6714: need, the following variables may help you:</p>
6715: <div class="variablelist"><dl>
6716: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6717: <dd><p>Use these variables to override the default
6718: options for an extract command, which are defined in
6719: <code class="filename">mk/extract/extract</code>.</p></dd>
6720: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6721: <dd><p>This variable can be set to
6722: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6723: default value), <code class="literal">pax</code>, or an
6724: absolute pathname pointing to the command with which tar
6725: archives should be
6726: extracted.</p></dd>
6727: </dl></div>
6728: <p>If the <code class="filename">extract</code> program doesn't
6729: serve your needs, you can also override the
6730: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6731: command used for extracting the files. This command is
6732: executed in the <code class="filename">${WRKSRC}</code>
6733: directory. During execution of this command, the shell
6734: variable <code class="varname">extract_file</code> holds the absolute
6735: pathname of the file that is going to be extracted.</p>
6736: <p>And if that still does not suffice, you can override the
6737: <code class="varname">do-extract</code> target in the package
6738: Makefile.</p>
6739: </div>
6740: <div class="sect1" lang="en">
6741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6742: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6743: <p>After extraction, all the patches named by the
6744: <code class="varname">PATCHFILES</code>, those present in the patches
6745: subdirectory of the package as well as in
6746: $LOCALPATCHES/$PKGPATH (e.g.
6747: <code class="filename">/usr/local/patches/graphics/png</code>) are
6748: applied. Patchfiles ending in <code class="filename">.Z</code> or
6749: <code class="filename">.gz</code> are uncompressed before they are
6750: applied, files ending in <code class="filename">.orig</code> or
6751: <code class="filename">.rej</code> are ignored. Any special options to
1.10 hubertf 6752: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
6753: <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>
6754: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 6755: it fail if the patches apply with some lines of fuzz. Please
6756: fix (regen) the patches so that they apply cleanly. The
6757: rationale behind this is that patches that don't apply cleanly
6758: may end up being applied in the wrong place, and cause severe
6759: harm there.</p>
6760: </div>
6761: <div class="sect1" lang="en">
6762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6763: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 6764: <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 6765: </p>
6766: </div>
6767: <div class="sect1" lang="en">
6768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6769: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6770: <p>This phase creates wrapper programs for the compilers and
6771: linkers. The following variables can be used to tweak the
6772: wrappers.</p>
6773: <div class="variablelist"><dl>
6774: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6775: <dd><p>The command used to print progress
6776: messages. Does nothing by default. Set to
6777: <code class="literal">${ECHO}</code> to see the progress
6778: messages.</p></dd>
6779: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6780: <dd><p>This variable can be set to
6781: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6782: depending on whether you want additional information in the
6783: wrapper log file.</p></dd>
6784: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6785: <dd><p>This variable can be set to
6786: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6787: on whether the wrapper should use its cache, which will
6788: improve the speed. The default value is
6789: <code class="literal">yes</code>, but is forced to
6790: <code class="literal">no</code> if the platform does not support
6791: it.</p></dd>
6792: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6793: <dd><p>A list of reordering commands. A reordering
6794: command has the form
6795: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6796: It ensures that that
6797: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6798: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6799: </p></dd>
6800: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6801: <dd><p>A list of transformation commands. [TODO:
6802: investigate further]</p></dd>
6803: </dl></div>
6804: </div>
6805: <div class="sect1" lang="en">
6806: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6807: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 6808: <p>Most pieces of software need information on the header
6809: files, system calls, and library routines which are available
6810: on the platform they run on. The process of determining this
6811: information is known as configuration, and is usually
6812: automated. In most cases, a script is supplied with the
6813: distfiles, and its invocation results in generation of header
6814: files, Makefiles, etc.</p>
6815: <p>If the package contains a configure script, this can be
6816: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6817: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6818: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6819: “<span class="quote">yes</span>” instead. What happens in the
6820: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6821: <pre class="programlisting">
6822: .for d in ${CONFIGURE_DIRS}
6823: cd ${WRKSRC} \
6824: && cd ${d} \
6825: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6826: .endfor
6827: </pre>
6828: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6829: “<span class="quote">.</span>”) is a list of pathnames relative to
6830: <code class="varname">WRKSRC</code>. In each of these directories, the
6831: configure script is run with the environment
6832: <code class="varname">CONFIGURE_ENV</code> and arguments
6833: <code class="varname">CONFIGURE_ARGS</code>. The variables
6834: <code class="varname">CONFIGURE_ENV</code>,
6835: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6836: “<span class="quote">./configure</span>”) and
6837: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6838: package.</p>
6839: <p>If the program uses an <code class="filename">Imakefile</code>
6840: for configuration, the appropriate steps can be invoked by
6841: setting <code class="varname">USE_IMAKE</code> to
6842: “<span class="quote">yes</span>”. (If you only want the package installed in
6843: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6844: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6845: xmkmf's environment by adding them to the
6846: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 ! rillig 6847: <p>If the program uses <code class="filename">cmake</code>
! 6848: for configuration, the appropriate steps can be invoked by
! 6849: setting <code class="varname">USE_CMAKE</code> to “<span class="quote">yes</span>”.
! 6850: You can add variables to cmake's environment by adding them to the
! 6851: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
! 6852: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
! 6853: The top directory argument is given by the
! 6854: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
! 6855: “<span class="quote">.</span>” (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 6856: <p>If there is no configure step at all, set
6857: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
6858: </div>
6859: <div class="sect1" lang="en">
6860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6861: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 6862: <p>For building a package, a rough equivalent of the
6863: following code is executed.</p>
6864: <pre class="programlisting">
6865: .for d in ${BUILD_DIRS}
6866: cd ${WRKSRC} \
6867: && cd ${d} \
6868: && env ${MAKE_ENV} \
6869: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6870: -f ${MAKE_FILE} \
6871: ${BUILD_TARGET}
6872: .endfor
6873: </pre>
6874: <p><code class="varname">BUILD_DIRS</code> (default:
6875: “<span class="quote">.</span>”) is a list of pathnames relative to
6876: <code class="varname">WRKSRC</code>. In each of these directories,
6877: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6878: <code class="varname">MAKE_ENV</code> and arguments
6879: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6880: <code class="varname">MAKE_ENV</code>,
6881: <code class="varname">BUILD_MAKE_FLAGS</code>,
6882: <code class="varname">MAKE_FILE</code> and
6883: <code class="varname">BUILD_TARGET</code> may all be changed by the
6884: package.</p>
6885: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
6886: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6887: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6888: default value of <code class="varname">MAKE_FILE</code> is
6889: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6890: defaults to “<span class="quote">all</span>”.</p>
6891: <p>If there is no build step at all, set
6892: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
6893: </div>
6894: <div class="sect1" lang="en">
6895: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6896: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 6897: <p>[TODO]</p>
6898: </div>
6899: <div class="sect1" lang="en">
6900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6901: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 6902: <p>Once the build stage has completed, the final step is to
6903: install the software in public directories, so users can
6904: access the programs and files.</p>
6905: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6906: equivalent of the following code is executed. Additionally,
6907: before and after this code, much magic is performed to do
6908: consistency checks, registering the package, and so on.</p>
6909: <pre class="programlisting">
6910: .for d in ${INSTALL_DIRS}
6911: cd ${WRKSRC} \
6912: && cd ${d} \
6913: && env ${MAKE_ENV} \
6914: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6915: -f ${MAKE_FILE} \
6916: ${INSTALL_TARGET}
6917: .endfor
6918: </pre>
6919: <p>The variable's meanings are analogous to the ones in the
6920: <span class="emphasis"><em>build</em></span> phase.
6921: <code class="varname">INSTALL_DIRS</code> defaults to
6922: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6923: is “<span class="quote">install</span>” by default, plus
6924: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6925: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6926: defined.</p>
6927: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
6928: variables are useful. They are all variations of the
1.10 hubertf 6929: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 6930: permissions preset. <code class="varname">INSTALL</code> is the plain
6931: install command. The specialized variants, together with their
6932: intended use, are:</p>
6933: <div class="variablelist"><dl>
6934: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
6935: <dd><p>directories that contain
6936: binaries</p></dd>
6937: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
6938: <dd><p>directories that contain
6939: scripts</p></dd>
6940: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
6941: <dd><p>directories that contain shared and static
6942: libraries</p></dd>
6943: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
6944: <dd><p>directories that contain data
6945: files</p></dd>
6946: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
6947: <dd><p>directories that contain man
6948: pages</p></dd>
6949: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
6950: <dd><p>binaries that can be stripped from debugging
6951: symbols</p></dd>
6952: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
6953: <dd><p>binaries that cannot be
6954: stripped</p></dd>
6955: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
6956: <dd><p>game
6957: binaries</p></dd>
6958: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
6959: <dd><p>shared and static
6960: libraries</p></dd>
6961: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6962: <dd><p>data files</p></dd>
6963: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
6964: <dd><p>data files for
6965: games</p></dd>
6966: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6967: <dd><p>man pages</p></dd>
6968: </dl></div>
6969: <p>Some other variables are:</p>
6970: <div class="variablelist"><dl>
6971: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6972: <dd><p>A list of directories relative to
6973: <code class="varname">PREFIX</code> that are created by pkgsrc at the
6974: beginning of the <span class="emphasis"><em>install</em></span> phase.
6975: The package is supposed to create all needed directories itself
6976: before installing files to it and list all other directories here.
6977: </p></dd>
6978: </dl></div>
6979: <p>In the rare cases that a package shouldn't install anything,
6980: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
6981: mostly relevant for packages in the <code class="filename">regress</code>
6982: category.</p>
6983: </div>
6984: <div class="sect1" lang="en">
6985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6986: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 6987: <p>Once the install stage has completed, a binary package of
6988: the installed files can be built. These binary packages can be
6989: used for quick installation without previous compilation, e.g. by
1.10 hubertf 6990: the <span class="command"><strong>make bin-install</strong></span> or by using
6991: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 6992: <p>By default, the binary packages are created in
6993: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
6994: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
6995: one for each category in the <code class="varname">CATEGORIES</code>
6996: variable. <code class="varname">PACKAGES</code> defaults to
6997: <code class="filename">pkgsrc/packages</code>.</p>
6998: <p>If there should be no binary package, set
6999: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7000: This should only be used in rare cases, like when a package
7001: definitely is only usable on the machine where it is built and even
7002: then, a binary package can be useful.</p>
7003: </div>
7004: <div class="sect1" lang="en">
7005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7006: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 7007: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 7008: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 7009: to clean the work directories of all dependencies too, use
1.10 hubertf 7010: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 7011: </div>
7012: <div class="sect1" lang="en">
7013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7014: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1 dsieger 7015: <div class="variablelist"><dl>
7016: <dt><span class="term">pre/post-*</span></dt>
7017: <dd><p>For any of the main targets described in the
7018: previous section, two auxiliary targets exist with
7019: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7020: prefix for the main target's name. These targets are
7021: invoked before and after the main target is called,
7022: allowing extra configuration or installation steps be
7023: performed from a package's Makefile, for example, which
7024: a program's configure script or install target
7025: omitted.</p></dd>
7026: <dt><span class="term">do-*</span></dt>
7027: <dd><p>Should one of the main targets do the wrong thing,
7028: and should there be no variable to fix this, you can
7029: redefine it with the do-* target. (Note that redefining
7030: the target itself instead of the do-* target is a bad
7031: idea, as the pre-* and post-* targets won't be called
7032: anymore, etc.) You will not usually need to do
7033: this.</p></dd>
7034: <dt><span class="term">reinstall</span></dt>
7035: <dd>
1.10 hubertf 7036: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 7037: you noticed some file was not installed properly, you
7038: can repeat the installation with this target, which will
7039: ignore the “<span class="quote">already installed</span>” flag.</p>
7040: <p>This is the default value of
7041: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 7042: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 7043: package</strong></span>, where the defaults are
7044: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7045: respectively.</p>
7046: </dd>
7047: <dt><span class="term">deinstall</span></dt>
7048: <dd>
1.10 hubertf 7049: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 7050: current directory, effectively de-installing the
7051: package. The following variables can be used to tune the
7052: behaviour:</p>
7053: <div class="variablelist"><dl>
7054: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.10 hubertf 7055: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 7056: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7057: <dd><p>Remove all packages that require (depend on)
7058: the given package. This can be used to remove any
7059: packages that may have been pulled in by a given
1.10 hubertf 7060: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 7061: DEINSTALLDEPENDS=1</strong></span> is done in
7062: <code class="filename">pkgsrc/x11/kde</code>, this is
7063: likely to remove whole KDE. Works by adding
1.10 hubertf 7064: “<span class="quote">-R</span>” to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 7065: command line.</p></dd>
7066: </dl></div>
7067: </dd>
7068: <dt><span class="term">bin-install</span></dt>
7069: <dd><p>Install a binary package from local disk and via FTP
7070: from a list of sites (see the
7071: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 7072: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 7073: available anywhere. The arguments given to
1.10 hubertf 7074: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 7075: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7076: operation, etc.</p></dd>
7077: <dt><span class="term">update</span></dt>
7078: <dd>
7079: <p>This target causes the current package to be
7080: updated to the latest version. The package and all
7081: depending packages first get de-installed, then current
7082: versions of the corresponding packages get compiled and
7083: installed. This is similar to manually noting which
7084: packages are currently installed, then performing a
1.10 hubertf 7085: series of <span class="command"><strong>make deinstall</strong></span> and
7086: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 7087: <code class="varname">UPDATE_TARGET</code> is set to) for these
7088: packages.</p>
7089: <p>You can use the “<span class="quote">update</span>” target to
1.10 hubertf 7090: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 7091: update</strong></span> was interrupted for some reason.
7092: However, in this case, make sure you don't call
1.10 hubertf 7093: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 7094: list of dependent packages in <code class="varname">WRKDIR</code>.
7095: Otherwise, you lose the ability to automatically update
7096: the current package along with the dependent packages
7097: you have installed.</p>
1.10 hubertf 7098: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 7099: update</strong></span> will only work as long as the package
7100: tree remains unchanged. If the source code for one of
7101: the packages to be updated has been changed, resuming
1.10 hubertf 7102: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 7103: fail!</p>
7104: <p>The following variables can be used either on the
1.10 hubertf 7105: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7106: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7107: update</strong></span>:</p>
7108: <div class="variablelist"><dl>
7109: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7110: <dd><p>Install target to recursively use for the
7111: updated package and the dependent packages.
7112: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7113: set, “<span class="quote">install</span>” otherwise for
1.10 hubertf 7114: <span class="command"><strong>make update</strong></span>. Other good
1.1 dsieger 7115: targets are “<span class="quote">package</span>” or
7116: “<span class="quote">bin-install</span>”. Do not set this to
7117: “<span class="quote">update</span>” or you will get stuck in an
7118: endless loop!</p></dd>
7119: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7120: <dd><p>Don't clean up after updating. Useful if
7121: you want to leave the work sources of the updated
7122: packages around for inspection or other purposes.
7123: Be sure you eventually clean up the source tree
7124: (see the “<span class="quote">clean-update</span>” target below)
7125: or you may run into troubles with old source code
7126: still lying around on your next
1.10 hubertf 7127: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7128: update</strong></span>.</p></dd>
7129: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7130: <dd><p>Deinstall each package before installing
7131: (making <code class="varname">DEPENDS_TARGET</code>). This
7132: may be necessary if the
7133: “<span class="quote">clean-update</span>” target (see below) was
1.10 hubertf 7134: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7135: update</strong></span>.</p></dd>
7136: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7137: <dd><p>Allows you to disable recursion and hardcode
7138: the target for packages. The default is
7139: “<span class="quote">update</span>” for the update target,
7140: facilitating a recursive update of prerequisite
7141: packages. Only set
7142: <code class="varname">DEPENDS_TARGET</code> if you want to
7143: disable recursive updates. Use
7144: <code class="varname">UPDATE_TARGET</code> instead to just
7145: set a specific target for each package to be
1.10 hubertf 7146: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7147: (see above).</p></dd>
7148: </dl></div>
7149: </dd>
7150: <dt><span class="term">clean-update</span></dt>
7151: <dd>
7152: <p>Clean the source tree for all packages that would
1.10 hubertf 7153: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7154: from the current directory. This target should not be
7155: used if the current package (or any of its depending
7156: packages) have already been de-installed (e.g., after
1.10 hubertf 7157: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7158: some packages you intended to update. As a rule of
7159: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7160: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7161: and only if you have a dirty package tree (e.g., if you
7162: used <code class="varname">NOCLEAN</code>).</p>
7163: <p>If you are unsure about whether your tree is
1.10 hubertf 7164: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7165: clean</strong></span> at the top of the tree, or use the
7166: following sequence of commands from the directory of the
7167: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7168: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7169: time, otherwise you lose all the packages you wanted to
7170: update!):</p>
7171: <pre class="screen">
7172: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7173: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7174: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7175: </pre>
7176: <p>The following variables can be used either on the
1.10 hubertf 7177: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7178: <span class="command"><strong>make clean-update</strong></span>:</p>
1.1 dsieger 7179: <div class="variablelist"><dl>
7180: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7181: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7182: reconstruct the list of directories to update for
1.10 hubertf 7183: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7184: update</strong></span> successfully installed all
7185: packages you wanted to update. Normally, this is
1.10 hubertf 7186: done automatically on <span class="command"><strong>make
1.1 dsieger 7187: update</strong></span>, but may have been suppressed by
7188: the <code class="varname">NOCLEAN</code> variable (see
7189: above).</p></dd>
7190: </dl></div>
7191: </dd>
7192: <dt><span class="term">replace</span></dt>
7193: <dd>
7194: <p>Update the installation of the current package. This
7195: differs from update in that it does not replace dependent
7196: 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
7197: target to work.</p>
7198: <p><span class="emphasis"><em>Be careful when using this
7199: target!</em></span> There are no guarantees that dependent
7200: packages will still work, in particular they will most
1.10 hubertf 7201: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7202: library package whose shared library major version changed
7203: between your installed version and the new one. For this
7204: reason, this target is not officially supported and only
7205: recommended for advanced users.</p>
7206: </dd>
7207: <dt><span class="term">info</span></dt>
1.10 hubertf 7208: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 7209: package. You can use this to check which version of a
7210: package is installed.</p></dd>
7211: <dt><span class="term">index</span></dt>
7212: <dd>
7213: <p>This is a top-level command, i.e. it should be used in
7214: the <code class="filename">pkgsrc</code> directory. It creates a
7215: database of all packages in the local pkgsrc tree, including
7216: dependencies, comment, maintainer, and some other useful
7217: information. Individual entries are created by running
1.10 hubertf 7218: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7219: directories. This index file is saved as
7220: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7221: verbose format by running <span class="command"><strong>make
1.1 dsieger 7222: print-index</strong></span>. You can search in it with
1.10 hubertf 7223: <span class="command"><strong>make search
1.1 dsieger 7224: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7225: extract a list of all packages that depend on a particular
1.10 hubertf 7226: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7227: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7228: <p>Running this command takes a very long time, some
7229: hours even on fast machines!</p>
7230: </dd>
7231: <dt><span class="term">readme</span></dt>
7232: <dd>
7233: <p>This target generates a
7234: <code class="filename">README.html</code> file, which can be
7235: 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
7236: contain references to any packages which are in the
7237: <code class="varname">PACKAGES</code> directory on the local
7238: host. The generated files can be made to refer to URLs
7239: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7240: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7241: wanted to generate <code class="filename">README.html</code>
7242: files which pointed to binary packages on the local
7243: machine, in the directory
7244: <code class="filename">/usr/packages</code>, set
7245: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7246: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7247: <code class="varname">${PACKAGES}</code> directory and its
7248: subdirectories will be searched for all the binary
7249: packages.</p>
7250: <p>The target can be run at the toplevel or in category
7251: directories, in which case it descends recursively.</p>
7252: </dd>
7253: <dt><span class="term">readme-all</span></dt>
7254: <dd><p>This is a top-level command, run it in
7255: <code class="filename">pkgsrc</code>. Use this target to create a
7256: file <code class="filename">README-all.html</code> which contains a
7257: list of all packages currently available in the NetBSD
7258: Packages Collection, together with the category they belong
7259: to and a short description. This file is compiled from the
7260: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7261: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7262: readme</strong></span>.</p></dd>
7263: <dt><span class="term">cdrom-readme</span></dt>
7264: <dd><p>This is very much the same as the
7265: “<span class="quote">readme</span>” target (see above), but is to be
7266: used when generating a pkgsrc tree to be written to a
7267: CD-ROM. This target also produces
7268: <code class="filename">README.html</code> files, and can be made
7269: to refer to URLs based on
7270: <code class="varname">CDROM_PKG_URL_HOST</code> and
7271: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7272: <dt><span class="term">show-distfiles</span></dt>
7273: <dd><p>This target shows which distfiles and patchfiles
7274: are needed to build the package
7275: (<code class="varname">ALLFILES</code>, which contains all
7276: <code class="varname">DISTFILES</code> and
7277: <code class="varname">PATCHFILES</code>, but not
7278: <code class="filename">patches/*</code>).</p></dd>
7279: <dt><span class="term">show-downlevel</span></dt>
7280: <dd><p>This target shows nothing if the package is not
7281: installed. If a version of this package is installed,
7282: but is not the version provided in this version of
7283: pkgsrc, then a warning message is displayed. This target
7284: can be used to show which of your installed packages are
7285: downlevel, and so the old versions can be deleted, and
7286: the current ones added.</p></dd>
7287: <dt><span class="term">show-pkgsrc-dir</span></dt>
7288: <dd><p>This target shows the directory in the pkgsrc
7289: hierarchy from which the package can be built and
7290: installed. This may not be the same directory as the one
7291: from which the package was installed. This target is
7292: intended to be used by people who may wish to upgrade
7293: many packages on a single host, and can be invoked from
7294: the top-level pkgsrc Makefile by using the
7295: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
7296: <dt><span class="term">show-installed-depends</span></dt>
7297: <dd><p>This target shows which installed packages match
7298: the current package's <code class="varname">DEPENDS</code>. Useful
7299: if out of date dependencies are causing build
7300: problems.</p></dd>
7301: <dt><span class="term">check-shlibs</span></dt>
7302: <dd><p>After a package is installed, check all its
7303: binaries and (on ELF platforms) shared libraries to see
7304: if they find the shared libs they need. Run by default
1.10 hubertf 7305: 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 7306: <dt><span class="term">print-PLIST</span></dt>
7307: <dd>
7308: <p>After a “<span class="quote">make install</span>” from a new or
7309: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7310: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7311: -newer work/.extract_done</strong></span>. An attempt is made
7312: to care for shared libs etc., but it is
7313: <span class="emphasis"><em>strongly</em></span> recommended to review the
7314: result before putting it into
7315: <code class="filename">PLIST</code>. On upgrades, it's useful to
7316: diff the output of this command against an already
7317: existing <code class="filename">PLIST</code> file.</p>
1.10 hubertf 7318: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 7319: other methods that don't update file access times, be
7320: sure to add these files manually to your
7321: <code class="filename">PLIST</code>, as the “<span class="quote">find
7322: -newer</span>” command used by this target won't catch
7323: them!</p>
1.10 hubertf 7324: <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 7325: information on this target.</p>
7326: </dd>
7327: <dt><span class="term">bulk-package</span></dt>
7328: <dd>
7329: <p>Used to do bulk builds. If an appropriate binary
7330: package already exists, no action is taken. If not, this
7331: target will compile, install and package it (and its
7332: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10 hubertf 7333: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.1 dsieger 7334: After creating the binary package, the sources, the
7335: just-installed package and its required packages are
7336: removed, preserving free disk space.</p>
7337: <p><span class="emphasis"><em>Beware that this target may deinstall
7338: all packages installed on a system!</em></span></p>
7339: </dd>
7340: <dt><span class="term">bulk-install</span></dt>
7341: <dd>
7342: <p>Used during bulk-installs to install required
7343: packages. If an up-to-date binary package is available,
1.10 hubertf 7344: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
7345: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7346: but the installed binary won't be removed.</p>
7347: <p>A binary package is considered
7348: “<span class="quote">up-to-date</span>” to be installed via
1.10 hubertf 7349: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.1 dsieger 7350: <div class="itemizedlist"><ul type="disc">
7351: <li><p>None of the package's files
7352: (<code class="filename">Makefile</code>, ...) were modified
7353: since it was built.</p></li>
7354: <li><p>None of the package's required (binary)
7355: packages were modified since it was built.</p></li>
7356: </ul></div>
7357: <p><span class="emphasis"><em>Beware that this target may deinstall
7358: all packages installed on a system!</em></span></p>
7359: </dd>
7360: </dl></div>
7361: </div>
7362: </div>
7363: <div class="chapter" lang="en">
7364: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7365: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7366: <div class="toc">
7367: <p><b>Table of Contents</b></p>
7368: <dl>
1.6 rillig 7369: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7370: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7371: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7372: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7373: </dl>
7374: </div>
7375: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7376: by pkgsrc and also for individual packages to define what commands
7377: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7378: or for later run-time of an installed packaged (such as
7379: <code class="varname">DEPENDS</code>).
7380: If the native system provides an adequate tool, then in many cases, a pkgsrc
7381: package will not be used.</p>
7382: <p>When building a package, the replacement tools are
7383: made available in a directory (as symlinks or wrapper scripts)
7384: that is early in the executable search path. Just like the buildlink
7385: system, this helps with consistent builds.</p>
7386: <p>A tool may be needed to help build a specific package. For example,
7387: perl, GNU make (gmake) or yacc may be needed.</p>
7388: <p>Also a tool may be needed, for example, because the native system's supplied
7389: tool may be inefficient for building a package with pkgsrc.
7390: For example, a package may need GNU awk, bison (instead of
7391: yacc) or a better sed.</p>
7392: <p>The tools used by a package can be listed by running
1.10 hubertf 7393: <span class="command"><strong>make show-tools</strong></span>.</p>
1.1 dsieger 7394: <div class="sect1" lang="en">
7395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7396: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7397: <p>The default set of tools used by pkgsrc is defined in
7398: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7399: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7400: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7401: These can be seen by running:
1.10 hubertf 7402: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7403: <p>If a package needs a specific program to build
7404: then the <code class="varname">USE_TOOLS</code> variable can be used
7405: to define the tools needed.</p>
7406: </div>
7407: <div class="sect1" lang="en">
7408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7409: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.1 dsieger 7410: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
7411: and not the native version for a build dependency.
7412: And the :run means that it is used for a
7413: run-time dependencies also (and becomes a DEPENDS).
7414: The default is a build dependency which can be set with
7415: :build. (So in this example, it is the same as gmake:build
7416: and pkg-config:build.)</p>
7417: <pre class="programlisting">
7418: USE_TOOLS+= mktemp:pkgsrc
7419: USE_TOOLS+= gmake perl:run pkg-config
7420: </pre>
7421: <p>When using the tools framework, a
7422: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7423: which contains the full path to the appropriate tool. For example,
7424: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
7425: on Linux systems.</p>
7426: <p>If you always need a pkgsrc version of the
7427: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7428: </p>
7429: </div>
7430: <div class="sect1" lang="en">
7431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7432: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7433: <p>When improving or porting pkgsrc to a new platform, have a look
7434: at (or create) the corresponding platform specific make file fragment under
7435: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7436: the name of the common tools. For example:</p>
7437: <pre class="programlisting">
7438: .if exists(/usr/bin/bzcat)
7439: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7440: .elif exists(/usr/bin/bzip2)
7441: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7442: .endif
7443:
7444: TOOLS_PLATFORM.true?= true # shell builtin
7445: </pre>
7446: </div>
7447: <div class="sect1" lang="en">
7448: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7449: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.1 dsieger 7450: <div class="qandaset">
7451: <dl>
1.6 rillig 7452: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7453: </dt>
1.6 rillig 7454: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7455: tools?</a>
7456: </dt>
1.6 rillig 7457: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7458: package is using while being built? I want to know whether it
7459: uses sed or not.</a>
7460: </dt>
7461: </dl>
7462: <table border="0" summary="Q and A Set">
7463: <col align="left" width="1%">
7464: <tbody>
7465: <tr class="question">
7466: <td align="left" valign="top">
1.11 ! rillig 7467: <a name="tools.new"></a><a name="id2727593"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7468: </td>
7469: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7470: </tr>
7471: <tr class="answer">
7472: <td align="left" valign="top"></td>
7473: <td align="left" valign="top"><p>TODO</p></td>
7474: </tr>
7475: <tr class="question">
7476: <td align="left" valign="top">
1.11 ! rillig 7477: <a name="tools.listall"></a><a name="id2727671"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7478: </td>
7479: <td align="left" valign="top"><p>How do I get a list of all available
7480: tools?</p></td>
7481: </tr>
7482: <tr class="answer">
7483: <td align="left" valign="top"></td>
7484: <td align="left" valign="top"><p>TODO</p></td>
7485: </tr>
7486: <tr class="question">
7487: <td align="left" valign="top">
1.11 ! rillig 7488: <a name="tools.used"></a><a name="id2727682"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7489: </td>
7490: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7491: package is using while being built? I want to know whether it
7492: uses sed or not.</p></td>
7493: </tr>
7494: <tr class="answer">
7495: <td align="left" valign="top"></td>
7496: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7497: to do it.)</p></td>
7498: </tr>
7499: </tbody>
7500: </table>
7501: </div>
7502: </div>
7503: </div>
7504: <div class="chapter" lang="en">
7505: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7506: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7507: <div class="toc">
7508: <p><b>Table of Contents</b></p>
7509: <dl>
1.6 rillig 7510: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7511: <dd><dl>
1.6 rillig 7512: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
7513: <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>
7514: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7515: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7516: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7517: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7518: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7519: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7520: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7521: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7522: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7523: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7524: </dl></dd>
7525: <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>
7526: <dd><dl>
7527: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7528: <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>
7529: </dl></dd>
7530: <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>
7531: <dd><dl>
7532: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7533: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7534: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7535: </dl></dd>
7536: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7537: <dd><dl>
7538: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7539: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7540: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7541: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7542: </dl></dd>
7543: <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>
7544: <dd><dl>
7545: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7546: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
7547: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7548: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7549: </dl></dd>
7550: <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>
7551: <dd><dl>
7552: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7553: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7554: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7555: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7556: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7557: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7558: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7559: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7560: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 7561: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
7562: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7563: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7564: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7565: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7566: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7567: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7568: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7569: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7570: emulation</a></span></dt>
1.6 rillig 7571: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7572: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7573: </dl></dd>
1.6 rillig 7574: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7575: </dl>
7576: </div>
7577: <div class="sect1" lang="en">
7578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7579: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 7580: <div class="sect2" lang="en">
7581: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7582: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7583: <p>One appealing feature of pkgsrc is that it runs on many
7584: different platforms. As a result, it is important to ensure,
7585: where possible, that packages in pkgsrc are portable. This
7586: chapter mentions some particular details you should pay
7587: attention to while working on pkgsrc.</p>
7588: </div>
7589: <div class="sect2" lang="en">
7590: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7591: <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 7592: </h3></div></div></div>
7593: <p>The pkgsrc user can configure pkgsrc by overriding several
7594: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7595: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7596: want to use those variables in the preprocessor directives of
1.10 hubertf 7597: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7598: <code class="literal">.for</code>), you need to include the file
7599: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7600: loads the user preferences.</p>
7601: <p>But note that some variables may not be completely defined
7602: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7603: included, as they may contain references to variables that are
7604: not yet defined. In shell commands this is no problem, since
7605: variables are actually macros, which are only expanded when they
7606: are used. But in the preprocessor directives mentioned above and
7607: in dependency lines (of the form <code class="literal">target:
7608: dependencies</code>) the variables are expanded at load
7609: time.</p>
7610: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7611: <h3 class="title">Note</h3>
7612: <p>Currently there is no exhaustive list of all
7613: variables that tells you whether they can be used at load time
7614: or only at run time, but it is in preparation.</p>
7615: </div>
7616: </div>
7617: <div class="sect2" lang="en">
7618: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7619: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7620: <p>Occasionally, packages require interaction from the user,
7621: and this can be in a number of ways:</p>
7622: <div class="itemizedlist"><ul type="disc">
7623: <li><p>When fetching the distfiles, some packages require user
7624: interaction such as entering username/password or accepting a
7625: license on a web page.</p></li>
7626: <li><p>When extracting the distfiles, some packages may ask for
7627: passwords.</p></li>
7628: <li><p>help to configure the package before it is built</p></li>
7629: <li><p>help during the build process</p></li>
7630: <li><p>help during the installation of a package</p></li>
7631: </ul></div>
7632: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7633: provided to notify the pkgsrc mechanism of an interactive stage
7634: which will be needed, and this should be set in the package's
7635: <code class="filename">Makefile</code>, e.g.:</p>
7636: <pre class="programlisting">
7637: INTERACTIVE_STAGE= build
7638: </pre>
7639: <p>Multiple interactive stages can be specified:</p>
7640: <pre class="programlisting">
7641: INTERACTIVE_STAGE= configure install
7642: </pre>
7643: <p>The user can then decide to skip this package by setting the
7644: <code class="varname">BATCH</code> variable.</p>
7645: </div>
7646: <div class="sect2" lang="en">
7647: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7648: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7649: <p>Authors of software can choose the licence under which
7650: software can be copied. This is due to copyright law, and reasons
7651: for license choices are outside the scope of pkgsrc. The pkgsrc
7652: system recognizes that there are a number of licenses which some
7653: users may find objectionable or difficult or impossible to comply
7654: with. The Free Software Foundation has declared some licenses
7655: "Free", and the Open Source Initiative has a definition of "Open
7656: Source". The pkgsrc system, as a policy choice, does not label
7657: packages which have licenses that are Free or Open Source.
7658: However, packages without a license meeting either of those tests
7659: are labeled with a license tag denoting the license. Note that a
7660: package with no license to copy trivially does not meet either the
7661: Free or Open Source test.</p>
7662: <p>For packages which are not Free or Open Source, pkgsrc will
7663: not build the package unless the user has indicated to pkgsrc that
7664: packages with that particular license may be built. Note that
7665: this documentation avoids the term "accepted the license". The
7666: pkgsrc system is merely providing a mechanism to avoid
7667: accidentally building a package with a non-free license;
7668: judgement and responsibility remain with the user. (Installation
7669: of binary packages are not currently subject to this mechanism;
7670: this is a bug.)</p>
7671: <p>One might want to only install packages with a BSD license,
7672: or the GPL, and not the other. The pkgsrc license tag mechanism
7673: does not provide a way to do this. It might be possible to put in
7674: tags for free licenses, and have a default
7675: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7676: widely viewed as having a very poor ratio of benefit to
7677: work.</p>
7678: <p>The license tag mechanism is intended to address
7679: copyright-related issues surrounding building, installing and
7680: using a package, and not to address redistribution issues (see
7681: <code class="varname">RESTRICTED</code> and
7682: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7683: definition of licenses for which tags are not needed implies
7684: that packages with redistribution restrictions should have
7685: tags, because Free or Open Source programs do not have
7686: redistribution restrictions.</p>
7687: <p>Denoting that a package may be copied according to a
7688: particular license is done by placing the license in
7689: <code class="filename">pkgsrc/licenses</code> and setting the
7690: <code class="varname">LICENSE</code> variable to a string identifying the
7691: 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>
7692: <pre class="programlisting">
7693: LICENSE= xv-license
7694: </pre>
7695: <p>When trying to build, the user will get a notice that the
7696: package is covered by a license which has not been placed in the
7697: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7698: <pre class="programlisting">
7699: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7700: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7701: ===> To view the license, enter "/usr/bin/make show-license".
7702: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7703: ===> ACCEPTABLE_LICENSES+=xv-license
7704: *** Error code 1
7705: </pre>
1.10 hubertf 7706: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7707: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7708: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7709: convey to pkgsrc that it should not in the future fail because of
7710: that license:</p>
7711: <pre class="programlisting">
7712: ACCEPTABLE_LICENSES+=xv-license
7713: </pre>
7714: <p>When adding a package with a new license, the license text
7715: should be added to <code class="filename">pkgsrc/licenses</code> for
7716: displaying. A list of known licenses can be seen in this
7717: directory.</p>
7718: <p>When the license changes (in a way other than formatting),
7719: please make sure that the new license has a different name (e.g.,
7720: append the version number if it exists, or the date). Just
7721: because a user told pkgsrc to build programs under a previous
7722: version of a license does not mean that pkgsrc should build
7723: programs under the new licenses. The higher-level point is that
7724: pkgsrc does not evaluate licenses for reasonableness; the only
7725: test is a mechanistic test of whether a particular text has been
7726: approved by either of two bodies.</p>
7727: <p>The use of <code class="varname">LICENSE=shareware</code>,
7728: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7729: is deprecated because it does not crisply refer to a particular
7730: license text. Another problem with such usage is that it does not
7731: enable a user to tell pkgsrc to proceed for a single package
7732: without also telling pkgsrc to proceed for all packages with that
7733: tag.</p>
7734: </div>
7735: <div class="sect2" lang="en">
7736: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7737: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7738: <p>Some licenses restrict how software may be re-distributed.
7739: Because a license tag is required unless the package is Free or
7740: Open Source, all packages with restrictions should have license
7741: tags. By declaring the restrictions, package tools can
7742: automatically refrain from e.g. placing binary packages on FTP
7743: sites.</p>
7744: <p>There are four restrictions that may be encoded, which are
7745: the cross product of sources (distfiles) and binaries not being
7746: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7747: language in any license, and because non-Free licenses tend to be
7748: different from each other, pkgsrc adopts a definition of FTP and
7749: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7750: should not be made available over the Internet at no charge.
7751: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7752: made available on some kind of media, together with other source
7753: and binary packages, and which is sold for a distribution charge.
7754: </p>
7755: <p>In order to encode these restrictions, the package system
7756: defines five make variables that can be set to note these
7757: restrictions:</p>
7758: <div class="itemizedlist"><ul type="disc">
7759: <li>
7760: <p><code class="varname">RESTRICTED</code></p>
7761: <p>This variable should be set whenever a restriction
7762: exists (regardless of its kind). Set this variable to a
7763: string containing the reason for the restriction. It should
7764: be understood that those wanting to understand the restriction
7765: will have to read the license, and perhaps seek advice of
7766: counsel.</p>
7767: </li>
7768: <li>
7769: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7770: <p>Binaries may not be placed on CD-ROM containing other
7771: binary packages, for which a distribution charge may be made.
7772: In this case, set this variable to
7773: <code class="varname">${RESTRICTED}</code>.</p>
7774: </li>
7775: <li>
7776: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7777: <p>Binaries may not made available on the Internet without
7778: charge. In this case, set this variable to
7779: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7780: binary packages will not be included on ftp.NetBSD.org.</p>
7781: </li>
7782: <li>
7783: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7784: <p>Distfiles may not be placed on CD-ROM, together with
7785: other distfiles, for which a fee may be charged. In this
7786: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7787: </p>
7788: </li>
7789: <li>
7790: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7791: <p>Distfiles may not made available via FTP at no charge.
7792: In this case, set this variable to
7793: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7794: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7795: </li>
7796: </ul></div>
7797: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
7798: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7799: generic make variables to denote restrictions is deprecated,
7800: because they unconditionally prevent users from generating
7801: binary packages!</p>
7802: </div>
7803: <div class="sect2" lang="en">
7804: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7805: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7806: <p>Your package may depend on some other package being present
7807: - and there are various ways of expressing this dependency.
7808: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7809: <code class="varname">DEPENDS</code> definitions, the
7810: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7811: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7812: to handle dependencies, and which uses the variables named above.
1.10 hubertf 7813: 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 7814: <p>The basic difference between the two variables is as
7815: follows: The <code class="varname">DEPENDS</code> definition registers
7816: that pre-requisite in the binary package so it will be pulled in
7817: when the binary package is later installed, whilst the
7818: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7819: dependency that is only needed for building the package.</p>
7820: <p>This means that if you only need a package present whilst
7821: you are building, it should be noted as a
7822: <code class="varname">BUILD_DEPENDS</code>.</p>
7823: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7824: <code class="varname">DEPENDS</code> definition is:</p>
7825: <pre class="programlisting">
7826: <pre-req-package-name>:../../<category>/<pre-req-package>
7827: </pre>
7828: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
7829: may include any of the wildcard version numbers recognized by
1.10 hubertf 7830: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.1 dsieger 7831: <div class="orderedlist"><ol type="1">
7832: <li>
7833: <p>If your package needs another package's binaries or
7834: libraries to build or run, and if that package has a
7835: <code class="filename">buildlink3.mk</code> file available, use it:</p>
7836: <pre class="programlisting">
7837: .include "../../graphics/jpeg/buildlink3.mk"
7838: </pre>
7839: </li>
7840: <li>
7841: <p>If your package needs to use another package to build
7842: itself and there is no <code class="filename">buildlink3.mk</code>
7843: file available, use the <code class="varname">BUILD_DEPENDS</code>
7844: definition:</p>
7845: <pre class="programlisting">
7846: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7847: </pre>
7848: </li>
7849: <li>
7850: <p>If your package needs a library with which to link and
7851: again there is no <code class="filename">buildlink3.mk</code> file
7852: available, this is specified using the
7853: <code class="varname">DEPENDS</code> definition. For example:</p>
7854: <pre class="programlisting">
7855: DEPENDS+= xpm-3.4j:../../graphics/xpm
7856: </pre>
1.9 rillig 7857: <p>You can also use wildcards in package dependencies:</p>
1.1 dsieger 7858: <pre class="programlisting">
7859: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
7860: </pre>
7861: <p>Note that such wildcard dependencies are retained when
7862: creating binary packages. The dependency is checked when
7863: installing the binary package and any package which matches
7864: the pattern will be used. Wildcard dependencies should be
7865: used with care.</p>
7866: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
7867: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7868: such as “<span class="quote">tk-postgresql</span>” matching a
7869: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
7870: <p>Wildcards can also be used to specify that a package
7871: will only build against a certain minimum version of a
7872: pre-requisite:</p>
7873: <pre class="programlisting">
7874: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
7875: </pre>
7876: <p>This means that the package will build against version
7877: 3.5.4 of the tiff library or newer. Such a dependency may
7878: be warranted if, for example, the API of the library has
7879: changed with version 3.5.4 and a package would not compile
7880: against an earlier version of tiff.</p>
7881: <p>Please note that such dependencies should only be
7882: updated if a package requires a newer pre-requisite, but
7883: not to denote recommendations such as
7884: ABI changes that do not prevent a package from building
7885: correctly. Such recommendations can be expressed using
7886: <code class="varname">ABI_DEPENDS</code>:</p>
7887: <pre class="programlisting">
7888: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
7889: </pre>
7890: <p>In addition to the above <code class="varname">DEPENDS</code>
7891: line, this denotes that while a package will build against
7892: tiff>=3.5.4, at least version 3.6.1 is recommended.
7893: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7894: dependencies unless explicitly ignored (in which case a
7895: warning will be printed).</p>
7896: <p>To ignore these ABI dependency recommendations and just
7897: use the required <code class="varname">DEPENDS</code>, set
7898: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7899: it easier and faster to update packages built using pkgsrc,
7900: since older compatible dependencies can continue to be
7901: used. This is useful for people who watch their rebuilds
7902: very carefully; it is not very good as a general-purpose
7903: hammer. If you use it, you need to be mindful of possible
7904: ABI changes, including those from the underlying OS.</p>
7905: <p>Packages that are built with recommendations ignored
7906: may not be uploaded to ftp.NetBSD.org by developers and
7907: should not be used across different systems that may have
7908: different versions of binary packages installed.</p>
7909: <p>For security fixes, please update the package
1.10 hubertf 7910: 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 7911: information.</p>
7912: </li>
7913: <li>
7914: <p>If your package needs some executable to be able to run
7915: correctly and if there's no
7916: <code class="filename">buildlink3.mk</code> file, this is specified
7917: using the <code class="varname">DEPENDS</code> variable. The
7918: <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
7919: be able to execute the latex binary from the teTeX package
7920: when it runs, and that is specified:</p>
7921: <pre class="programlisting">
7922: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
7923: </pre>
7924: <p>The comment about wildcard dependencies from previous
7925: paragraph applies here, too.</p>
7926: </li>
7927: </ol></div>
7928: <p>If your package needs files from another package to build,
7929: add the relevant distribution files to
7930: <code class="varname">DISTFILES</code>, so they will be extracted
7931: 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.
7932: (It relies on the jpeg sources being present in source form
7933: during the build.)</p>
7934: </div>
7935: <div class="sect2" lang="en">
7936: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7937: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 7938: <p>Your package may conflict with other packages a user might
7939: already have installed on his system, e.g. if your package
7940: installs the same set of files as another package in the pkgsrc
7941: tree.</p>
7942: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
7943: space-separated list of packages (including version string) your
7944: package conflicts with.</p>
7945: <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>
7946: 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>
7947: install the same shared library, thus you set in
7948: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7949: <pre class="programlisting">
7950: CONFLICTS= Xaw-Xpm-[0-9]*
7951: </pre>
7952: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
7953: <pre class="programlisting">
7954: CONFLICTS= Xaw3d-[0-9]*
7955: </pre>
7956: <p>Packages will automatically conflict with other packages
7957: with the name prefix and a different version
7958: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
7959: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
7960: </div>
7961: <div class="sect2" lang="en">
7962: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7963: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 7964: <p>There are several reasons why a package might be
7965: instructed to not build under certain circumstances. If the
7966: package builds and runs on most platforms, the exceptions
7967: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7968: the package builds and runs on a small handful of platforms,
7969: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7970: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7971: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7972: (OS-version-platform) that can use glob-style
7973: wildcards.</p>
7974: <p>Some packages are tightly bound to a specific version of an
7975: 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
7976: backwards compatible with other versions of the OS, and should be
7977: uploaded to a version specific directory on the FTP server. Mark
7978: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
7979: “<span class="quote">yes</span>”. This variable is not currently used by any of
7980: the package system internals, but may be used in the
7981: future.</p>
7982: <p>If the package should be skipped (for example, because it
7983: provides functionality already provided by the system), set
7984: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7985: the package should fail because some preconditions are not met,
7986: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
7987: message.</p>
7988: </div>
7989: <div class="sect2" lang="en">
7990: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7991: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 7992: <p>To ensure that a package may not be deleted, once it has been
7993: installed, the <code class="varname">PKG_PRESERVE</code> definition should
7994: be set in the package Makefile. This will be carried into any
7995: binary package that is made from this pkgsrc entry. A
7996: “<span class="quote">preserved</span>” package will
1.10 hubertf 7997: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.1 dsieger 7998: “<span class="quote">-f</span>” option is used.</p>
7999: </div>
8000: <div class="sect2" lang="en">
8001: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8002: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8003: <p>When a vulnerability is found, this should be noted in
8004: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.10 hubertf 8005: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.1 dsieger 8006: in the same directory to update the file on ftp.NetBSD.org.</p>
8007: <p>After fixing the vulnerability by a patch, its
8008: <code class="varname">PKGREVISION</code> should be increased (this
8009: is of course not necessary if the problem is fixed by using
8010: a newer release of the software).</p>
8011: <p>Also, if the fix should be applied to the stable pkgsrc
8012: branch, be sure to submit a pullup request!</p>
8013: <p>Binary packages already on ftp.NetBSD.org will be handled
8014: semi-automatically by a weekly cron job.</p>
8015: </div>
8016: <div class="sect2" lang="en">
8017: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8018: <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 8019: <p>When making fixes to an existing package it can be useful
8020: to change the version number in <code class="varname">PKGNAME</code>. To
8021: avoid conflicting with future versions by the original author, a
8022: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8023: on package versions by setting <code class="varname">PKGREVISION=1</code>
8024: (2, ...). The “<span class="quote">nb</span>” is treated like a
8025: “<span class="quote">.</span>” by the package tools. e.g.</p>
8026: <pre class="programlisting">
8027: DISTNAME= foo-17.42
8028: PKGREVISION= 9
8029: </pre>
8030: <p>will result in a <code class="varname">PKGNAME</code> of
8031: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8032: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8033: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8034: <code class="varname">PKGNAME_NOREV</code>.</p>
8035: <p>When a new release of the package is released, the
8036: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8037: minor release of the above package, things should be like:</p>
8038: <pre class="programlisting">
8039: DISTNAME= foo-17.43
8040: </pre>
8041: <p><code class="varname">PKGREVISION</code> should be incremented for any
8042: non-trivial change in the resulting binary package. Without a
8043: <code class="varname">PKGREVISION</code> bump, someone with the previous
8044: version installed has no way of knowing that their package is out
8045: of date. Thus, changes without increasing
8046: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8047: trivial that no reasonable person would want to upgrade", and this
8048: is the rough test for when increasing
8049: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8050: changes that do not merit increasing
8051: <code class="varname">PKGREVISION</code> are:</p>
8052: <div class="itemizedlist"><ul type="disc">
8053: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8054: or comments in Makefile.</p></li>
8055: <li><p>
8056: Changing build variables if the resulting binary package is the same.</p></li>
8057: <li><p>
8058: Changing <code class="filename">DESCR</code>.</p></li>
8059: <li><p>
8060: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8061: </ul></div>
8062: <p>Examples of changes that do merit an increase to
8063: <code class="varname">PKGREVISION</code> include:</p>
8064: <div class="itemizedlist"><ul type="disc">
8065: <li><p>
8066: Security fixes</p></li>
8067: <li><p>
8068: Changes or additions to a patch file</p></li>
8069: <li><p>
8070: Changes to the <code class="filename">PLIST</code></p></li>
8071: </ul></div>
8072: <p>PKGREVISION must also be incremented when dependencies have ABI
8073: changes.</p>
8074: </div>
8075: <div class="sect2" lang="en">
8076: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8077: <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 8078: <p>When you want to replace the same text in multiple files
8079: or when the replacement text varies, patches alone cannot help.
8080: This is where the SUBST framework comes in. It provides an
8081: easy-to-use interface for replacing text in files.
8082: Example:</p>
8083: <pre class="programlisting">
8084: SUBST_CLASSES+= fix-paths
8085: SUBST_STAGE.fix-paths= pre-configure
8086: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8087: SUBST_FILES.fix-paths= src/*.c
8088: SUBST_FILES.fix-paths+= scripts/*.sh
8089: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8090: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8091: </pre>
8092: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8093: that are used to identify the different SUBST blocks that are
8094: defined. The SUBST framework is heavily used by pkgsrc, so it is
8095: important to always use the <code class="literal">+=</code> operator with
8096: this variable. Otherwise some substitutions may be
8097: skipped.</p>
8098: <p>The remaining variables of each SUBST block are
8099: parameterized with the identifier from the first line
8100: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8101: parameters to a function call.</p>
8102: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8103: which the replacement will take place. All combinations of
8104: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8105: <code class="literal">post-</code> together with a phase name are
8106: possible, though only few are actually used. Most commonly used
8107: are <code class="literal">post-patch</code> and
8108: <code class="literal">pre-configure</code>. Of these two,
8109: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8110: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8111: have the state after applying the patches but before making any
8112: other changes. This is especially useful when you are debugging
8113: a package in order to create new patches for it. Similarly,
8114: <code class="literal">post-build</code> is preferred over
8115: <code class="literal">pre-install</code>, because the install phase should
8116: generally be kept as simple as possible. When you use
8117: <code class="literal">post-build</code>, you have the same files in the
8118: working directory that will be installed later, so you can check
8119: if the substitution has succeeded.</p>
8120: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8121: that is printed just before the substitution is done.</p>
8122: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8123: globbing patterns that specifies the files in which the
8124: substitution will take place. The patterns are interpreted
8125: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8126: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.10 hubertf 8127: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 8128: command should be prefixed with <code class="literal">-e</code>, so that
8129: all SUBST blocks look uniform.</p>
8130: <p>There are some more variables, but they are so seldomly
8131: used that they are only documented in the
8132: <code class="filename">mk/subst.mk</code> file.</p>
8133: </div>
8134: </div>
8135: <div class="sect1" lang="en">
8136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8137: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 8138: <div class="sect2" lang="en">
8139: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8140: <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 8141: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8142: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8143: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8144: with the name of each file to download as an argument, expecting
8145: it to output the URL of the directory from which to download
8146: 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
8147: example of this usage.</p>
8148: <p>If the download can't be automated, because the user must
8149: submit personal information to apply for a password, or must pay
8150: for the source, or whatever, you can set
8151: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8152: displayed to the user before aborting the build. Example:</p>
8153: <pre class="programlisting">
8154: FETCH_MESSAGE= "Please download the files"
8155: FETCH_MESSAGE+= " "${DISTFILES:Q}
8156: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8157: </pre>
8158: </div>
8159: <div class="sect2" lang="en">
8160: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8161: <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 8162: <p>Sometimes authors of a software package make some
8163: modifications after the software was released, and they put up a
8164: new distfile without changing the package's version number. If a
8165: package is already in pkgsrc at that time, the checksum will
8166: no longer match. The contents of the new distfile should be
8167: compared against the old one before changing anything, to make
8168: sure the distfile was really updated on purpose, and that
8169: no trojan horse or so crept in.
8170: Please mention that the distfiles were compared and what was found
8171: in your commit message.
8172: Then, the correct way to work around this is to
8173: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8174: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8175: <code class="varname">DISTFILES</code> and
8176: <code class="varname">PATCHFILES</code> for this package will be put in that
8177: subdirectory of the local distfiles directory.
1.10 hubertf 8178: (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 8179: In case this
8180: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8181: including the <code class="filename">nbX</code> suffix) or a date stamp
8182: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8183: Do not forget regenerating the <code class="filename">distinfo</code> file
8184: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8185: path in the filenames.
8186: Also increase the PKGREVISION if the installed package is different.
8187: Furthermore, a mail to the package's authors seems appropriate
8188: telling them that changing distfiles after releases without
8189: changing the file names is not good practice.</p>
8190: </div>
8191: </div>
8192: <div class="sect1" lang="en">
8193: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8194: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 8195: <div class="sect2" lang="en">
8196: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8197: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8198: <p>pkgsrc supports many different machines, with different
8199: object formats like a.out and ELF, and varying abilities to do
8200: shared library and dynamic loading at all. To accompany this,
8201: varying commands and options have to be passed to the
8202: compiler, linker, etc. to get the Right Thing, which can be
8203: pretty annoying especially if you don't have all the machines
8204: at your hand to test things. The
8205: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
8206: can help here, as it just “<span class="quote">knows</span>” how to build
8207: both static and dynamic libraries from a set of source files,
8208: thus being platform-independent.</p>
8209: <p>Here's how to use libtool in a package in seven simple
8210: steps:</p>
8211: <div class="orderedlist"><ol type="1">
8212: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
8213: Makefile.</p></li>
8214: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
8215: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8216: add it to the definition of <code class="varname">CC</code>, if only
8217: libraries are being built in a given Makefile. This one command
8218: will build both PIC and non-PIC library objects, so you need not
8219: have separate shared and non-shared library rules.</p></li>
8220: <li>
8221: <p>For the linking of the library, remove any
8222: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8223: -Bshareable</span>” commands, and instead use:</p>
8224: <pre class="programlisting">
8225: ${LIBTOOL} --mode=link \
8226: ${CC} -o ${.TARGET:.a=.la} \
8227: ${OBJS:.o=.lo} \
8228: -rpath ${PREFIX}/lib \
8229: -version-info major:minor
8230: </pre>
8231: <p>Note that the library is changed to have a
8232: <code class="filename">.la</code> extension, and the objects are
8233: changed to have a <code class="filename">.lo</code>
8234: extension. Change <code class="varname">OBJS</code> as
8235: necessary. This automatically creates all of the
8236: <code class="filename">.a</code>,
8237: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8238: necessary) in the build directory. Be sure to include
8239: “<span class="quote">-version-info</span>”, especially when major and
8240: minor are zero, as libtool will otherwise strip off the
8241: shared library version.</p>
8242: <p>From the libtool manual:</p>
8243: <pre class="programlisting">
8244: So, libtool library versions are described by three integers:
8245:
8246: CURRENT
8247: The most recent interface number that this library implements.
8248:
8249: REVISION
8250: The implementation number of the CURRENT interface.
8251:
8252: AGE
8253: The difference between the newest and oldest interfaces that
8254: this library implements. In other words, the library implements
8255: all the interface numbers in the range from number `CURRENT -
8256: AGE' to `CURRENT'.
8257:
8258: If two libraries have identical CURRENT and AGE numbers, then the
8259: dynamic linker chooses the library with the greater REVISION number.
8260: </pre>
8261: <p>The “<span class="quote">-release</span>” option will produce
8262: different results for a.out and ELF (excluding symlinks)
8263: in only one case. An ELF library of the form
8264: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8265: will have a symlink of
8266: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8267: on an a.out platform. This is handled
8268: automatically.</p>
8269: <p>The “<span class="quote">-rpath argument</span>” is the install
8270: directory of the library being built.</p>
8271: <p>In the <code class="filename">PLIST</code>, include only the
8272: <code class="filename">.la</code> file, the other files will be
8273: added automatically.</p>
8274: </li>
8275: <li>
8276: <p>When linking shared object (<code class="filename">.so</code>)
1.10 hubertf 8277: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.1 dsieger 8278: shared libraries, use “<span class="quote">-module
8279: -avoid-version</span>” to prevent them getting version
8280: tacked on.</p>
8281: <p>The <code class="filename">PLIST</code> file gets the
8282: <code class="filename">foo.so</code> entry.</p>
8283: </li>
8284: <li>
8285: <p>When linking programs that depend on these libraries
8286: <span class="emphasis"><em>before</em></span> they are installed, preface
1.10 hubertf 8287: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><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-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with “<span class="quote">${LIBTOOL}
1.1 dsieger 8288: --mode=link</span>”, and it will find the correct
8289: libraries (static or shared), but please be aware that
8290: libtool will not allow you to specify a relative path in
8291: -L (such as “<span class="quote">-L../somelib</span>”), because it
8292: expects you to change that argument to be the
8293: <code class="filename">.la</code> file. e.g.</p>
8294: <pre class="programlisting">
8295: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8296: </pre>
8297: <p>should be changed to:</p>
8298: <pre class="programlisting">
8299: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8300: </pre>
8301: <p>and it will do the right thing with the libraries.</p>
8302: </li>
8303: <li>
1.10 hubertf 8304: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8305: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with “<span class="quote">${LIBTOOL}
1.1 dsieger 8306: --mode=install</span>”, and change the library name to
8307: <code class="filename">.la</code>. e.g.</p>
8308: <pre class="programlisting">
8309: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8310: </pre>
8311: <p>This will install the static <code class="filename">.a</code>,
8312: shared library, any needed symlinks, and run
1.10 hubertf 8313: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8314: </li>
8315: <li><p>In your <code class="filename">PLIST</code>, include only
8316: the <code class="filename">.la</code>
8317: file (this is a change from previous behaviour).</p></li>
8318: </ol></div>
8319: </div>
8320: <div class="sect2" lang="en">
8321: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8322: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8323: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8324: package Makefile. This will override the package's own libtool
8325: in most cases. For older libtool using packages, libtool is
8326: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8327: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8328: configure; find work*/ -name libtool</strong></span>.</p>
8329: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8330: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8331: default, it is set to “<span class="quote">libtool */libtool
8332: */*/libtool</span>”. If this does not match the location of the
8333: package's libtool script(s), set it as appropriate.</p>
8334: <p>If you do not need <code class="filename">*.a</code> static
8335: libraries built and installed, then use
8336: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8337: <p>If your package makes use of the platform-independent library
8338: for loading dynamic shared objects, that comes with libtool
8339: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8340: <p>Some packages use libtool incorrectly so that the package
8341: may not work or build in some circumstances. Some of the more
8342: common errors are:</p>
8343: <div class="itemizedlist"><ul type="disc">
8344: <li>
8345: <p>The inclusion of a shared object (-module) as a dependent library in an
8346: executable or library. This in itself isn't a problem if one of two things
8347: has been done:</p>
8348: <div class="orderedlist"><ol type="1">
8349: <li><p>The shared object is named correctly, i.e.
8350: <code class="filename">libfoo.la</code>, not
8351: <code class="filename">foo.la</code></p></li>
8352: <li><p>The -dlopen option is used when linking an executable.</p></li>
8353: </ol></div>
8354: </li>
8355: <li><p>The use of libltdl without the correct calls to initialisation routines.
8356: The function lt_dlinit() should be called and the macro
8357: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8358: executables.</p></li>
8359: </ul></div>
8360: </div>
8361: <div class="sect2" lang="en">
8362: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8363: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8364: <p>If a package needs GNU autoconf or automake to be executed
8365: to regenerate the configure script and Makefile.in makefile
8366: templates, then they should be executed in a pre-configure
8367: target.</p>
8368: <p>For packages that need only autoconf:</p>
8369: <pre class="programlisting">
8370: AUTOCONF_REQD= 2.50 # if default version is not good enough
8371: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8372: ...
8373:
8374: pre-configure:
8375: cd ${WRKSRC} && autoconf
8376:
8377: ...
8378: </pre>
8379: <p>and for packages that need automake and autoconf:</p>
8380: <pre class="programlisting">
8381: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8382: USE_TOOLS+= automake # use "automake14" for automake-1.4
8383: ...
8384:
8385: pre-configure:
8386: set -e; cd ${WRKSRC}; \
8387: aclocal; autoheader; automake -a --foreign -i; autoconf
8388:
8389: ...
8390: </pre>
8391: <p>Packages which use GNU Automake will almost certainly
8392: require GNU Make.</p>
8393: <p>There are times when the configure process makes
8394: additional changes to the generated files, which then causes
8395: the build process to try to re-execute the automake sequence.
8396: This is prevented by touching various files in the configure
8397: stage. If this causes problems with your package you can set
8398: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8399: Makefile.</p>
8400: </div>
8401: </div>
8402: <div class="sect1" lang="en">
8403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8404: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.1 dsieger 8405: <div class="sect2" lang="en">
8406: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8407: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8408: <p>Compilers for the C, C++, and Fortran languages comes with
8409: the NetBSD base system. By default, pkgsrc assumes that a package
8410: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8411: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8412: <p>To declare which language's compiler a package needs, set
8413: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8414: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8415: “<span class="quote">fortran</span>” (and any combination). The default is
8416: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8417: written in C++, usually need a C compiler for the configure
8418: phase.</p>
8419: </div>
8420: <div class="sect2" lang="en">
8421: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8422: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8423: <p>If a program is written in Java, use the Java framework in
8424: pkgsrc. The package must include
8425: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8426: provides the following variables:</p>
8427: <div class="itemizedlist"><ul type="disc">
8428: <li><p><code class="varname">USE_JAVA</code> defines if a build
8429: dependency on the JDK is added. If
8430: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8431: there is only a runtime dependency on the JDK. The default is
8432: “<span class="quote">yes</span>”, which also adds a build dependency on the
8433: JDK.</p></li>
8434: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8435: a package needs a Java2 implementation. The supported values
8436: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8437: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8438: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8439: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8440: above. This variable is not set by default.</p></li>
8441: </ul></div>
8442: </div>
8443: <div class="sect2" lang="en">
8444: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8445: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8446: <p>If your package contains interpreted perl scripts, add
8447: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8448: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8449: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8450: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8451: that you want adjusted. Every occurrence of
8452: <code class="filename">*/bin/perl</code> will be replaced with the full
8453: path to the perl executable.</p>
8454: <p>If a particular version of perl is needed, set the
8455: <code class="varname">PERL5_REQD</code> variable to the version number. The
8456: default is “<span class="quote">5.0</span>”.</p>
1.10 hubertf 8457: <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 8458: about handling perl modules.</p>
8459: </div>
8460: <div class="sect2" lang="en">
8461: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8462: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1 dsieger 8463: <p>Currently, there is no special handling for other languages
8464: in pkgsrc. If a compiler package provides a
8465: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8466: just add a (build) dependency on the appropriate compiler
8467: package.</p>
8468: </div>
8469: </div>
8470: <div class="sect1" lang="en">
8471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8472: <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 8473: <p>The most common failures when building a package are that
8474: some platforms do not provide certain header files, functions or
8475: libraries, or they provide the functions in a library that the
8476: original package author didn't know. To work around this, you
8477: can rewrite the source code in most cases so that it does not
8478: use the missing functions or provides a replacement function.</p>
8479: <div class="sect2" lang="en">
8480: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8481: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8482: <p>If a package already comes with a GNU configure script, the
8483: preferred way to fix the build failure is to change the
8484: configure script, not the code. In the other cases, you can
8485: utilize the C preprocessor, which defines certain macros
8486: depending on the operating system and hardware architecture it
8487: compiles for. These macros can be queried using for example
8488: <code class="varname">#if defined(__i386)</code>. Almost every operating
8489: system, hardware architecture and compiler has its own macro.
8490: For example, if the macros <code class="varname">__GNUC__</code>,
8491: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8492: are all defined, you know that you are using NetBSD on an i386
8493: compatible CPU, and your compiler is GCC.</p>
8494: <p>The list of the following macros for hardware and
8495: operating system depends on the compiler that is used. For
8496: example, if you want to conditionally compile code on Solaris,
8497: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8498: does not define it. Use <code class="varname">__sun</code> instead.</p>
8499: <div class="sect3" lang="en">
8500: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8501: <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 8502: <p>To distinguish between 4.4 BSD-derived systems and the
8503: rest of the world, you should use the following code.</p>
8504: <pre class="programlisting">
8505: #include <sys/param.h>
8506: #if (defined(BSD) && BSD >= 199306)
8507: /* BSD-specific code goes here */
8508: #else
8509: /* non-BSD-specific code goes here */
8510: #endif
8511: </pre>
8512: <p>If this distinction is not fine enough, you can also test
8513: for the following macros.</p>
8514: <pre class="programlisting">
8515: FreeBSD __FreeBSD__
8516: DragonFly __DragonFly__
8517: Interix __INTERIX
8518: IRIX __sgi (TODO: get a definite source for this)
8519: Linux linux, __linux, __linux__
8520: NetBSD __NetBSD__
8521: OpenBSD __OpenBSD__
8522: Solaris sun, __sun
8523: </pre>
8524: </div>
8525: <div class="sect3" lang="en">
8526: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8527: <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 8528: <pre class="programlisting">
8529: i386 i386, __i386, __i386__
8530: MIPS __mips
8531: SPARC sparc, __sparc
8532: </pre>
8533: </div>
8534: <div class="sect3" lang="en">
8535: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8536: <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 8537: <pre class="programlisting">
8538: GCC __GNUC__ (major version), __GNUC_MINOR__
8539: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8540: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8541: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8542: </pre>
8543: </div>
8544: </div>
8545: <div class="sect2" lang="en">
8546: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8547: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8548: <p>Some source files trigger bugs in the compiler, based on
8549: combinations of compiler version and architecture and almost
8550: always relation to optimisation being enabled. Common symptoms
8551: are gcc internal errors or never finishing compiling a
8552: file.</p>
8553: <p>Typically, a workaround involves testing the
8554: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8555: optimisation for that combination of file,
8556: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8557: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8558: number of examples.</p>
8559: </div>
8560: <div class="sect2" lang="en">
8561: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8562: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.1 dsieger 8563: <p>This error message often means that a package did not
8564: link to a shared library it needs. The following functions are
8565: known to cause this error message over and over.</p>
8566: <div class="informaltable">
8567: <a name="undefined-reference-functions"></a><table border="1">
8568: <colgroup>
8569: <col>
8570: <col>
8571: <col>
8572: </colgroup>
8573: <thead><tr>
8574: <th>Function</th>
8575: <th>Library</th>
8576: <th>Affected platforms</th>
8577: </tr></thead>
8578: <tbody>
8579: <tr>
8580: <td>accept, bind, connect</td>
8581: <td>-lsocket</td>
8582: <td>Solaris</td>
8583: </tr>
8584: <tr>
8585: <td>crypt</td>
8586: <td>-lcrypt</td>
8587: <td>DragonFly, NetBSD</td>
8588: </tr>
8589: <tr>
8590: <td>dlopen, dlsym</td>
8591: <td>-ldl</td>
8592: <td>Linux</td>
8593: </tr>
8594: <tr>
8595: <td>gethost*</td>
8596: <td>-lnsl</td>
8597: <td>Solaris</td>
8598: </tr>
8599: <tr>
8600: <td>inet_aton</td>
8601: <td>-lresolv</td>
8602: <td>Solaris</td>
8603: </tr>
8604: <tr>
8605: <td>nanosleep, sem_*, timer_*</td>
8606: <td>-lrt</td>
8607: <td>Solaris</td>
8608: </tr>
8609: <tr>
8610: <td>openpty</td>
8611: <td>-lutil</td>
8612: <td>Linux</td>
8613: </tr>
8614: </tbody>
8615: </table>
8616: </div>
8617: <p>To fix these linker errors, it is often sufficient to say
8618: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8619: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8620: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8621: bmake</strong></span>.</p>
8622: <div class="sect3" lang="en">
8623: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8624: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8625: <p>When you are using the SunPro compiler, there is another
8626: possibility. That compiler cannot handle the following code:</p>
8627: <pre class="programlisting">
8628: extern int extern_func(int);
8629:
8630: static inline int
8631: inline_func(int x)
8632: {
8633: return extern_func(x);
8634: }
8635:
8636: int main(void)
8637: {
8638: return 0;
8639: }
8640: </pre>
8641: <p>It generates the code for <code class="function">inline_func</code> even if
8642: that function is never used. This code then refers to
8643: <code class="function">extern_func</code>, which can usually not be resolved. To
8644: solve this problem you can try to tell the package to disable inlining
8645: of functions.</p>
8646: </div>
8647: </div>
8648: <div class="sect2" lang="en">
8649: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8650: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8651: <p>Sometimes packages fail to build because the compiler runs
8652: into an operating system specific soft limit. With the
8653: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8654: to unlimit the resources. Currently, the allowed values are
8655: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8656: Setting this variable is similar to running the shell builtin
1.10 hubertf 8657: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8658: segment size or maximum stack size of a process, respectively, to
8659: their hard limits.</p>
8660: </div>
8661: </div>
8662: <div class="sect1" lang="en">
8663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8664: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 8665: <div class="sect2" lang="en">
8666: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8667: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8668: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8669: with some operating systems cannot create more than one
8670: directory at a time. As such, you should call
8671: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8672: <pre class="programlisting">
8673: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8674: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8675: </pre>
8676: <p>You can also just append “<span class="quote"><code class="literal">dir1
8677: dir2</code></span>” to the
8678: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8679: automatically do the right thing.</p>
8680: </div>
8681: <div class="sect2" lang="en">
8682: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8683: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8684: <p>In general, documentation should be installed into
8685: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8686: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8687: includes the version number of the package).</p>
8688: <p>Many modern packages using GNU autoconf allow to set the
8689: directory where HTML documentation is installed with the
8690: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8691: is needed because otherwise the documentation ends up in
8692: <code class="filename">${PREFIX}/share/doc/html</code> or other
8693: places.</p>
8694: <p>An exception to the above is that library API documentation
8695: 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
8696: browsers (devhelp) should be left at their default location, which
8697: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8698: documentation can be recognized from files ending in
8699: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8700: (It is also acceptable to install such files in
8701: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8702: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8703: <code class="filename">.devhelp*</code> file must be directly in that
8704: directory then, no additional subdirectory level is allowed in
8705: this case. This is usually achieved by using
8706: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8707: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8708: though.)</p>
8709: </div>
8710: <div class="sect2" lang="en">
8711: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8712: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8713: <p>Certain packages, most of them in the games category, install
8714: a score file that allows all users on the system to record their
8715: highscores. In order for this to work, the binaries need to be
8716: installed setgid and the score files owned by the appropriate
8717: group and/or owner (traditionally the "games" user/group). The
8718: following variables, documented in more detail in
8719: <code class="filename">mk/defaults/mk.conf</code>, control this
8720: behaviour: <code class="varname">SETGIDGAME</code>,
8721: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8722: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
8723: <p>Note that per default, setgid installation of games is
8724: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8725: the other variables accordingly.</p>
8726: <p>A package should therefor never hard code file ownership or
8727: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8728: <code class="varname">INSTALL_GAME_DATA</code> to set these
8729: correctly.</p>
8730: </div>
8731: <div class="sect2" lang="en">
8732: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8733: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.4 rillig 8734: <div class="itemizedlist"><ul type="disc">
8735: <li><p>All installation operations have to be prefixed with
8736: <code class="filename">${DESTDIR}</code>.</p></li>
8737: <li><p>automake gets this DESTDIR mostly right
8738: automatically. Many manual rules and pre/post-install often are
8739: incorrect; fix them.</p></li>
8740: <li><p>If files are installed with special owner/group
8741: either use @owner/@group in the <code class="filename">PLIST</code>
8742: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8743: (discouraged). Note that @owner/@group are sticky during
8744: install, keep this in mind.</p></li>
8745: <li><p>In general, packages should support
8746: <code class="varname">UNPRIVILEGED</code> to be able to use
8747: DESTDIR.</p></li>
8748: </ul></div>
8749: </div>
8750: <div class="sect2" lang="en">
8751: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8752: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8753: <p>Your package may also contain scripts with hardcoded paths to
8754: other interpreters besides (or as well as) perl. To correct the
8755: full pathname to the script interpreter, you need to set the
8756: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 8757: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 8758: <pre class="programlisting">
8759: REPLACE_INTERPRETER+= tcl
8760: REPLACE.tcl.old= .*/bin/tclsh
8761: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8762: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8763: # relative to ${WRKSRC}, just as in REPLACE_PERL
8764: </pre>
8765: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8766: <h3 class="title">Note</h3>
8767: <p>Before March 2006, these variables were called
8768: <code class="varname">_REPLACE.*</code> and
8769: <code class="varname">_REPLACE_FILES.*</code>.</p>
8770: </div>
8771: </div>
8772: <div class="sect2" lang="en">
8773: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8774: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8775: <p>Makefiles of packages providing perl5 modules should include
8776: the Makefile fragment
8777: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 8778: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 8779: configuration for such modules as well as various hooks to tune
8780: this configuration. See comments in this file for
8781: details.</p>
8782: <p>Perl5 modules will install into different places depending
8783: on the version of perl used during the build process. To
8784: address this, pkgsrc will append lines to the
8785: <code class="filename">PLIST</code> corresponding to the files listed in
8786: the installed <code class="filename">.packlist</code> file generated by
8787: most perl5 modules. This is invoked by defining
8788: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8789: paths to packlist files, e.g.:</p>
8790: <pre class="programlisting">
8791: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8792: </pre>
8793: <p>The variables <code class="varname">PERL5_SITELIB</code>,
8794: <code class="varname">PERL5_SITEARCH</code>, and
8795: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8796: in which perl5 modules may be installed, and may be used by
8797: perl5 packages that don't have a packlist. These three
8798: variables are also substituted for in the
8799: <code class="filename">PLIST</code>.</p>
8800: </div>
8801: <div class="sect2" lang="en">
8802: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8803: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8804: <p>Some packages install info files or use the
8805: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8806: commands. <code class="varname">INFO_FILES</code> should be defined in
8807: the package Makefile so that <code class="filename">INSTALL</code> and
8808: <code class="filename">DEINSTALL</code> scripts will be generated to
8809: handle registration of the info files in the Info directory
8810: file. The “<span class="quote">install-info</span>” command used for the info
8811: files registration is either provided by the system, or by a
8812: special purpose package automatically added as dependency if
8813: needed.</p>
8814: <p><code class="varname">PKGINFODIR</code> is the directory under
8815: <code class="filename">${PREFIX}</code> where info files are primarily
8816: located. <code class="varname">PKGINFODIR</code> defaults to
8817: “<span class="quote">info</span>” and can be overridden by the user.</p>
8818: <p>The info files for the package should be listed in the
8819: package <code class="filename">PLIST</code>; however any split info files
8820: need not be listed.</p>
8821: <p>A package which needs the “<span class="quote">makeinfo</span>” command
8822: at build time must add “<span class="quote">makeinfo</span>” to
8823: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8824: version of the “<span class="quote">makeinfo</span>” command is needed it
8825: should be noted with the <code class="varname">TEXINFO_REQD</code>
8826: variable in the package <code class="filename">Makefile</code>. By
8827: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 8828: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 8829: does not match the required minimum, a build dependency on the
8830: <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
8831: be added automatically.</p>
8832: <p>The build and installation process of the software provided
8833: by the package should not use the
1.10 hubertf 8834: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 8835: info files is the task of the package
8836: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 8837: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 8838: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 8839: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8840: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 8841: in <code class="varname">PATH</code>.</p>
1.10 hubertf 8842: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 8843: no effect except the logging of a message. The script overriding
1.10 hubertf 8844: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 8845: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 8846: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 8847: </div>
8848: <div class="sect2" lang="en">
8849: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8850: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 8851: <p>All packages that install manual pages should install them
8852: into the same directory, so that there is one common place to look
8853: for them. In pkgsrc, this place is
8854: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8855: should be used in packages. The default for
8856: <code class="varname">PKGMANDIR</code> is
8857: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8858: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
8859: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8860: <h3 class="title">Note</h3>
8861: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8862: is far from complete.</p>
8863: </div>
8864: <p>The <code class="filename">PLIST</code> files can just use
8865: <code class="filename">man/</code> as the top level directory for the man
8866: page file entries, and the pkgsrc framework will convert as
8867: needed. In all other places, the correct
8868: <code class="varname">PKGMANDIR</code> must be used.</p>
8869: <p>Packages that are
8870: configured with <code class="varname">GNU_CONFIGURE</code> set as
8871: “<span class="quote">yes</span>”, by default will use the
8872: <code class="filename">./configure</code>
8873: --mandir switch to set where the man pages should be installed.
8874: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8875: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8876: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8877: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8878: to “<span class="quote">no</span>”.
8879: Or if the <code class="filename">./configure</code> script uses
8880: a non-standard use of --mandir, you can set
8881: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 8882: <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 8883: information on installation of compressed manual pages.</p>
8884: </div>
8885: <div class="sect2" lang="en">
8886: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 8887: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 8888: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 8889: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 8890: you need to take some extra steps to make sure they get registered
8891: in the database:</p>
8892: <div class="orderedlist"><ol type="1">
1.7 rillig 8893: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 8894: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 8895: takes care of rebuilding the GConf database at installation and
1.1 dsieger 8896: deinstallation time, and tells the package where to install
1.7 rillig 8897: GConf data files using some standard configure arguments. It
1.1 dsieger 8898: also disallows any access to the database directly from the
8899: package.</p></li>
8900: <li><p>Ensure that the package installs its
8901: <code class="filename">.schemas</code> files under
8902: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8903: installed under <code class="filename">${PREFIX}/etc</code>, you will
8904: need to manually patch the package.</p></li>
8905: <li><p>Check the PLIST and remove any entries under the etc/gconf
8906: directory, as they will be handled automatically. See
1.10 hubertf 8907: <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.7 rillig 8908: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 8909: your <code class="filename">Makefile</code> with a list of all
8910: <code class="filename">.schemas</code> files installed by the package, if
8911: any. Names must not contain any directories in them.</p></li>
1.7 rillig 8912: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 8913: your <code class="filename">Makefile</code> with a
8914: list of all <code class="filename">.entries</code> files installed by the
8915: package, if any. Names must not contain any directories in
8916: them.</p></li>
8917: </ol></div>
8918: </div>
8919: <div class="sect2" lang="en">
8920: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8921: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.1 dsieger 8922: <p>If a package installs <code class="filename">.omf</code> files, used by
8923: scrollkeeper, you need to take some extra steps to make sure they
8924: get registered in the database:</p>
8925: <div class="orderedlist"><ol type="1">
8926: <li><p>Include
8927: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8928: instead of its <code class="filename">buildlink3.mk</code> file. This
8929: takes care of rebuilding the scrollkeeper database at
8930: installation and deinstallation time, and disallows any access
8931: to it directly from the package.</p></li>
8932: <li><p>Check the PLIST and remove any entries under the
8933: <code class="filename">libdata/scrollkeeper</code> directory, as they
8934: will be handled automatically.</p></li>
8935: <li><p>Remove the <code class="filename">share/omf</code> directory from
8936: the PLIST. It will be handled by scrollkeeper.</p></li>
8937: </ol></div>
8938: </div>
8939: <div class="sect2" lang="en">
8940: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8941: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 8942: <p>If a package installs font files, you will need to rebuild
8943: the fonts database in the directory where they get installed at
8944: installation and deinstallation time. This can be automatically
8945: done by using the pkginstall framework.</p>
8946: <p>You can list the directories where fonts are installed in the
8947: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8948: variables, where <em class="replaceable"><code>type</code></em> can be one of
8949: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8950: Also make sure that the database file
8951: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
8952: <p>Note that you should not create new directories for fonts;
8953: instead use the standard ones to avoid that the user needs to
8954: manually configure his X server to find them.</p>
8955: </div>
8956: <div class="sect2" lang="en">
8957: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8958: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 8959: <p>If a package installs GTK2 immodules or loaders, you need to
8960: take some extra steps to get them registered in the GTK2 database
8961: properly:</p>
8962: <div class="orderedlist"><ol type="1">
8963: <li><p>Include
8964: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8965: <code class="filename">buildlink3.mk</code> file. This takes care of
8966: rebuilding the database at installation and deinstallation time.</p></li>
8967: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
8968: your package installs GTK2 immodules.</p></li>
8969: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
8970: GTK2 loaders.</p></li>
8971: <li>
8972: <p>Patch the package to not touch any of the GTK2
8973: databases directly. These are:</p>
8974: <div class="itemizedlist"><ul type="disc">
8975: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8976: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
8977: </ul></div>
8978: </li>
8979: <li><p>Check the <code class="filename">PLIST</code> and remove
8980: any entries under the <code class="filename">libdata/gtk-2.0</code>
8981: directory, as they will be handled automatically.</p></li>
8982: </ol></div>
8983: </div>
8984: <div class="sect2" lang="en">
8985: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8986: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 8987: <p>If a package installs SGML or XML data files that need to be
8988: registered in system-wide catalogs (like DTDs, sub-catalogs,
8989: etc.), you need to take some extra steps:</p>
8990: <div class="orderedlist"><ol type="1">
8991: <li><p>Include
8992: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
8993: your <code class="filename">Makefile</code>, which takes care of
8994: registering those files in system-wide catalogs at
8995: installation and deinstallation time.</p></li>
8996: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
8997: any SGML catalogs installed by the package.</p></li>
8998: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
8999: any XML catalogs installed by the package.</p></li>
9000: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
9001: to be added to the SGML catalog. These come in groups of
9002: three strings; see xmlcatmgr(1) for more information
9003: (specifically, arguments recognized by the 'add' action).
9004: Note that you will normally not use this variable.</p></li>
9005: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
9006: to be added to the XML catalog. These come in groups of three
9007: strings; see xmlcatmgr(1) for more information (specifically,
9008: arguments recognized by the 'add' action). Note that you will
9009: normally not use this variable.</p></li>
9010: </ol></div>
9011: </div>
9012: <div class="sect2" lang="en">
9013: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9014: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9015: <p>If a package provides extensions to the MIME database by
9016: installing <code class="filename">.xml</code> files inside
9017: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9018: need to take some extra steps to ensure that the database is kept
9019: consistent with respect to these new files:</p>
9020: <div class="orderedlist"><ol type="1">
9021: <li><p>Include
9022: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9023: (avoid using the <code class="filename">buildlink3.mk</code> file from
9024: this same directory, which is reserved for inclusion from
9025: other <code class="filename">buildlink3.mk</code> files). It takes
9026: care of rebuilding the MIME database at installation and
9027: deinstallation time, and disallows any access to it directly
9028: from the package.</p></li>
9029: <li><p>Check the PLIST and remove any entries under the
9030: <code class="filename">share/mime</code> directory,
9031: <span class="emphasis"><em>except</em></span> for files saved under
9032: <code class="filename">share/mime/packages</code>. The former are
9033: handled automatically by
9034: the update-mime-database program, but the latter are
9035: package-dependent and must be removed by the package that
9036: installed them in the first place.</p></li>
9037: <li><p>Remove any <code class="filename">share/mime/*</code> directories
9038: from the PLIST. They will be handled by the shared-mime-info
9039: package.</p></li>
9040: </ol></div>
9041: </div>
9042: <div class="sect2" lang="en">
9043: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9044: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9045: <p>If a package uses intltool during its build, add
9046: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9047: which forces it to use the intltool package provided by pkgsrc,
9048: instead of the one bundled with the distribution file.</p>
9049: <p>This tracks intltool's build-time dependencies and uses the
9050: latest available version; this way, the package benefits of any
9051: bug fixes that may have appeared since it was released.</p>
9052: </div>
9053: <div class="sect2" lang="en">
9054: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9055: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9056: <p>If a package contains a rc.d script, it won't be copied into
9057: the startup directory by default, but you can enable it, by adding
9058: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9059: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9060: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9061: it will automatically remove the scripts when the package is
9062: deinstalled.</p>
9063: </div>
9064: <div class="sect2" lang="en">
9065: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9066: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9067: <p>If a package installs TeX packages into the texmf tree,
9068: the <code class="filename">ls-R</code> database of the tree needs to be
9069: updated.</p>
9070: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9071: <h3 class="title">Note</h3>
9072: <p>Except the main TeX packages such as teTeX-texmf,
9073: packages should install files
9074: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9075: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
9076: </div>
9077: <div class="orderedlist"><ol type="1">
9078: <li><p>Include
9079: <code class="filename">../../print/teTeX/module.mk</code> instead
9080: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9081: takes care of rebuilding the <code class="filename">ls-R</code>
9082: database at installation and deinstallation time.</p></li>
9083: <li>
9084: <p>If your package installs files into a texmf
9085: tree other than the one
9086: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9087: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9088: trees that need database update.</p>
9089: <p>If your package also installs font map files that need
1.10 hubertf 9090: to be registered using <span class="command"><strong>updmap</strong></span>,
1.1 dsieger 9091: set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.10 hubertf 9092: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9093: be run automatically at installation/deinstallation to
9094: enable/disable font map files for TeX output
9095: drivers.</p>
9096: </li>
9097: <li><p>Make sure that none of <code class="filename">ls-R</code>
9098: databases are included in <code class="filename">PLIST</code>, as
9099: they will be removed only by the teTeX-bin package.</p></li>
9100: </ol></div>
9101: </div>
9102: <div class="sect2" lang="en">
9103: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9104: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9105: emulation</h3></div></div></div>
9106: <p>There are some packages that provide libraries and
9107: executables for running binaries from a one operating system
9108: on a different one (if the latter supports it). One example
9109: is running Linux binaries on NetBSD.</p>
9110: <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>
9111: helps in extracting and packaging Linux rpm packages.</p>
9112: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9113: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9114: if all libraries for each installed executable can be found by
9115: the dynamic linker. Since the standard dynamic linker is run,
9116: this fails for emulation packages, because the libraries used
9117: by the emulation are not in the standard directories.</p>
9118: </div>
9119: <div class="sect2" lang="en">
9120: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9121: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9122: <p>If a package installs images under the
9123: <code class="filename">share/icons/hicolor</code> and/or updates the
9124: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9125: database, you need to take some extra steps to make sure that the
9126: shared theme directory is handled appropriately and that the cache
9127: database is rebuilt:</p>
9128: <div class="orderedlist"><ol type="1">
9129: <li><p>Include
9130: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9131: <li><p>Check the <code class="filename">PLIST</code> and remove the
9132: entry that refers to the theme cache.</p></li>
9133: <li><p>Ensure that the PLIST does not remove the shared icon
9134: directories from the <code class="filename">share/icons/hicolor</code>
9135: hierarchy because they will be handled automatically.</p></li>
9136: </ol></div>
9137: <p>The best way to verify that the PLIST is correct with
9138: respect to the last two points is to regenerate it using
1.10 hubertf 9139: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9140: </div>
9141: <div class="sect2" lang="en">
9142: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9143: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9144: <p>If a package installs <code class="filename">.desktop</code> files
9145: under <code class="filename">share/applications</code> and these include
9146: MIME information, you need to take extra steps to ensure that they
9147: are registered into the MIME database:</p>
9148: <div class="orderedlist"><ol type="1">
9149: <li><p>Include
9150: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9151: <li><p>Check the PLIST and remove the entry that refers to the
9152: <code class="filename">share/applications/mimeinfo.cache</code> file.
9153: It will be handled automatically.</p></li>
9154: </ol></div>
9155: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9156: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9157: print-PLIST</strong></span>.</p>
9158: </div>
9159: </div>
9160: <div class="sect1" lang="en">
9161: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9162: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9163: <p>In some cases one does not have the time to solve a problem
9164: immediately. There are currently two ways to declare that one knows
9165: that a package has problems.</p>
9166: <div class="itemizedlist"><ul type="disc">
9167: <li><p>The first way is to plainly mark it as broken. For
9168: this, one just sets the variable <code class="varname">BROKEN</code> to the
9169: reason why the package is broken (similar to the
9170: <code class="varname">RESTRICTED</code> variable). A user trying to build
9171: the package will immediately be shown this message, and the build
9172: will not be even tried.</p></li>
9173: <li><p>After each pkgsrc freeze period (a time when the
9174: tree is stabilized and a new pkgsrc branch is cut), the packages
9175: that were not building in the official branch build on the latest
9176: NetBSD release will be marked as broken on that branch. This is
9177: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9178: branch name (or appending the branch name to it). If a user tries
9179: to build such a package and the build fails, the user gets a
9180: message that says that the package was broken on the respective
9181: branch(es).</p></li>
9182: </ul></div>
9183: <p>Both types of packages are removed from pkgsrc in irregular
9184: intervals.</p>
9185: </div>
9186: </div>
9187: <div class="chapter" lang="en">
9188: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9189: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9190: <p>To check out all the gotchas when building a package, here are
9191: the steps that I do in order to get a package working. Please note
9192: this is basically the same as what was explained in the previous
9193: sections, only with some debugging aids.</p>
9194: <div class="itemizedlist"><ul type="disc">
1.10 hubertf 9195: <li><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>
1.1 dsieger 9196: <li>
9197: <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>,
9198: create a directory for a new package, change into it, then run
1.10 hubertf 9199: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9200: <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>
9201: <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>
9202: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9203: </li>
9204: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9205: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.10 hubertf 9206: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.1 dsieger 9207: <li><p>Add any dependencies glimpsed from documentation and the
9208: configure step to the package's
9209: <code class="filename">Makefile</code>.</p></li>
9210: <li>
9211: <p>Make the package compile, doing multiple rounds of</p>
9212: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9213: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9214: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9215: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9216: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9217: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9218: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9219: <p>Doing this step as non-root user will ensure that no files
9220: are modified that shouldn't be, especially during the build
1.10 hubertf 9221: phase. <span class="command"><strong>mkpatches</strong></span>,
9222: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1 dsieger 9223: 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>
9224: package.</p>
9225: </li>
9226: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.10 hubertf 9227: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.1 dsieger 9228: <li>
9229: <p>Generate a <code class="filename">PLIST</code>:</p>
9230: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9231: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9232: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9233: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9234: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9235: <p>You usually need to be <code class="username">root</code> to do
9236: this. Look if there are any files left:</p>
9237: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9238: <p>If this reveals any files that are missing in
9239: <code class="filename">PLIST</code>, add them.</p>
9240: </li>
9241: <li>
9242: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9243: package again and make a binary package:</p>
9244: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9245: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9246: </li>
9247: <li>
9248: <p>Delete the installed package:</p>
9249: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9250: </li>
9251: <li>
1.10 hubertf 9252: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9253: command, which shouldn't find anything now:</p>
9254: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9255: </li>
9256: <li>
9257: <p>Reinstall the binary package:</p>
9258: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9259: </li>
9260: <li><p>Play with it. Make sure everything works.</p></li>
9261: <li>
1.10 hubertf 9262: <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 9263: reports:</p>
9264: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9265: </li>
1.10 hubertf 9266: <li><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 9267: </ul></div>
9268: </div>
9269: <div class="chapter" lang="en">
9270: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9271: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9272: <div class="toc">
9273: <p><b>Table of Contents</b></p>
9274: <dl>
1.6 rillig 9275: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9276: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9277: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9278: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9279: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9280: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9281: </dl>
9282: </div>
9283: <div class="sect1" lang="en">
9284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9285: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9286: <p>Our policy is that we accept binaries only from pkgsrc
9287: developers to guarantee that the packages don't contain any
9288: trojan horses etc. This is not to annoy anyone but rather to
9289: protect our users! You're still free to put up your home-made
9290: binary packages and tell the world where to get them. NetBSD
9291: developers doing bulk builds and wanting to upload them please
1.10 hubertf 9292: 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 9293: </div>
9294: <div class="sect1" lang="en">
9295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9296: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9297: <p>First, check that your package is complete, compiles and
1.10 hubertf 9298: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9299: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9300: archive that contains all files that make up the package.
9301: Finally, send this package to the pkgsrc bug tracking system,
1.10 hubertf 9302: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9303: that, go to the web page
1.10 hubertf 9304: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.1 dsieger 9305: which contains some instructions and a link to a form, where you
9306: can submit packages.</p>
9307: <p>In the form of the problem report, the category should be
9308: “<span class="quote">pkg</span>”, the synopsis should include the package name
9309: and version number, and the description field should contain a
9310: short description of your package (contents of the COMMENT
9311: variable or DESCR file are OK). The uuencoded package data should
9312: go into the “<span class="quote">fix</span>” field.</p>
9313: <p>If you want to submit several packages, please send a
9314: separate PR for each one, it's easier for us to track things
9315: that way.</p>
9316: <p>Alternatively, you can also import new packages into
9317: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
1.10 hubertf 9318: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9319: for details.</p>
9320: </div>
9321: <div class="sect1" lang="en">
9322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9323: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9324: <p>Please note all package additions, updates, moves, and
9325: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9326: important to keep this file up to date and conforming to the
9327: existing format, because it will be used by scripts to
1.10 hubertf 9328: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9329: sites. Additionally, check the
9330: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9331: for the package you updated or removed, in case it was mentioned
9332: there.</p>
9333: <p>When the <code class="varname">PKGREVISION</code> of a package is
9334: bumped, the change should appear in
9335: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9336: related or otherwise relevant. Mass bumps that result from a
9337: dependency being updated should not be mentioned. In all other
9338: cases it's the developer's decision.</p>
9339: <p>There is a make target that helps in creating proper
1.10 hubertf 9340: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9341: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9342: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9343: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9344: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9345: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9346: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9347: For new packages, or package moves or removals, set the
9348: <code class="varname">CTYPE</code> variable on the command line to "Added",
9349: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9350: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1 dsieger 9351: not the same as your NetBSD login name. Don't forget to commit
9352: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
9353: </div>
9354: <div class="sect1" lang="en">
9355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9356: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1 dsieger 9357: <p>This section is only of interest for pkgsrc developers with write
9358: access to the pkgsrc repository. Please remember that cvs
9359: imports files relative to the current working directory, and that
9360: the pathname that you
1.10 hubertf 9361: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.1 dsieger 9362: to place the files in the repository. Newly created packages should be
9363: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
9364: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
9365: <pre class="programlisting">
9366: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9367: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9368: </pre>
9369: <p>Remember to move the directory from which you imported out of
9370: the way, or cvs will complain the next time you “<span class="quote">cvs
9371: update</span>” your source tree. Also don't forget to add the new
9372: package to the category's <code class="filename">Makefile</code>.</p>
9373: <p>The commit message of the initial import should include part of the
9374: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9375: what the package is/does.</p>
9376: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
9377: add</span>” because the former gets everything with a single command,
9378: and provides a consistent tag.</p>
9379: </div>
9380: <div class="sect1" lang="en">
9381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9382: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9383: <p>Please always put a concise, appropriate and relevant summary of the
9384: changes between old and new versions into the commit log when updating
9385: a package. There are various reasons for this:</p>
9386: <div class="itemizedlist"><ul type="disc">
9387: <li><p>A URL is volatile, and can change over time. It may go away completely
9388: or its information may be overwritten by newer information.</p></li>
9389: <li><p>Having the change information between old and new versions in our CVS
9390: repository is very useful for people who use either cvs or anoncvs.</p></li>
9391: <li><p>Having the change information between old and new versions in our CVS
9392: repository is very useful for people who read the pkgsrc-changes mailing
9393: list, so that they can make tactical decisions about when to upgrade
9394: the package.</p></li>
9395: </ul></div>
9396: <p>Please also recognize that, just because a new version of a package
9397: has been released, it should not automatically be upgraded in the CVS
9398: repository. We prefer to be conservative in the packages that are
9399: included in pkgsrc - development or beta packages are not really the
9400: best thing for most places in which pkgsrc is used. Please use your
9401: judgement about what should go into pkgsrc, and bear in mind that
9402: stability is to be preferred above new and possibly untested features.</p>
9403: </div>
9404: <div class="sect1" lang="en">
9405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9406: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.1 dsieger 9407: <div class="orderedlist"><ol type="1">
9408: <li><p>Make a copy of the directory somewhere else.</p></li>
9409: <li>
9410: <p>Remove all CVS dirs.</p>
9411: <p>Alternatively to the first two steps you can also do:</p>
9412: <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>
9413: <p>and use that for further work.</p>
9414: </li>
9415: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9416: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9417: instead of “<span class="quote">../../category/package</span>”.</p></li>
1.10 hubertf 9418: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9419: place.</p></li>
9420: <li>
9421: <p>Check if any package depends on it:
9422: </p>
9423: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9424: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9425: </li>
9426: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.10 hubertf 9427: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.1 dsieger 9428: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9429: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9430: <li>
9431: <p>Commit the changed and removed files:</p>
9432: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9433: <p>(and any packages from step 5, of course).</p>
9434: </li>
9435: </ol></div>
9436: </div>
9437: </div>
9438: <div class="chapter" lang="en">
9439: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9440: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9441: <p>This section contains the answers to questions that may
9442: arise when you are writing a package. If you don't find your
9443: question answered here, first have a look in the other chapters,
9444: and if you still don't have the answer, ask on the
9445: <code class="literal">pkgsrc-users</code> mailing list.</p>
9446: <div class="qandaset">
9447: <dl>
1.6 rillig 9448: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9449: MAKEFLAGS, .MAKEFLAGS and
9450: MAKE_FLAGS?</a>
9451: </dt>
1.6 rillig 9452: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9453: MAKE, GMAKE and
9454: MAKE_PROGRAM?</a>
9455: </dt>
1.6 rillig 9456: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9457: CC, PKG_CC and
9458: PKGSRC_COMPILER?</a>
9459: </dt>
1.6 rillig 9460: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9461: BUILDLINK_LDFLAGS,
9462: BUILDLINK_LDADD and
9463: BUILDLINK_LIBS?</a>
9464: </dt>
1.6 rillig 9465: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9466: VARNAME=BUILDLINK_PREFIX.foo
9467: say it's empty?</a>
9468: </dt>
1.6 rillig 9469: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9470: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9471: don't understand the := inside
9472: it.</a>
9473: </dt>
1.6 rillig 9474: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9475: developers?</a>
9476: </dt>
1.6 rillig 9477: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9478: documentation?</a>
9479: </dt>
1.6 rillig 9480: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9481: do?</a>
9482: </dt>
9483: </dl>
9484: <table border="0" summary="Q and A Set">
9485: <col align="left" width="1%">
9486: <tbody>
9487: <tr class="question">
9488: <td align="left" valign="top">
1.11 ! rillig 9489: <a name="devfaq.makeflags"></a><a name="id2733489"></a><p><b>22.1.</b></p>
1.1 dsieger 9490: </td>
9491: <td align="left" valign="top"><p>What is the difference between
9492: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9493: <code class="varname">MAKE_FLAGS</code>?</p></td>
9494: </tr>
9495: <tr class="answer">
9496: <td align="left" valign="top"></td>
9497: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.10 hubertf 9498: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9499: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9500: the <code class="varname">MAKE_PROGRAM</code> when building the
9501: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9502: </tr>
9503: <tr class="question">
9504: <td align="left" valign="top">
1.11 ! rillig 9505: <a name="devfaq.make"></a><a name="id2733527"></a><p><b>22.2.</b></p>
1.1 dsieger 9506: </td>
9507: <td align="left" valign="top"><p>What is the difference between
9508: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9509: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9510: </tr>
9511: <tr class="answer">
9512: <td align="left" valign="top"></td>
9513: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.10 hubertf 9514: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9515: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9516: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9517: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9518: Make program that is used for building the
9519: package.</p></td>
9520: </tr>
9521: <tr class="question">
9522: <td align="left" valign="top">
1.11 ! rillig 9523: <a name="devfaq.cc"></a><a name="id2733568"></a><p><b>22.3.</b></p>
1.1 dsieger 9524: </td>
9525: <td align="left" valign="top"><p>What is the difference between
9526: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9527: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9528: </tr>
9529: <tr class="answer">
9530: <td align="left" valign="top"></td>
9531: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9532: compiler, which can be configured by the pkgsrc user.
9533: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9534: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9535: path to a compiler, but the type of compiler that should be
9536: used. See <code class="filename">mk/compiler.mk</code> for more
9537: information about the latter variable.</p></td>
9538: </tr>
9539: <tr class="question">
9540: <td align="left" valign="top">
1.11 ! rillig 9541: <a name="devfaq.bl3flags"></a><a name="id2733607"></a><p><b>22.4.</b></p>
1.1 dsieger 9542: </td>
9543: <td align="left" valign="top"><p>What is the difference between
9544: <code class="varname">BUILDLINK_LDFLAGS</code>,
9545: <code class="varname">BUILDLINK_LDADD</code> and
9546: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9547: </tr>
9548: <tr class="answer">
9549: <td align="left" valign="top"></td>
9550: <td align="left" valign="top"><p>[FIXME]</p></td>
9551: </tr>
9552: <tr class="question">
9553: <td align="left" valign="top">
1.11 ! rillig 9554: <a name="devfaq.bl3prefix"></a><a name="id2733627"></a><p><b>22.5.</b></p>
1.1 dsieger 9555: </td>
1.10 hubertf 9556: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9557: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9558: say it's empty?</p></td>
9559: </tr>
9560: <tr class="answer">
9561: <td align="left" valign="top"></td>
9562: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9563: available in the “<span class="quote">wrapper</span>” phase and later. To
9564: “<span class="quote">simulate</span>” the wrapper phase, append
1.10 hubertf 9565: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9566: command.</p></td>
9567: </tr>
9568: <tr class="question">
9569: <td align="left" valign="top">
1.11 ! rillig 9570: <a name="devfaq.master_sites"></a><a name="id2733657"></a><p><b>22.6.</b></p>
1.1 dsieger 9571: </td>
9572: <td align="left" valign="top"><p>What does
9573: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9574: don't understand the <code class="literal">:=</code> inside
9575: it.</p></td>
9576: </tr>
9577: <tr class="answer">
9578: <td align="left" valign="top"></td>
9579: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9580: assignment operator, like you might expect at first sight.
9581: Instead, it is a degenerate form of
9582: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.10 hubertf 9583: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.1 dsieger 9584: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9585: case of <code class="varname">MASTER_SITE_*</code>,
9586: <em class="replaceable"><code>old_string</code></em> is the empty string and
9587: <em class="replaceable"><code>new_string</code></em> is
9588: <code class="literal">package/</code>. That's where the
9589: <code class="literal">:</code> and the <code class="literal">=</code> fall
9590: together.</p></td>
9591: </tr>
9592: <tr class="question">
9593: <td align="left" valign="top">
1.11 ! rillig 9594: <a name="devfaq.mailinglists"></a><a name="id2733734"></a><p><b>22.7.</b></p>
1.1 dsieger 9595: </td>
9596: <td align="left" valign="top"><p>Which mailing lists are there for package
9597: developers?</p></td>
9598: </tr>
9599: <tr class="answer">
9600: <td align="left" valign="top"></td>
9601: <td align="left" valign="top"><div class="variablelist"><dl>
1.10 hubertf 9602: <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 9603: <dd><p>This is a list for technical discussions related
9604: to pkgsrc development, e.g. soliciting feedback for changes to
9605: pkgsrc infrastructure, proposed new features, questions related
9606: to porting pkgsrc to a new platform, advice for maintaining a
9607: package, patches that affect many packages, help requests moved
9608: from pkgsrc-users when an infrastructure bug is found,
9609: etc.</p></dd>
1.10 hubertf 9610: <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 9611: <dd><p>All bug reports in category "pkg" sent with
1.10 hubertf 9612: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 9613: directly; use one of the other mailing
9614: lists.</p></dd>
9615: </dl></div></td>
9616: </tr>
9617: <tr class="question">
9618: <td align="left" valign="top">
1.11 ! rillig 9619: <a name="devfaq.documentation"></a><a name="id2733772"></a><p><b>22.8.</b></p>
1.1 dsieger 9620: </td>
9621: <td align="left" valign="top"><p>Where is the pkgsrc
9622: documentation?</p></td>
9623: </tr>
9624: <tr class="answer">
9625: <td align="left" valign="top"></td>
9626: <td align="left" valign="top">
9627: <p>There are many places where you can find
9628: documentation about pkgsrc:</p>
9629: <div class="itemizedlist"><ul type="disc">
9630: <li><p>The pkgsrc guide (this document) is a collection
9631: of chapters that explain large parts of pkgsrc, but some
9632: chapters tend to be outdated. Which ones they are is hard to
9633: say.</p></li>
1.10 hubertf 9634: <li><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 9635: about certain features, announcements of new parts of the pkgsrc
9636: infrastructure and sometimes even announcements that a certain
9637: feature has been marked as obsolete. The benefit here is that
9638: each message has a date appended to it.</p></li>
9639: <li><p>Many of the files in the
9640: <code class="filename">mk/</code> directory start with a comment that
9641: describes the purpose of the file and how it can be used by the
9642: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9643: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9644: help</strong></span>.</p></li>
9645: <li><p>The CVS log messages are a rich source of
9646: information, but they tend to be highly abbreviated, especially
9647: for actions that occur often. Some contain a detailed
9648: description of what has changed, but they are geared towards the
9649: other pkgsrc developers, not towards an average pkgsrc user.
9650: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9651: don't know what has been before, these messages may not be worth
9652: too much to you.</p></li>
9653: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9654: documented</span>”, that is the documentation exists only in the
9655: mind of the developer who wrote the code. To get this
1.10 hubertf 9656: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 9657: to see who has written it and ask on the
9658: <code class="literal">tech-pkg</code> mailing list, so that others can
9659: find your questions later (see above). To be sure that the
9660: developer in charge reads the mail, you may CC him or
9661: her.</p></li>
9662: </ul></div>
9663: </td>
9664: </tr>
9665: <tr class="question">
9666: <td align="left" valign="top">
1.11 ! rillig 9667: <a name="devfaq.too-much-time"></a><a name="id2733902"></a><p><b>22.9.</b></p>
1.1 dsieger 9668: </td>
9669: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9670: do?</p></td>
9671: </tr>
9672: <tr class="answer">
9673: <td align="left" valign="top"></td>
9674: <td align="left" valign="top">
9675: <p>This is not really an FAQ yet, but here's the answer
9676: anyway.</p>
9677: <div class="itemizedlist"><ul type="disc">
1.10 hubertf 9678: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1 dsieger 9679: <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
9680: will tell you about newer versions of installed packages that are
9681: available, but not yet updated in pkgsrc.</p></li>
9682: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.11 ! rillig 9683: — it contains a list of suggested new packages and a list of
1.1 dsieger 9684: cleanups and enhancements for pkgsrc that would be nice to
9685: have.</p></li>
9686: <li><p>Review packages for which review was requested on
1.10 hubertf 9687: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1 dsieger 9688: mailing list.</p></li>
9689: </ul></div>
9690: </td>
9691: </tr>
9692: </tbody>
9693: </table>
9694: </div>
9695: </div>
9696: <div class="chapter" lang="en">
9697: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9698: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9699: <div class="toc">
9700: <p><b>Table of Contents</b></p>
9701: <dl>
1.6 rillig 9702: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9703: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9704: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9705: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9706: </dl>
9707: </div>
1.10 hubertf 9708: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 9709: site</a>:</p>
9710: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9711: environment, an intuitive and attractive desktop for users, and the
9712: GNOME development platform, an extensive framework for building
9713: applications that integrate into the rest of the desktop.</p></blockquote></div>
9714: <p>pkgsrc provides a seamless way to automatically build and install
9715: a complete GNOME environment <span class="emphasis"><em>under many different
9716: platforms</em></span>. We can say with confidence that pkgsrc is one of
9717: the most advanced build and packaging systems for GNOME due to its
9718: included technologies buildlink3, the wrappers and tools framework and
9719: automatic configuration file management. Lots of efforts are put into
9720: achieving a completely clean deinstallation of installed software
9721: components.</p>
1.10 hubertf 9722: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 9723: the above also means that great efforts are put into making GNOME work
1.10 hubertf 9724: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 9725: pkgsrc as its preferred packaging system, contributing lots of
9726: portability fixes to make GNOME build and install under it.</p>
9727: <p>This chapter is aimed at pkgsrc developers and other people
9728: interested in helping our GNOME porting and packaging efforts. It
9729: provides instructions on how to manage the existing packages and some
9730: important information regarding their internals.</p>
9731: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9732: <h3 class="title">We need your help!</h3>
9733: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9734: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 9735: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 9736: work</a> list! There is still a long way to go to get a
9737: fully-functional GNOME desktop under NetBSD and we need your help to
9738: achieve it!</p>
9739: </div>
9740: <div class="sect1" lang="en">
9741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9742: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9743: <p>pkgsrc includes three GNOME-related meta packages:</p>
9744: <div class="itemizedlist"><ul type="disc">
9745: <li><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
9746: the core GNOME desktop environment. It only includes the necessary
9747: bits to get it to boot correctly, although it may lack important
9748: functionality for daily operation. The idea behind this package is
9749: to let end users build their own configurations on top of this one,
9750: first installing this meta package to achieve a functional setup and
9751: then adding individual applications.</p></li>
9752: <li><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
9753: complete installation of the GNOME platform and desktop as defined
9754: by the GNOME project; this is based on the components distributed in
9755: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9756: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9757: official FTP server. Developer-only tools found in those
9758: directories are not installed unless required by some other
9759: component to work properly. Similarly, packages from the bindings
9760: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9761: in unless required as a dependency for an end-user component. This
9762: 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>
9763: <li><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>:
9764: Installs all the tools required to build a GNOME component when
9765: fetched from the CVS repository. These are required to let the
1.10 hubertf 9766: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 9767: </ul></div>
9768: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9769: sorted in a way that eases updates: a package may depend on other
9770: packages listed before it but not on any listed after it. It is very
9771: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9772: change it to alphabetical sorting!</em></span></p>
9773: </div>
9774: <div class="sect1" lang="en">
9775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9776: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9777: <p>Almost all GNOME applications are written in C and use a common
9778: set of tools as their build system. Things get different with the new
9779: bindings to other languages (such as Python), but the following will
9780: give you a general idea on the minimum required tools:</p>
9781: <div class="itemizedlist"><ul type="disc">
9782: <li>
9783: <p>Almost all GNOME applications use the GNU Autotools as their
9784: build system. As a general rule you will need to tell this to your
9785: package:</p>
9786: <pre class="programlisting">
9787: GNU_CONFIGURE=yes
9788: USE_LIBTOOL=yes
9789: USE_TOOLS+=gmake
9790: </pre>
9791: </li>
9792: <li>
9793: <p>If the package uses pkg-config to detect dependencies, add this
9794: tool to the list of required utilities:</p>
9795: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9796: <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
9797: the end of the build process to ensure that you did not miss to
9798: specify any dependency in your package and that the version
9799: requirements are all correct.</p>
9800: </li>
9801: <li><p>If the package uses intltool, be sure to add
9802: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9803: to handle dependencies and to force the package to use the latest
9804: available version.</p></li>
9805: <li>
9806: <p>If the package uses gtk-doc (a documentation generation
9807: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9808: tool is rather big and the distfile should come with pregenerated
9809: documentation anyway; if it does not, it is a bug that you ought to
9810: report. For such packages you should disable gtk-doc (unless it is
9811: the default):</p>
9812: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9813: <p>The default location of installed HTML files
9814: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9815: and should not be changed unless the package insists on installing
9816: them somewhere else. Otherwise programs as
1.10 hubertf 9817: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 9818: do that with an entry similar to:</p>
9819: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9820: </li>
9821: </ul></div>
9822: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9823: files under the installation prefix to maintain databases. In this
9824: context, shared means that those exact same directories and files are
9825: used among several different packages, leading to conflicts in the
9826: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9827: handle the most common cases, so you have to forget about using
9828: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9829: omitting shared files from them. If you find yourself doing those,
9830: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9831: <p>The following table lists the common situations that result in
9832: using shared directories or files. For each of them, the appropriate
9833: solution is given. After applying the solution be sure to
9834: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 9835: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 9836: <div class="table">
1.6 rillig 9837: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 9838: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9839: <colgroup>
9840: <col>
9841: <col>
9842: </colgroup>
9843: <thead><tr>
9844: <th>If the package...</th>
9845: <th>Then...</th>
9846: </tr></thead>
9847: <tbody>
9848: <tr>
9849: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.10 hubertf 9850: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, “Packages installing scrollkeeper data files”</a>.</td>
1.1 dsieger 9851: </tr>
9852: <tr>
9853: <td>Installs icons under the
9854: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9855: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 9856: <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 9857: </tr>
9858: <tr>
9859: <td>Installs files under
9860: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 9861: <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 9862: </tr>
9863: <tr>
9864: <td>Installs <code class="filename">.desktop</code> files under
9865: <code class="filename">share/applications</code> and these include MIME
9866: information.</td>
1.10 hubertf 9867: <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 9868: </tr>
9869: </tbody>
9870: </table></div>
9871: </div>
9872: <br class="table-break">
9873: </div>
9874: <div class="sect1" lang="en">
9875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9876: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 9877: <p>When seeing GNOME as a whole, there are two kinds of
9878: updates:</p>
9879: <div class="variablelist"><dl>
9880: <dt><span class="term">Major update</span></dt>
9881: <dd>
9882: <p>Given that there is still a very long way for GNOME 3 (if it
9883: ever appears), we consider a major update one that goes from a
9884: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9885: where <code class="literal">Y</code> is even and greater than
9886: <code class="literal">X</code>. These are hard to achieve because they
9887: introduce lots of changes in the components' code and almost all
9888: GNOME distfiles are updated to newer versions. Some of them can
9889: even break API and ABI compatibility with the previous major
9890: version series. As a result, the update needs to be done all at
9891: once to minimize breakage.</p>
9892: <p>A major update typically consists of around 80 package
9893: updates and the addition of some new ones.</p>
9894: </dd>
9895: <dt><span class="term">Minor update</span></dt>
9896: <dd>
9897: <p>We consider a minor update one that goes from a
9898: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9899: one where <code class="literal">Y</code> is greater than
9900: <code class="literal">X</code>. These are easy to achieve because they do
9901: not update all GNOME components, can be done in an incremental way
9902: and do not break API nor ABI compatibility.</p>
9903: <p>A minor update typically consists of around 50 package
9904: updates, although the numbers here may vary a lot.</p>
9905: </dd>
9906: </dl></div>
9907: <p>In order to update the GNOME components in pkgsrc to a new stable
9908: release (either major or minor), the following steps should be
9909: followed:</p>
9910: <div class="orderedlist"><ol type="1">
9911: <li>
9912: <p>Get a list of all the tarballs that form the new release by
9913: using the following commands. These will leave the full list of the
9914: components's distfiles into the <code class="filename">list.txt</code>
9915: file:</p>
9916: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9917: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9918: awk '{ print $9 }' >list.txt</code></strong>
9919: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
9920: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9921: awk '{ print $9 }' >>list.txt</code></strong></pre>
9922: </li>
9923: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9924: bump their version to the release you are updating them to. The
9925: three meta packages should be always consistent with versioning.
9926: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9927: in them.</p></li>
9928: <li>
9929: <p>For each meta package, update all its
9930: <code class="varname">DEPENDS</code> lines to match the latest versions as
9931: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9932: newer version (even if found in the FTP) because the meta packages
9933: are supposed to list the exact versions that form a specific GNOME
9934: release. Exceptions are permitted here if a newer version solves a
9935: serious issue in the overall desktop experience; these typically
9936: come in the form of a revision bump in pkgsrc, not in newer versions
9937: from the developers.</p>
9938: <p>Packages not listed in the <code class="filename">list.txt</code> file
9939: should be updated to the latest version available (if found in
9940: pkgsrc). This is the case, for example, of the dependencies on the
9941: 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>
9942: </li>
9943: <li>
9944: <p>Generate a patch from the modified meta packages and extract the
9945: list of "new" lines. This will provide you an outline on what
9946: packages need to be updated in pkgsrc and in what order:</p>
9947: <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>
9948: </li>
9949: <li><p>For major desktop updates it is recommended to zap all your
9950: installed packages and start over from scratch at this point.</p></li>
9951: <li><p>Now comes the longest step by far: iterate over the contents
9952: of <code class="filename">todo.txt</code> and update the packages listed in
9953: it in order. For major desktop updates none of these should be
9954: committed until the entire set is completed because there are chances
9955: of breaking not-yet-updated packages.</p></li>
9956: <li><p>Once the packages are up to date and working, commit them to
9957: the tree one by one with appropriate log messages. At the end,
9958: commit the three meta package updates and all the corresponding
9959: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9960: <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>
9961: </ol></div>
9962: </div>
9963: <div class="sect1" lang="en">
9964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9965: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 9966: <p>GNOME is a very big component in pkgsrc which approaches 100
9967: packages. Please, it is very important that you always, always,
9968: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 9969: 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 9970: their attention on portability issues and to ensure that future versions
9971: can be built out-of-the box on NetBSD. The less custom patches in
9972: pkgsrc, the easier further updates are. Those developers in charge of
9973: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 9974: <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 9975: Bugzilla</a>. Not all components use these to track bugs, but most
9976: of them do. Do not be short on your reports: always provide detailed
9977: explanations of the current failure, how it can be improved to achieve
9978: maximum portability and, if at all possible, provide a patch against CVS
9979: head. The more verbose you are, the higher chances of your patch being
9980: accepted.</p>
9981: <p>Also, please avoid using preprocessor magic to fix portability
9982: issues. While the FreeBSD GNOME people are doing a great job in porting
9983: GNOME to their operating system, the official GNOME sources are now
9984: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9985: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 9986: 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 9987: details.</p>
9988: </div>
9989: </div>
9990: </div>
9991: <div class="part" lang="en">
9992: <div class="titlepage"><div><div><h1 class="title">
9993: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
9994: <div class="partintro" lang="en">
9995: <div></div>
9996: <p>This part of the guide deals with everything
9997: from the infrastructure that is behind the interfaces described
9998: in the developer's guide. A casual package maintainer should not
9999: need anything from this part.</p>
10000: <div class="toc">
10001: <p><b>Table of Contents</b></p>
10002: <dl>
1.6 rillig 10003: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10004: <dd><dl>
1.6 rillig 10005: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10006: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10007: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10008: <dd><dl>
1.6 rillig 10009: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10010: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10011: </dl></dd>
1.6 rillig 10012: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10013: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10014: <dd><dl>
1.6 rillig 10015: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10016: <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 10017: </dl></dd>
1.6 rillig 10018: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10019: <dd><dl>
1.6 rillig 10020: <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>
10021: <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 10022: </dl></dd>
10023: </dl></dd>
1.6 rillig 10024: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10025: <dd><dl>
1.6 rillig 10026: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10027: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10028: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10029: <dd><dl>
1.6 rillig 10030: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10031: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10032: </dl></dd>
10033: </dl></dd>
1.6 rillig 10034: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10035: <dd><dl>
1.6 rillig 10036: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10037: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10038: </dl></dd>
10039: </dl>
10040: </div>
10041: </div>
10042: <div class="chapter" lang="en">
10043: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10044: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10045: <div class="toc">
10046: <p><b>Table of Contents</b></p>
10047: <dl>
1.6 rillig 10048: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10049: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10050: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10051: <dd><dl>
1.6 rillig 10052: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10053: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10054: </dl></dd>
1.6 rillig 10055: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10056: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10057: <dd><dl>
1.6 rillig 10058: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10059: <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 10060: </dl></dd>
1.6 rillig 10061: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10062: <dd><dl>
1.6 rillig 10063: <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>
10064: <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 10065: </dl></dd>
10066: </dl>
10067: </div>
10068: <p>The pkgsrc infrastructure consists of many small Makefile
10069: fragments. Each such fragment needs a properly specified
10070: interface. This chapter explains how such an interface looks
10071: like.</p>
10072: <div class="sect1" lang="en">
10073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10074: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10075: <p>Whenever a variable is defined in the pkgsrc
10076: infrastructure, the location and the way of definition provide
10077: much information about the intended use of that variable.
10078: Additionally, more documentation may be found in a header
10079: comment or in this pkgsrc guide.</p>
10080: <p>A special file is
10081: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10082: variables that are intended to be user-defined. They are either
10083: defined using the <code class="literal">?=</code> operator or they are
10084: left undefined because defining them to anything would
10085: effectively mean “<span class="quote">yes</span>”. All these variables may be
10086: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10087: file.</p>
10088: <p>Outside this file, the following conventions apply:
10089: Variables that are defined using the <code class="literal">?=</code>
10090: operator may be overridden by a package.</p>
10091: <p>Variables that are defined using the <code class="literal">=</code>
10092: operator may be used read-only at run-time.</p>
10093: <p>Variables whose name starts with an underscore must not be
10094: accessed outside the pkgsrc infrastructure at all. They may
10095: change without further notice.</p>
10096: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10097: <h3 class="title">Note</h3>
10098: <p>These conventions are currently not applied
10099: consistently to the complete pkgsrc
10100: infrastructure.</p>
10101: </div>
10102: </div>
10103: <div class="sect1" lang="en">
10104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10105: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10106: <p>All variables that contain lists of things should default
10107: to being empty. Two examples that do not follow this rule are
10108: <code class="varname">USE_LANGUAGES</code> and
10109: <code class="varname">DISTFILES</code>. These variables cannot simply be
10110: modified using the <code class="literal">+=</code> operator in package
10111: <code class="filename">Makefile</code>s (or other files included by
10112: them), since there is no guarantee whether the variable is
10113: already set or not, and what its value is. In the case of
10114: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10115: the default value and just define it as in the following
10116: example.</p>
10117: <pre class="programlisting">
10118: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10119: </pre>
10120: <p>Because of the selection of this default value, the same
10121: value appears in many package Makefiles. Similarly for
10122: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10123: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10124: doesn't stand out. Nevertheless it is mentioned in many
10125: files.</p>
10126: </div>
10127: <div class="sect1" lang="en">
10128: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10129: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.1 dsieger 10130: <div class="sect2" lang="en">
10131: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10132: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10133: <p>Variable evaluation takes place either at load time or at
10134: runtime, depending on the context in which they occur. The
10135: contexts where variables are evaluated at load time are:</p>
10136: <div class="itemizedlist"><ul type="disc">
10137: <li><p>The right hand side of the <code class="literal">:=</code>
10138: and <code class="literal">!=</code> operators,</p></li>
10139: <li><p>Make directives like <code class="literal">.if</code> or
10140: <code class="literal">.for</code>,</p></li>
10141: <li><p>Dependency lines.</p></li>
10142: </ul></div>
10143: <p>A special exception are references to the iteration
10144: variables of <code class="literal">.for</code> loops, which are expanded
10145: inline, no matter in which context they appear.</p>
10146: <p>As the values of variables may change during load time,
10147: care must be taken not to evaluate them by accident. Typical
10148: examples for variables that should not be evaluated at load time
10149: are <code class="varname">DEPENDS</code> and
10150: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10151: clear, here is an example:</p>
10152: <pre class="programlisting">
10153: CONFIGURE_ARGS= # none
10154: CFLAGS= -O
10155: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10156:
10157: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10158:
10159: CFLAGS+= -Wall
10160: </pre>
10161: <p>This code shows how the use of the <code class="literal">:=</code>
10162: operator can quickly lead to unexpected results. The first
10163: paragraph is fairly common code. The second paragraph evaluates
10164: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10165: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10166: <code class="literal">-Wall</code> is appended to the
10167: <code class="varname">CFLAGS</code>, but this addition will not appear in
10168: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10169: paragraphs from above typically occur in completely unrelated
10170: files.</p>
10171: </div>
10172: <div class="sect2" lang="en">
10173: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10174: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10175: <p>After all the files have been loaded, the values of the
10176: variables cannot be changed anymore. Variables that are used in
10177: the shell commands are expanded at this point.</p>
10178: </div>
10179: </div>
10180: <div class="sect1" lang="en">
10181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10182: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10183: <p>There are many ways in which the definition and use of a
10184: variable can be restricted in order to detect bugs and
10185: violations of the (mostly unwritten) policies. See the
10186: <code class="literal">pkglint</code> developer's documentation for further
10187: details.</p>
10188: </div>
10189: <div class="sect1" lang="en">
10190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10191: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10192: <p>Most of the <code class="filename">.mk</code> files fall into one
10193: of the following classes. Cases where a file falls into more
10194: than one class should be avoided as it often leads to subtle
10195: bugs.</p>
10196: <div class="sect2" lang="en">
10197: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10198: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10199: <p>In a traditional imperative programming language some of
10200: the <code class="filename">.mk</code> files could be described as
1.11 ! rillig 10201: procedures. They take some input parameters and—after
! 10202: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10203: variables in <code class="filename">Makefile</code>s have global scope
10204: care must be taken not to use parameter names that have already
10205: another meaning. For example, <code class="varname">PKGNAME</code> is a
10206: bad choice for a parameter name.</p>
10207: <p>Procedures are completely evaluated at preprocessing time.
10208: That is, when calling a procedure all input parameters must be
10209: completely resolvable. For example,
10210: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10211: parameter since it is very likely that further text will be
10212: added after calling the procedure, which would effectively apply
10213: the procedure to only a part of the variable. Also, references
10214: to other variables wit will be modified after calling the
10215: procedure.</p>
10216: <p>A procedure can declare its output parameters either as
10217: suitable for use in preprocessing directives or as only
10218: available at runtime. The latter alternative is for variables
10219: that contain references to other runtime variables.</p>
10220: <p>Procedures shall be written such that it is possible to
10221: call the procedure more than once. That is, the file must not
10222: contain multiple-inclusion guards.</p>
10223: <p>Examples for procedures are
10224: <code class="filename">mk/bsd.options.mk</code> and
10225: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10226: that the parameters are evaluated at load time, they should be
10227: assigned using the <code class="literal">:=</code> operator, which should
10228: be used only for this purpose.</p>
10229: </div>
10230: <div class="sect2" lang="en">
10231: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10232: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10233: <p>Action files take some input parameters and may define
10234: runtime variables. They shall not define loadtime variables.
10235: There are action files that are included implicitly by the
10236: pkgsrc infrastructure, while other must be included
10237: explicitly.</p>
10238: <p>An example for action files is
10239: <code class="filename">mk/subst.mk</code>.</p>
10240: </div>
10241: </div>
10242: <div class="sect1" lang="en">
10243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10244: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10245: <p>Package <code class="filename">Makefile</code>s usually consist of
10246: a set of variable definitions, and include the file
10247: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10248: Before that, they may also include various other
10249: <code class="filename">*.mk</code> files if they need to query the
10250: availability of certain features like the type of compiler or
10251: the X11 implementation. Due to the heavy use of preprocessor
10252: directives like <code class="literal">.if</code> and
10253: <code class="literal">.for</code>, the order in which the files are loaded
10254: matters.</p>
10255: <p>This section describes at which point the various files
10256: are loaded and gives reasons for that order.</p>
10257: <div class="sect2" lang="en">
10258: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10259: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10260: </h3></div></div></div>
10261: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10262: is to define some essential variables like
10263: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10264: <code class="varname">MACHINE_ARCH</code>.</p>
10265: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10266: 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 10267: After that, those variables
1.1 dsieger 10268: that have not been overridden by the user are loaded from
10269: <code class="filename">mk/defaults/mk.conf</code>.</p>
10270: <p>After the user settings, the system settings and platform
10271: settings are loaded, which may override the user
10272: settings.</p>
10273: <p>Then, the tool definitions are loaded. The tool wrappers
10274: are not yet in effect. This only happens when building a
10275: package, so the proper variables must be used instead of the
10276: direct tool names.</p>
10277: <p>As the last steps, some essential variables from the
10278: wrapper and the package system flavor are loaded, as well as the
10279: variables that have been cached in earlier phases of a package
10280: build.</p>
10281: </div>
10282: <div class="sect2" lang="en">
10283: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10284: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10285: </h3></div></div></div>
10286: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10287: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10288: loaded, which fill default values for those variables that have
10289: not been defined by the package. These variables may later
10290: be used even in unrelated files.</p>
10291: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10292: provides the target <code class="literal">error-check</code> that is added
10293: as a special dependency to all other targets that use
10294: <code class="varname">DELAYED_ERROR_MSG</code> or
10295: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10296: <p>Then, the package-specific hacks from
10297: <code class="filename">hacks.mk</code> are included.</p>
10298: <p>Then, various other files follow. Most of them don't have
10299: any dependencies on what they need to have included before or
10300: after them, though some do.</p>
10301: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10302: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10303: restricts the use of these variables to all the files that have
10304: been included before. Appearances in later files will be
10305: silently ignored.</p>
10306: <p>Then, the files for the main targets are included, in the
10307: order of later execution, though the actual order should not
10308: matter.</p>
10309: <p>At last, some more files are included that don't set any
10310: interesting variables but rather just define make targets to be
10311: executed.</p>
10312: </div>
10313: </div>
10314: </div>
10315: <div class="chapter" lang="en">
10316: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10317: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10318: <div class="toc">
10319: <p><b>Table of Contents</b></p>
10320: <dl>
1.6 rillig 10321: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10322: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10323: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10324: <dd><dl>
1.6 rillig 10325: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10326: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10327: </dl></dd>
10328: </dl>
10329: </div>
10330: <p>The pkgsrc infrastructure consists of a large codebase,
10331: and there are many corners where every little bit of a file is
10332: well thought out, making pkgsrc likely to fail as soon as
10333: anything is changed near those parts. To prevent most changes
10334: from breaking anything, a suite of regression tests should go
10335: along with every important part of the pkgsrc infrastructure.
10336: This chapter describes how regression tests work in pkgsrc and
10337: how you can add new tests.</p>
10338: <div class="sect1" lang="en">
10339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10340: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10341: <p></p>
10342: </div>
10343: <div class="sect1" lang="en">
10344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10345: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10346: <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 10347: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10348: can simply run that command, which will run all tests in the
10349: <code class="filename">regress</code> category.</p>
10350: </div>
10351: <div class="sect1" lang="en">
10352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10353: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10354: <p>Every directory in the <code class="filename">regress</code>
10355: category that contains a file called <code class="filename">spec</code>
10356: is considered a regression test. This file is a shell program
1.10 hubertf 10357: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10358: The following functions can be overridden to suit your
10359: needs.</p>
10360: <div class="sect2" lang="en">
10361: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10362: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10363: <p>These functions do not take any parameters. They are all
10364: called in “<span class="quote">set -e</span>” mode, so you should be careful
10365: to check the exitcodes of any commands you run in the
10366: test.</p>
10367: <div class="variablelist"><dl>
10368: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10369: <dd><p>This function prepares the environment for the
10370: test. By default it does nothing.</p></dd>
10371: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10372: <dd><p>This function runs the actual test. By default,
10373: it calls <code class="varname">TEST_MAKE</code> with the arguments
10374: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10375: error messages into the file
10376: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10377: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10378: <dd><p>This function is run after the test and is
10379: typically used to compare the actual output from the one that is
10380: expected. It can make use of the various helper functions from
10381: the next section.</p></dd>
10382: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10383: <dd><p>This function cleans everything up after the
10384: test has been run. By default it does nothing.</p></dd>
10385: </dl></div>
10386: </div>
10387: <div class="sect2" lang="en">
10388: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10389: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1 dsieger 10390: <div class="variablelist"><dl>
10391: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10392: <dd><p>This function compares the exitcode of the
1.10 hubertf 10393: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10394: If they differ, the test will fail.</p></dd>
10395: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10396: <dd><p>This function checks for each of its parameters
1.10 hubertf 10397: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10398: extended regular expression. If it does not, the test will
10399: fail.</p></dd>
10400: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10401: <dd><p>This function checks for each of its parameters
1.10 hubertf 10402: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10403: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10404: If any of the regular expressions matches, the test will
10405: fail.</p></dd>
10406: </dl></div>
10407: </div>
10408: </div>
10409: </div>
10410: <div class="chapter" lang="en">
10411: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10412: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10413: <div class="toc">
10414: <p><b>Table of Contents</b></p>
10415: <dl>
1.6 rillig 10416: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10417: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10418: </dl>
10419: </div>
10420: <p>The pkgsrc system has already been ported to many
10421: operating systems, hardware architectures and compilers. This
10422: chapter explains the necessary steps to make pkgsrc even more
10423: portable.</p>
10424: <div class="sect1" lang="en">
10425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10426: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10427: <p>To port pkgsrc to a new operating system (called
10428: <code class="literal">MyOS</code> in this example), you need to touch the
10429: following files:</p>
10430: <div class="variablelist"><dl>
10431: <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>
10432: <dd><p>This file contains some basic definitions, for
10433: example the name of the C
10434: compiler.</p></dd>
10435: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10436: <dd><p>Insert code that defines the variables
10437: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10438: <code class="varname">LOWER_OS_VERSION</code>,
10439: <code class="varname">LOWER_VENDOR</code>,
10440: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10441: <code class="varname">APPEND_ELF</code>, and the other variables that
10442: appear in this file.</p></dd>
10443: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10444: <dd><p>This file contains the platform-specific
10445: definitions that are used by pkgsrc. Start by copying one of the
10446: other files and edit it to your
10447: needs.</p></dd>
10448: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10449: <dd><p>This file contains a list of directories,
10450: together with their permission bits and ownership. These
10451: directories will be created automatically with every package
10452: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10453: be removed.</p></dd>
10454: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10455: <dd><p>Just copy one of the pre-existing x11.dist files
10456: to your
10457: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10458: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10459: <dd><p>On some operating systems, the tools that are
10460: provided with the base system are not good enough for pkgsrc.
1.10 hubertf 10461: For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.1 dsieger 10462: narrow limit on the line length they can process. Therefore
10463: pkgsrc brings its own tools, which can be enabled
10464: here.</p></dd>
10465: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10466: <dd><p>This file defines the paths to all the tools
10467: that are needed by one or the other package in pkgsrc, as well
10468: as by pkgsrc itself. Find out where these tools are on your
10469: platform and add them.</p></dd>
10470: </dl></div>
10471: <p>Now, you should be able to build some basic packages, like
10472: <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>
10473: </div>
10474: <div class="sect1" lang="en">
10475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10476: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10477: <p>TODO</p>
10478: </div>
10479: </div>
10480: </div>
10481: <div class="appendix" lang="en">
10482: <div class="titlepage"><div><div><h2 class="title">
10483: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10484: <div class="toc">
10485: <p><b>Table of Contents</b></p>
10486: <dl>
10487: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10488: <dd><dl>
10489: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10490: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10491: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.10 hubertf 10492: <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 10493: </dl></dd>
10494: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10495: </dl>
10496: </div>
10497: <p>We checked to find a piece of software that wasn't in the packages
10498: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10499: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10500: present in the tree is beyond us, but it's useful for the purposes of
10501: this exercise.</p>
10502: <div class="sect1" lang="en">
10503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10504: <a name="example-files"></a>A.1. files</h2></div></div></div>
10505: <div class="sect2" lang="en">
10506: <div class="titlepage"><div><div><h3 class="title">
10507: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10508: <pre class="programlisting">
10509: # $NetBSD$
10510: #
10511:
10512: DISTNAME= bison-1.25
10513: CATEGORIES= devel
10514: MASTER_SITES= ${MASTER_SITE_GNU}
10515:
10516: MAINTAINER= thorpej@NetBSD.org
10517: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10518: COMMENT= GNU yacc clone
10519:
10520: GNU_CONFIGURE= yes
10521: INFO_FILES= bison.info
10522:
10523: .include "../../mk/bsd.pkg.mk"
10524: </pre>
10525: </div>
10526: <div class="sect2" lang="en">
10527: <div class="titlepage"><div><div><h3 class="title">
10528: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10529: <pre class="programlisting">
10530: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.10 hubertf 10531: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10532: of the NetBSD source tree is beyond me.
10533: </pre>
10534: </div>
10535: <div class="sect2" lang="en">
10536: <div class="titlepage"><div><div><h3 class="title">
10537: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10538: <pre class="programlisting">
10539: @comment $NetBSD$
10540: bin/bison
10541: man/man1/bison.1.gz
10542: share/bison.simple
10543: share/bison.hairy
10544: </pre>
10545: </div>
10546: <div class="sect2" lang="en">
10547: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10548: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10549: </h3></div></div></div>
10550: <p>The NetBSD package system comes with
10551: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10552: which helps to check the contents of these
10553: files. After installation it is quite easy to use, just change to the
10554: directory of the package you wish to examine and execute
1.10 hubertf 10555: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10556: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10557: looks fine.</pre>
10558: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10559: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10560: -Wall</strong></span> for a very thorough check.</p>
10561: </div>
10562: </div>
10563: <div class="sect1" lang="en">
10564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10565: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10566: <p>Create the directory where the package lives,
10567: plus any auxiliary directories:</p>
10568: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10569: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10570: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10571: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10572: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10573: <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 10574: then continue with fetching the distfile:</p>
10575: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10576: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10577: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10578: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10579: ftp: Error retrieving file: 500 Internal error
10580:
10581: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10582: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10583: ftp: Error retrieving file: 500 Internal error
10584:
10585: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10586: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10587: Successfully retrieved file.</pre>
10588: <p>Generate the checksum of the distfile into
10589: <code class="filename">distinfo</code>:</p>
10590: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10591: <p>Now compile:</p>
10592: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10593: >> Checksum OK for bison-1.25.tar.gz.
10594: ===> Extracting for bison-1.25
10595: ===> Patching for bison-1.25
10596: ===> Ignoring empty patch directory
10597: ===> Configuring for bison-1.25
10598: creating cache ./config.cache
10599: checking for gcc... cc
10600: checking whether we are using GNU C... yes
10601: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10602: checking how to run the C preprocessor... cc -E
10603: checking for minix/config.h... no
10604: checking for POSIXized ISC... no
10605: checking whether cross-compiling... no
10606: checking for ANSI C header files... yes
10607: checking for string.h... yes
10608: checking for stdlib.h... yes
10609: checking for memory.h... yes
10610: checking for working const... yes
10611: checking for working alloca.h... no
10612: checking for alloca... yes
10613: checking for strerror... yes
10614: updating cache ./config.cache
10615: creating ./config.status
10616: creating Makefile
10617: ===> Building for bison-1.25
10618: 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
10619: 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
10620: 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
10621: 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
10622: 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
10623: 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
10624: 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
10625: 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
10626: 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
10627: 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
10628: 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
10629: 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
10630: 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
10631: 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
10632: 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
10633: 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
10634: 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
10635: 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
10636: 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
10637: 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
10638: 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
10639: 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
10640: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10641: rm -f bison.s1
10642: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10643: <p>Everything seems OK, so install the files:</p>
10644: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10645: >> Checksum OK for bison-1.25.tar.gz.
10646: ===> Installing for bison-1.25
10647: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10648: rm -f /usr/pkg/bin/bison
10649: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10650: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10651: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10652: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10653: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10654: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10655: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10656: ===> Registering installation for bison-1.25</pre>
10657: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 10658: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 10659: binary package, do this now:</p>
10660: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10661: >> Checksum OK for bison-1.25.tar.gz.
10662: ===> Building package for bison-1.25
10663: Creating package bison-1.25.tgz
10664: Registering depends:.
10665: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10666: <p>Now that you don't need the source and object files
10667: any more, clean up:</p>
10668: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10669: ===> Cleaning for bison-1.25</pre>
10670: </div>
10671: </div>
10672: <div class="appendix" lang="en">
10673: <div class="titlepage"><div><div><h2 class="title">
10674: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10675: <div class="toc">
10676: <p><b>Table of Contents</b></p>
10677: <dl>
10678: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10679: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10680: </dl>
10681: </div>
10682: <div class="sect1" lang="en">
10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10684: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10685: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10686: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10687: => figlet221.tar.gz doesn't seem to exist on this system.
10688: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10689: => [172219 bytes]
10690: Connected to ftp.plig.net.
10691: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10692: 331 Guest login ok, send your complete e-mail address as password.
10693: 230-You are user #5 of 500 simultaneous users allowed.
10694: 230-
10695: 230- ___ _ _ _
10696: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10697: 230- | _| _| . |_| . | | | . |_| . | _| . |
10698: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10699: 230- |_| |_| |___| |___|
10700: 230-
10701: 230-** Welcome to ftp.plig.org **
10702: 230-
10703: 230-Please note that all transfers from this FTP site are logged. If you
10704: 230-do not like this, please disconnect now.
10705: 230-
10706: 230-This arhive is available via
10707: 230-
10708: 230-HTTP: http://ftp.plig.org/
10709: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10710: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10711: 230-
10712: 230-Please email comments, bug reports and requests for packages to be
10713: 230-mirrored to ftp-admin@plig.org.
10714: 230-
10715: 230-
10716: 230 Logged in anonymously.
10717: Remote system type is UNIX.
10718: Using binary mode to transfer files.
10719: 200 Type okay.
10720: 250 "/pub" is new cwd.
10721: 250-"/pub/figlet" is new cwd.
10722: 250-
10723: 250-Welcome to the figlet archive at ftp.figlet.org
10724: 250-
10725: 250- ftp://ftp.figlet.org/pub/figlet/
10726: 250-
10727: 250-The official FIGlet web page is:
10728: 250- http://www.figlet.org/
10729: 250-
10730: 250-If you have questions, please mailto:info@figlet.org. If you want to
10731: 250-contribute a font or something else, you can email us.
10732: 250
10733: 250 "/pub/figlet/program" is new cwd.
10734: 250 "/pub/figlet/program/unix" is new cwd.
10735: local: figlet221.tar.gz remote: figlet221.tar.gz
10736: 502 Unimplemented command.
10737: 227 Entering Passive Mode (195,40,6,41,246,104)
10738: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10739: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10740: 226 Transfer completed.
10741: 172219 bytes received in 00:02 (75.99 KB/s)
10742: 221 Goodbye.
10743: => Checksum OK for figlet221.tar.gz.
10744: ===> Extracting for figlet-2.2.1nb2
10745: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10746: ===> Patching for figlet-2.2.1nb2
10747: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10748: ===> Overriding tools for figlet-2.2.1nb2
10749: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10750: ===> Configuring for figlet-2.2.1nb2
10751: ===> Building for figlet-2.2.1nb2
10752: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10753: chmod a+x figlet
10754: gcc -O2 -o chkfont chkfont.c
10755: => Unwrapping files-to-be-installed.
10756: <code class="prompt">#</code>
10757: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10758: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10759: ===> Installing for figlet-2.2.1nb2
10760: install -d -o root -g wheel -m 755 /usr/pkg/bin
10761: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10762: mkdir -p /usr/pkg/share/figlet
10763: cp figlet /usr/pkg/bin
10764: cp chkfont /usr/pkg/bin
10765: chmod 555 figlist showfigfonts
10766: cp figlist /usr/pkg/bin
10767: cp showfigfonts /usr/pkg/bin
10768: cp fonts/*.flf /usr/pkg/share/figlet
10769: cp fonts/*.flc /usr/pkg/share/figlet
10770: cp figlet.6 /usr/pkg/man/man6
10771: ===> Registering installation for figlet-2.2.1nb2
10772: <code class="prompt">#</code></pre>
10773: </div>
10774: <div class="sect1" lang="en">
10775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10776: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10777: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10778: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10779: ===> Packaging figlet-2.2.1nb2
10780: ===> Building binary package for figlet-2.2.1nb2
10781: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10782: Using SrcDir value of /usr/pkg
10783: Registering depends:.
10784: <code class="prompt">#</code></pre>
10785: </div>
10786: </div>
10787: <div class="appendix" lang="en">
10788: <div class="titlepage"><div><div><h2 class="title">
10789: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10790: <div class="toc">
10791: <p><b>Table of Contents</b></p>
10792: <dl>
10793: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10794: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10795: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10796: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3 rillig 10797: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.8 rillig 10798: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10799: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.1 dsieger 10800: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10801: source packages</a></span></dt>
10802: </dl>
10803: </div>
10804: <p>As in other big projects, the directory layout of pkgsrc
10805: is quite complex for newbies. This chapter explains where you
10806: find things on the FTP server. The base directory on
1.10 hubertf 10807: <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 10808: On other servers it may be different, but inside this directory,
10809: everything should look the same, no matter on which server you
10810: are. This directory contains some subdirectories, which are
10811: explained below.</p>
10812: <div class="sect1" lang="en">
10813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10814: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.9 rillig 10815: <p>This directory used to contain binary packages of the
10816: package management tools for various platforms. For those
10817: package collections that need them, they are now stored near the
1.10 hubertf 10818: binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.9 rillig 10819: directory</a>.</p>
1.1 dsieger 10820: </div>
10821: <div class="sect1" lang="en">
10822: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10823: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10824: <p>The directory <code class="filename">distfiles</code> contains lots
10825: of archive files from all pkgsrc packages, which are mirrored
10826: here. The subdirectories are called after their package names
10827: and are used when the distributed files have names that don't
10828: explicitly contain a version number or are otherwise too generic
10829: (for example <code class="filename">release.tar.gz</code>).</p>
10830: </div>
10831: <div class="sect1" lang="en">
10832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10833: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10834: <p>This directory is currently not in use.</p>
10835: </div>
10836: <div class="sect1" lang="en">
10837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10838: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10839: <p>This directory contains things that individual pkgsrc
10840: developers find worth publishing.</p>
10841: </div>
10842: <div class="sect1" lang="en">
10843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3 rillig 10844: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10845: <p>This directory contains binary packages for the various
10846: platforms that are supported by pkgsrc.
10847: 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>
10848: <div class="itemizedlist"><ul type="disc">
1.8 rillig 10849: <li><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 10850: operating system for which the packages have been built. The
1.10 hubertf 10851: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 10852: command, so it may differ from the one you are used to
10853: hear.</p></li>
1.8 rillig 10854: <li><p><code class="varname">ARCH</code> is the hardware
10855: architecture of the platform for which the packages have been
1.10 hubertf 10856: built. It also includes the <code class="varname">ABI</code> (Application
10857: Binary Interface) for platforms that have several of
10858: them.</p></li>
1.8 rillig 10859: <li><p><code class="varname">OSVERSION</code> is the version of
10860: the operating system. For version numbers that change often (for
10861: example NetBSD-current), the often-changing part should be
10862: replaced with an <code class="literal">x</code>, for example
10863: <code class="literal">4.99.x</code>.</p></li>
10864: <li><p><code class="varname">TAG</code> is either
10865: <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
10866: for a stable branch, or <code class="literal">head</code> for packages
10867: built from the HEAD branch. The latter should only be used when
10868: the packages are updated on a regular basis. Otherwise the date
10869: from checking out pkgsrc should be appended, for example
10870: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 10871: </ul></div>
10872: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10873: can quickly click through the directories on the
10874: server and find the best binary packages for their machines. Since they
10875: usually know the operating system and the hardware architecture, OPSYS
10876: and ARCH are placed first. After these choices, they can select the
10877: best combination of OSVERSION and TAG together, since it is usually the
10878: case that packages stay compatible between different version of the
10879: operating system.</p>
10880: <p>In each of these directories, there is a
10881: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 10882: <code class="filename">All</code> which contains all binary packages.
10883: Besides that, there are various category directories that
10884: contain symbolic links to the real binary packages.</p>
10885: </div>
10886: <div class="sect1" lang="en">
10887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.8 rillig 10888: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
10889: <p>Here are the reports from bulk builds, for those who want
10890: to fix packages that didn't build on some of the platforms. The
1.10 hubertf 10891: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 10892: </div>
10893: <div class="sect1" lang="en">
10894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10895: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.1 dsieger 10896: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10897: source packages</h2></div></div></div>
10898: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10899: that is the files that define how to create binary packages from
10900: source archives.</p>
10901: <p>The directory <code class="filename">pkgsrc</code> contains a
10902: snapshot of the CVS repository, which is updated regularly. The
10903: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10904: directory, ready to be downloaded as a whole.</p>
10905: <p>In the directories for the quarterly branches, there is an
10906: additional file called
10907: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10908: which contains the state of pkgsrc when it was branched.</p>
10909: </div>
10910: </div>
10911: <div class="appendix" lang="en">
10912: <div class="titlepage"><div><div><h2 class="title">
10913: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10914: <div class="toc">
10915: <p><b>Table of Contents</b></p>
10916: <dl>
10917: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
10918: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10919: </dl>
10920: </div>
10921: <p>This section contains information on editing the pkgsrc
10922: guide itself.</p>
10923: <div class="sect1" lang="en">
10924: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10925: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10926: <p>The pkgsrc guide's source code is stored in
10927: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10928: are created from it:</p>
10929: <div class="itemizedlist"><ul type="disc">
10930: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10931: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.10 hubertf 10932: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
10933: <li><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 10934: The PDF version of the pkgsrc guide.</p></li>
1.10 hubertf 10935: <li><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 10936: PostScript version of the pkgsrc guide.</p></li>
10937: </ul></div>
10938: </div>
10939: <div class="sect1" lang="en">
10940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10941: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
10942: <p>The procedure to edit the pkgsrc guide is:</p>
10943: <div class="procedure"><ol type="1">
10944: <li><p>Make sure you have the packages needed to
10945: regenerate the pkgsrc guide (and other XML-based NetBSD
10946: 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
10947: 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
10948: PostScript and PDF versions. You will need both packages
10949: installed, to make sure documentation is consistent across all
10950: formats.</p></li>
1.10 hubertf 10951: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 10952: right directory. All further steps will take place
10953: here.</p></li>
10954: <li><p>Edit the XML file(s) in
10955: <code class="filename">files/</code>.</p></li>
1.10 hubertf 10956: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 10957: guide for valid XML and to build the final output files. If you
10958: get any errors at this stage, you can just edit the files, as
10959: there are only symbolic links in the working directory, pointing
10960: to the files in <code class="filename">files/</code>.</p></li>
1.10 hubertf 10961: <li><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 10962: commit)</strong></span></p></li>
1.10 hubertf 10963: <li><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 10964: regenerate the output files with the proper RCS
10965: Ids.</p></li>
10966: <li>
1.10 hubertf 10967: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 10968: commit the files in both <code class="filename">pkgsrc/doc</code> and
10969: <code class="filename">htdocs</code>.</p>
10970: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10971: <h3 class="title">Note</h3>
10972: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 10973: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10974: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 10975: directory.</p>
10976: </div>
10977: </li>
10978: </ol></div>
10979: </div>
10980: </div>
10981: </div></body>
10982: </html>
CVSweb <webmaster@jp.NetBSD.org>