Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.8
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>
21: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
27: <div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
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.4 rillig 116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
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>
166: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
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>
231: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
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>
445: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
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>
478: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
479: </dt>
1.6 rillig 480: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 481: </dt>
1.6 rillig 482: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 483: </dt>
484: </dl>
485: </div>
486: <div class="chapter" lang="en">
487: <div class="titlepage"><div><div><h2 class="title">
488: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
489: <div class="toc">
490: <p><b>Table of Contents</b></p>
491: <dl>
492: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
493: <dd><dl>
494: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
495: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
496: </dl></dd>
497: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
498: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
499: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
500: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
501: </dl>
502: </div>
503: <div class="sect1" lang="en">
504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
505: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
506: <p>There is a lot of software freely available for Unix-based
507: systems, which is usually available in form of the source code. Before
508: such software can be used, it needs to be configured to the local
509: system, compiled and installed, and this is exactly what The NetBSD
510: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
511: to handle binary packages, so that not every user has to build the
512: packages for himself, which is a time-costly task.</p>
513: <p>pkgsrc currently contains several thousand packages,
514: including:</p>
515: <div class="itemizedlist"><ul type="disc">
516: <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
517: web server</p></li>
518: <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
519: web browser</p></li>
520: <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
521: Desktop Environment</p></li>
522: <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
523: Desktop Environment</p></li>
524: </ul></div>
525: <p>...just to name a few.</p>
526: <p>pkgsrc has built-in support for handling varying dependencies,
527: such as pthreads and X11, and extended features such as IPv6 support on
528: a range of platforms.</p>
529: <div class="sect2" lang="en">
530: <div class="titlepage"><div><div><h3 class="title">
531: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
532: <p>
533: pkgsrc provides the following key features:
534: </p>
535: <div class="itemizedlist"><ul type="disc">
536: <li><p>Easy building of software from source as well as the creation
537: and installation of binary packages. The source and latest
538: patches are retrieved from a master or mirror download site, checksum
539: verified, then built on your system. Support for binary-only
540: distributions is available for both native platforms and NetBSD
541: emulated platforms.</p></li>
542: <li><p>All packages are installed in a consistent directory tree,
543: including binaries, libraries, man pages and other
544: documentation.</p></li>
545: <li><p>Package dependencies, including when performing package updates,
546: are handled automatically. The configuration files of various
547: packages are handled automatically during updates, so local changes
548: are preserved.</p></li>
549: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
550: consists of highly portable code. This allows the greatest speed of
551: development when porting to new a platform. This portability also
552: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
553: platforms</em></span>.</p></li>
554: <li><p>The installation prefix, acceptable software licenses,
555: international encryption requirements and build-time options for a
556: large number of packages are all set in a simple, central
557: configuration file.</p></li>
558: <li><p>The entire source (not including the distribution files) is
559: freely available under a BSD license, so you may extend and adapt
560: pkgsrc to your needs. Support for local packages and patches is
561: available right out of the box, so you can configure it specifically
562: for your environment.</p></li>
563: </ul></div>
564: <p>The following principles are basic to pkgsrc:</p>
565: <div class="itemizedlist"><ul type="disc">
566: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.6 rillig 567: — That means, if a package contains bugs, it's better to find
1.1 dsieger 568: them and to complain about them rather than to just install the package
569: and hope that it works. There are numerous checks in pkgsrc that try to
570: 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
571: of shell scripts), and post-installation checks (installed files,
572: references to shared libraries, script interpreters).</p></li>
573: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.6 rillig 574: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 575: pkgsrc has been ported to many operating systems. Care is taken that
576: packages behave the same on all platforms.</p></li>
577: </ul></div>
578: </div>
579: <div class="sect2" lang="en">
580: <div class="titlepage"><div><div><h3 class="title">
581: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
582: <p>pkgsrc consists of both a source distribution and a binary
583: distribution for these operating systems. After retrieving the required
584: source or binaries, you can be up and running with pkgsrc in just
585: minutes!</p>
586: <p>pkgsrc was derived from FreeBSD's ports system, and
587: initially developed for NetBSD only. Since then, pkgsrc has
588: grown a lot, and now supports the following platforms:</p>
589: <div class="table">
590: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
591: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
592: <colgroup>
593: <col>
594: <col>
595: </colgroup>
596: <thead><tr>
597: <th>Platform</th>
598: <th>Date Support Added</th>
599: </tr></thead>
600: <tbody>
601: <tr>
602: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
603: <td align="center">Aug 1997</td>
604: </tr>
605: <tr>
606: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
607: <td align="center">Mar 1999</td>
608: </tr>
609: <tr>
610: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
611: <td align="center">Jun 1999</td>
612: </tr>
613: <tr>
614: <td>
615: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
616: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
617: </td>
618: <td align="center">Oct 2001</td>
619: </tr>
620: <tr>
621: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
622: <td align="center">Nov 2002</td>
623: </tr>
624: <tr>
625: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
626: <td align="center">Nov 2002</td>
627: </tr>
628: <tr>
629: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
630: <td align="center">Dec 2002</td>
631: </tr>
632: <tr>
633: <td>BSD/OS</td>
634: <td align="center">Dec 2003</td>
635: </tr>
636: <tr>
637: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
638: <td align="center">Dec 2003</td>
639: </tr>
640: <tr>
641: <td>
642: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
643: (Microsoft Windows Services for Unix)
644: </td>
645: <td align="center">Mar 2004</td>
646: </tr>
647: <tr>
648: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
649: <td align="center">Oct 2004</td>
650: </tr>
651: <tr>
652: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
653: <td align="center">Nov 2004</td>
654: </tr>
655: <tr>
656: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
657: <td align="center">Apr 2007</td>
658: </tr>
659: </tbody>
660: </table></div>
661: </div>
662: <br class="table-break">
663: </div>
664: </div>
665: <div class="sect1" lang="en">
666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
667: <a name="overview"></a>1.2. Overview</h2></div></div></div>
668: <p>This document is divided into three parts. The first,
669: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
670: describes how one can use one of the packages in the Package
671: Collection, either by installing a precompiled binary package,
672: or by building one's own copy using the NetBSD package system.
673: The second part, <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
674: package so it can be easily built by other NetBSD users without
675: knowing about the package's building details. The third part,
676: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
677: is intended for those who want to understand how pkgsrc is
678: implemented.</p>
679: <p>This document is available in various formats:
680: <span class="simplelist"><a href="index.html" target="_top">HTML</a>, <a href="pkgsrc.pdf" target="_top">PDF</a>, <a href="pkgsrc.ps" target="_top">PS</a>, <a href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
681: </div>
682: <div class="sect1" lang="en">
683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
684: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
685: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
686: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
687: terminology used within this document.</p>
688: <div class="variablelist"><dl>
689: <dt><span class="term">Package</span></dt>
690: <dd><p>A set of files and building instructions
691: that describe what's necessary
692: to build a certain piece of software using
693: pkgsrc. Packages are traditionally stored under
694: <code class="filename">/usr/pkgsrc</code>.</p></dd>
695: <dt><span class="term">The NetBSD package system</span></dt>
696: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
697: is part of the NetBSD operating system and can be bootstrapped
698: to run on non-NetBSD operating systems as well. It handles
699: building (compiling), installing, and removing of
700: packages.</p></dd>
701: <dt><span class="term">Distfile</span></dt>
702: <dd><p>This term describes the file or files that are
703: provided by the author of the piece of software to
704: distribute his work. All the changes necessary to build on
705: NetBSD are reflected in the corresponding package. Usually
706: the distfile is in the form of a compressed tar-archive,
707: but other types are possible, too. Distfiles are usually
708: stored below
709: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
710: <dt><span class="term">Port</span></dt>
711: <dd><p>This is the term used by FreeBSD and OpenBSD people
712: for what we call a package.
713: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
714: architecture.</p></dd>
715: <dt><span class="term">Precompiled/binary package</span></dt>
716: <dd>
717: <p>A set of binaries built with pkgsrc from a distfile
718: and stuffed together in a single <code class="filename">.tgz</code>
719: file so it can be installed on machines of the same
720: machine architecture without the need to
721: recompile. Packages are usually generated in
722: <code class="filename">/usr/pkgsrc/packages</code>; there is also
723: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
724: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
725: especially in the context of precompiled packages.</p>
726: </dd>
727: <dt><span class="term">Program</span></dt>
728: <dd><p>The piece of software to be installed which will be
729: constructed from all the files in the distfile by the
730: actions defined in the corresponding package.</p></dd>
731: </dl></div>
732: <div class="sect2" lang="en">
733: <div class="titlepage"><div><div><h3 class="title">
734: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
735: <div class="variablelist"><dl>
736: <dt><span class="term">pkgsrc users</span></dt>
737: <dd>
738: <p>The
739: pkgsrc users are people who use the packages provided by pkgsrc.
740: Typically they are system administrators. The people using the
741: software that is inside the packages (maybe called “<span class="quote">end
742: users</span>”) are not covered by the pkgsrc guide.</p>
743: <p>There are two kinds of pkgsrc users: Some only want to
744: install pre-built binary packages. Others build the pkgsrc
745: packages from source, either for installing them directly or for
746: building binary packages themselves. For pkgsrc users <a href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
747: documentation.</p>
748: </dd>
749: <dt><span class="term">package maintainers</span></dt>
750: <dd><p>A
751: package maintainer creates packages as described in <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
752: <dt><span class="term">infrastructure developers</span></dt>
753: <dd><p>These people are involved in all those files
754: that live in the <code class="filename">mk/</code> directory and below.
755: Only these people should need to read through <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
756: too.</p></dd>
757: </dl></div>
758: </div>
759: </div>
760: <div class="sect1" lang="en">
761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
762: <a name="typography"></a>1.4. Typography</h2></div></div></div>
763: <p>When giving examples for commands, shell prompts are used to
764: show if the command should/can be issued as root, or if
765: “<span class="quote">normal</span>” user privileges are sufficient. We use a
766: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
767: shell prompt, assuming they use the C-shell or tcsh.</p>
768: </div>
769: </div>
770: <div class="part" lang="en">
771: <div class="titlepage"><div><div><h1 class="title">
772: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
773: <div class="toc">
774: <p><b>Table of Contents</b></p>
775: <dl>
776: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
777: <dd><dl>
778: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
779: <dd><dl>
780: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
781: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
782: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
783: </dl></dd>
784: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
785: <dd><dl>
786: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
787: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
788: </dl></dd>
789: </dl></dd>
790: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
791: <dd><dl>
792: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
793: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
794: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
795: <dd><dl>
796: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
797: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
798: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
799: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
800: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
801: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
802: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
803: </dl></dd>
804: </dl></dd>
805: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
806: <dd><dl>
807: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
808: <dd><dl>
809: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
810: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
811: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
812: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
813: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
814: <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>
815: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
816: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
817: </dl></dd>
818: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
819: <dd><dl>
820: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
821: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
822: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
823: </dl></dd>
824: </dl></dd>
825: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
826: <dd><dl>
827: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
828: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.4 rillig 829: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
830: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 831: <dd><dl>
1.4 rillig 832: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
833: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
834: <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 835: </dl></dd>
1.4 rillig 836: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
837: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 838: </dl></dd>
839: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
840: <dd><dl>
841: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
842: <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 843: </dl></dd>
844: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
845: builds)</a></span></dt>
1.1 dsieger 846: <dd><dl>
1.6 rillig 847: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
848: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
849: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
850: <dd><dl>
851: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
852: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
853: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
854: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
855: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
856: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
857: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
858: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
859: </dl></dd>
860: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
861: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
862: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
863: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
864: </dl></dd>
865: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
866: <dd><dl>
867: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
868: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
869: </dl></dd>
870: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
871: <dd><dl>
872: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
873: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
874: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
875: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
876: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
877: <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>
878: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
879: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
880: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
881: <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 882: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 883: <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>
884: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
885: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
886: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
887: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
888: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
889: <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 890: </dl></dd>
891: </dl>
892: </div>
893: <div class="chapter" lang="en">
894: <div class="titlepage"><div><div><h2 class="title">
895: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
896: <div class="toc">
897: <p><b>Table of Contents</b></p>
898: <dl>
899: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
900: <dd><dl>
901: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
902: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
903: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
904: </dl></dd>
905: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
906: <dd><dl>
907: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
908: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
909: </dl></dd>
910: </dl>
911: </div>
912: <p>Before you download and extract the files, you need to decide
913: where you want to extract them. When using pkgsrc as root user, pkgsrc
914: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
915: free to install the sources and binary packages wherever you want in
916: your filesystem, provided that the pathname does not contain white-space
917: or other characters that are interpreted specially by the shell and some
918: other programs. A safe bet is to use only letters, digits, underscores
919: and dashes.</p>
920: <div class="sect1" lang="en">
921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
922: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
923: <p>Before you download any pkgsrc files, you should decide
924: whether you want the <span class="emphasis"><em>current</em></span> branch or the
925: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
926: quarterly basis from the current branch and only gets modified
927: for security updates. The names of the stable branches are built
928: from the year and the quarter, for example
929: <code class="literal">2007Q1</code>.</p>
930: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
931: want to download pkgsrc. You can get it as a tar file, via SUP,
932: or via CVS. All three ways are described here.</p>
933: <div class="sect2" lang="en">
934: <div class="titlepage"><div><div><h3 class="title">
935: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
936: <p>The primary download location for all pkgsrc files is
937: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
938: number of subdirectories for different purposes, which are
939: described in detail in <a 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>
940: <p>The tar file for the current branch is in the directory
941: <code class="filename">current</code> and is called <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
942: It is autogenerated daily.</p>
943: <p>The tar file for the stable branch 2007Q1 is in the
944: directory <code class="filename">pkgsrc-2007Q1</code> and is also called <a 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>
945: <p>After downloading the tar file, change to the directory
946: where you want to have pkgsrc. This is usually
947: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
948: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
949: </div>
950: <div class="sect2" lang="en">
951: <div class="titlepage"><div><div><h3 class="title">
952: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
953: <p>As an alternative to the tar file, you can get pkgsrc via
954: the Software Update Protocol, SUP. To do so, make sure your
955: supfile has a line
956:
957: </p>
958: <pre class="programlisting">
959: release=pkgsrc
960: </pre>
961: <p>
962:
963: in it, see the examples in
964: <code class="filename">/usr/share/examples/supfiles</code>, and that the
965: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
966: run <span><strong class="command">sup -v
967: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
968: </div>
969: <div class="sect2" lang="en">
970: <div class="titlepage"><div><div><h3 class="title">
971: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
972: <p>To get pkgsrc via CVS, make sure you have <a href="http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cvs</span>(1)</span></a>
973: installed. To do an initial (full) checkout of pkgsrc, you first
974: have to set some environment variables. For the C-Shell,
975: type:</p>
976: <pre class="screen">
977: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
978: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
979: </pre>
980: <p>Or, the same for the bourne shell:</p>
981: <pre class="screen">
982: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
983: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
984: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
985: </pre>
1.2 rillig 986: <p>By default, cvs doesn't do things like most people would
987: expect it to do, and this is unlikely to change. But there is a
988: way to convince cvs, by creating a file called
989: <code class="filename">.cvsrc</code> in your home directory and saving
990: the following lines to it. This file will save you lots of
991: headache and some bug reports, so we strongly recommend it. You
992: can find an explanation of this file in the CVS
993: documentation.</p>
994: <pre class="programlisting">
995: # recommended CVS configuration file from the pkgsrc guide
996: checkout -P
1.4 rillig 997: update -dP
1.2 rillig 998: release -d
1.4 rillig 999: diff -upN
1.2 rillig 1000: cvs -q -z3
1001: rdiff -u
1002: </pre>
1.1 dsieger 1003: <p>Then, you change to the directory where you want to have
1004: your copy of pkgsrc. In most cases this is
1005: <code class="filename">/usr</code>. In that directory you run the
1006: checkout command, which is <span><strong class="command">cvs -q checkout -P
1007: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1008: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1009: branch. This command will create a directory called
1010: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1011: it.</p>
1012: </div>
1013: </div>
1014: <div class="sect1" lang="en">
1015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1016: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1017: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1018: (which also works if you have first installed it via a tar
1019: file). It saves bandwidth and hard disk activity, compared to
1020: downloading the tar file again.</p>
1021: <div class="sect2" lang="en">
1022: <div class="titlepage"><div><div><h3 class="title">
1023: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1024: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1025: <h3 class="title">Warning</h3>
1026: <p>When updating from a tar file, you first need to
1027: completely remove the old pkgsrc directory. Otherwise those
1028: files that have been removed from pkgsrc in the mean time will
1029: not be removed on your local disk, resulting in inconsistencies.
1030: When removing the old files, any changes that you have done to
1031: the pkgsrc files will be lost after updating. Therefore updating
1032: via CVS is strongly recommended.</p>
1033: </div>
1034: <p>Note that by default the distfiles and the binary packages
1035: are saved in the pkgsrc tree, so don't forget to rescue them
1036: before updating. You can also configure pkgsrc to use other than
1037: the default directories by setting the
1038: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1039: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1040: <p>To update pkgsrc from a tar file, download the tar file as
1041: explained above. Then, make sure that you have not made any
1042: changes to the files in the pkgsrc directory. Remove the pkgsrc
1043: directory and extract the new tar file. Done.</p>
1044: </div>
1045: <div class="sect2" lang="en">
1046: <div class="titlepage"><div><div><h3 class="title">
1047: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1048: <p>To update pkgsrc via CVS, make sure the environment
1049: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1050: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1051: -dP</strong></span>.</p>
1052: <div class="sect3" lang="en">
1053: <div class="titlepage"><div><div><h4 class="title">
1054: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1055: <p>When updating pkgsrc, the CVS program keeps track of the
1056: branch you selected. But if you, for whatever reason, want to
1057: switch from the stable branch to the current one, you can do it
1058: by adding the option “<span class="quote">-A</span>” after the
1059: “<span class="quote">update</span>” keyword. To switch from the current branch
1060: back to the stable branch, add the
1061: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1062: </div>
1063: <div class="sect3" lang="en">
1064: <div class="titlepage"><div><div><h4 class="title">
1065: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1066: <p>When you update pkgsrc, the CVS program will only touch
1067: those files that are registered in the CVS repository. That
1068: means that any packages that you created on your own will stay
1069: unmodified. If you change files that are managed by CVS, later
1070: updates will try to merge your changes with those that have been
1071: done by others. See the CVS manual, chapter
1072: “<span class="quote">update</span>” for details.</p>
1073: </div>
1074: </div>
1075: </div>
1076: </div>
1077: <div class="chapter" lang="en">
1078: <div class="titlepage"><div><div><h2 class="title">
1079: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1080: <div class="toc">
1081: <p><b>Table of Contents</b></p>
1082: <dl>
1083: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1084: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1085: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1086: <dd><dl>
1087: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1088: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1089: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1090: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1091: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1092: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1093: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1094: </dl></dd>
1095: </dl>
1096: </div>
1097: <div class="sect1" lang="en">
1098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1099: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1100: <p>
1101: We provide a bootstrap kit in both source and binary form for other
1102: platforms than NetBSD, consisting of the pkg administration tools and other
1103: tools required to use pkgsrc and build packages.
1104: </p>
1105: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1106: <h3 class="title">Note</h3>
1107: <p>
1108: Older binary snapshots are available in the
1109: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1110: directory on ftp.NetBSD.org.</p>
1111: </div>
1112: <div class="table">
1113: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1114: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1115: <colgroup>
1116: <col>
1117: <col>
1118: <col>
1119: <col>
1120: </colgroup>
1121: <thead><tr>
1122: <th>Platform</th>
1123: <th>Latest snapshot</th>
1124: <th>Binary kit</th>
1125: <th>Binary packages</th>
1126: </tr></thead>
1127: <tbody>
1128: <tr>
1129: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1130: <td class="date">20021209</td>
1131: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-5.5-powerpc-20021209.tar.gz" target="_top">binary kit</a></td>
1132: <td class="binary-pkgs-url"> </td>
1133: </tr>
1134: <tr>
1135: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1136: <td class="date">20030623</td>
1137: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-6.6-powerpc-20030623.tar.gz" target="_top">binary kit</a></td>
1138: <td class="binary-pkgs-url"> </td>
1139: </tr>
1140: <tr>
1141: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1142: <td class="date">20041219</td>
1143: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.6.0-powerpc-20041219.tar.gz" target="_top">binary kit</a></td>
1144: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1145: </tr>
1146: <tr>
1147: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1148: <td class="date">20050320</td>
1149: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-7.8.0-powerpc-20050320.tar.gz" target="_top">binary kit</a></td>
1150: <td class="binary-pkgs-url"> </td>
1151: </tr>
1152: <tr>
1153: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1154: <td class="date">20050625</td>
1155: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Darwin-8.1.0-powerpc-20050625.tar.gz" target="_top">binary kit</a></td>
1156: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-8.1/powerpc/current/" target="_top">binary packages</a></td>
1157: </tr>
1158: <tr>
1159: <td class="osname">Debian GNU Linux/i386</td>
1160: <td class="date">20031023</td>
1161: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-debian-i386-20031023.tar.gz" target="_top">binary kit</a></td>
1162: <td class="binary-pkgs-url"> </td>
1163: </tr>
1164: <tr>
1165: <td class="osname">Fedora Core 2 Linux/i386</td>
1166: <td class="date">20050618</td>
1167: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.10-i386-fc2-20050618.tar.gz" target="_top">binary kit</a></td>
1168: <td class="binary-pkgs-url"> </td>
1169: </tr>
1170: <tr>
1171: <td class="osname">Fedora Core 4 Linux/i386</td>
1172: <td class="date">20060105</td>
1173: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.6.11-i386-fc4-20060105.tar.gz" target="_top">binary kit</a></td>
1174: <td class="binary-pkgs-url"> </td>
1175: </tr>
1176: <tr>
1177: <td class="osname">FreeBSD 3.5/i386</td>
1178: <td class="date">20030411</td>
1179: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-3.5-STABLE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1180: <td class="binary-pkgs-url"> </td>
1181: </tr>
1182: <tr>
1183: <td class="osname">FreeBSD 4.7/i386</td>
1184: <td class="date">20021211</td>
1185: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-4.7-RELEASE-i386-20021211.tar.gz" target="_top">binary kit</a></td>
1186: <td class="binary-pkgs-url"> </td>
1187: </tr>
1188: <tr>
1189: <td class="osname">FreeBSD 5.0/i386</td>
1190: <td class="date">20030411</td>
1191: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.0-RELEASE-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1192: <td class="binary-pkgs-url"> </td>
1193: </tr>
1194: <tr>
1195: <td class="osname">FreeBSD 5.1/i386</td>
1196: <td class="date">20030630</td>
1197: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.1-RELEASE-i386-20030630.tar.gz" target="_top">binary kit</a></td>
1198: <td class="binary-pkgs-url"> </td>
1199: </tr>
1200: <tr>
1201: <td class="osname">FreeBSD 5.2.1/i386</td>
1202: <td class="date">20040227</td>
1203: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.2.1-RELEASE-i386-20040227.tar.gz" target="_top">binary kit</a></td>
1204: <td class="binary-pkgs-url"> </td>
1205: </tr>
1206: <tr>
1207: <td class="osname">FreeBSD 5.3/i386</td>
1208: <td class="date">20050119</td>
1209: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-FreeBSD-5.3-RELEASE-i386-20050119.tar" target="_top">binary kit</a></td>
1210: <td class="binary-pkgs-url"> </td>
1211: </tr>
1212: <tr>
1213: <td class="osname">HP-UX 11.11/hppa</td>
1214: <td class="date">20070421</td>
1215: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-HPUX-B.11.11-hppa-20070421.tar.gz" target="_top">binary kit</a></td>
1216: <td class="binary-pkgs-url"> </td>
1217: </tr>
1218: <tr>
1219: <td class="osname">Interix 3.5</td>
1220: <td class="date">20061106</td>
1221: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Interix-3.5-i386-20061106.tar.gz" target="_top">binary kit</a></td>
1222: <td class="binary-pkgs-url"> </td>
1223: </tr>
1224: <tr>
1225: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1226: <td class="date">20040911</td>
1227: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX-6.5-mips-20040911.tar.gz" target="_top">binary kit</a></td>
1228: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1229: </tr>
1230: <tr>
1231: <td class="osname">IRIX 6.5 64-bit ABI</td>
1232: <td class="date">20040912</td>
1233: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-IRIX64-6.5-mips-20040912.tar.gz" target="_top">binary kit</a></td>
1234: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1235: </tr>
1236: <tr>
1237: <td class="osname">OpenBSD 3.2/i386</td>
1238: <td class="date">20030420</td>
1239: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.2-i386-20030420.tar.gz" target="_top">binary kit</a></td>
1240: <td class="binary-pkgs-url"> </td>
1241: </tr>
1242: <tr>
1243: <td class="osname">OpenBSD 3.3/i386</td>
1244: <td class="date">20030503</td>
1245: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.3-i386-20030503.tar.gz" target="_top">binary kit</a></td>
1246: <td class="binary-pkgs-url"> </td>
1247: </tr>
1248: <tr>
1249: <td class="osname">OpenBSD 3.5/i386</td>
1250: <td class="date">20040703</td>
1251: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OpenBSD-3.5-i386-20040703.tar.gz" target="_top">binary kit</a></td>
1252: <td class="binary-pkgs-url"> </td>
1253: </tr>
1254: <tr>
1255: <td class="osname">OSF1 5.1/alpha</td>
1256: <td class="date">20070420</td>
1257: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-OSF1-V5.1-alpha-20070420.tar.gz" target="_top">binary kit</a></td>
1258: <td class="binary-pkgs-url"> </td>
1259: </tr>
1260: <tr>
1261: <td class="osname">Slackware Linux 8.1/i386</td>
1262: <td class="date">20030417</td>
1263: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.18-slackware-20030417.tar.gz" target="_top">binary kit</a></td>
1264: <td class="binary-pkgs-url"> </td>
1265: </tr>
1266: <tr>
1267: <td class="osname">Slackware Linux 9/i386</td>
1268: <td class="date">20040703</td>
1269: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-Linux-2.4.22-i386-slackware9-20040703.tar.gz" target="_top">binary kit</a></td>
1270: <td class="binary-pkgs-url"> </td>
1271: </tr>
1272: <tr>
1273: <td class="osname">Solaris 8/sparc</td>
1274: <td class="date">20050220</td>
1275: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-sparc-20050220.tar.gz" target="_top">binary kit</a></td>
1276: <td class="binary-pkgs-url"> </td>
1277: </tr>
1278: <tr>
1279: <td class="osname">Solaris 8/i386</td>
1280: <td class="date">20050220</td>
1281: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.8-i386-20050220.tar.gz" target="_top">binary kit</a></td>
1282: <td class="binary-pkgs-url"> </td>
1283: </tr>
1284: <tr>
1285: <td class="osname">Solaris 9/sparc</td>
1286: <td class="date">20060713</td>
1287: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-sparc-pkgsrc-2006Q2.tar.gz" target="_top">binary kit</a></td>
1288: <td class="binary-pkgs-url"> </td>
1289: </tr>
1290: <tr>
1291: <td class="osname">Solaris 9/i386</td>
1292: <td class="date">20030411</td>
1293: <td class="kit-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/bootstrap-pkgsrc-SunOS-5.9-i386-20030411.tar.gz" target="_top">binary kit</a></td>
1294: <td class="binary-pkgs-url"> </td>
1295: </tr>
1296: </tbody>
1297: </table></div>
1298: </div>
1299: <br class="table-break"><p>
1300: Simply download the binary kit for your platform, and extract it into
1301: <code class="filename">/</code> e.g.
1302: </p>
1303: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1304: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1305: | tar -xpf -</code></strong></pre>
1306: <p>
1307: Of course, as with any binary distributions, you should verify the
1308: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1309: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1310: file and inspect the contents before extracting it.
1311: </p>
1312: </div>
1313: <div class="sect1" lang="en">
1314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1315: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1316: <p>Installing the bootstrap kit from source should be as simple as:</p>
1317: <pre class="screen">
1318: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1319: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1320: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1321: </pre>
1322: <p>See <a 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
1323: pkgsrc before bootstrapping. The given
1324: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1325: <code class="filename">/usr/pkg</code> for the
1326: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1327: and <code class="filename">/var/db/pkg</code> for the package database
1328: directory where pkgsrc will do its internal bookkeeping.
1329: However, these can also be set using command-line
1330: arguments.</p>
1331: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1332: available for supported platforms. An up-to-date list of these can be
1333: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1334: Note that this only works for privileged builds that install
1335: into <code class="filename">/usr/pkg</code>.</p>
1336: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1337: <h3 class="title">Note</h3>
1338: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1339: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1340: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1341: instead of “<span class="quote">make</span>”.</p>
1342: </div>
1343: </div>
1344: <div class="sect1" lang="en">
1345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1346: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1347: <p>Here are some platform-specific notes you should be aware of.</p>
1348: <div class="sect2" lang="en">
1349: <div class="titlepage"><div><div><h3 class="title">
1350: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1351: <p>Darwin 5.x and up are supported. There are two methods of using
1352: pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1353: image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1354: partition</a>.</p>
1355: <p>Before you start, you will need to download and install the Mac OS X Developer
1356: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1357: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1358: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1359: if you intend to build packages that use the X11 Window System.</p>
1360: <p>If you already have a UFS or HFSX partition, or have a spare partition
1361: that you can format as UFS or HFSX, it is recommended to use that instead of
1362: the disk image. It'll be somewhat faster and will mount automatically
1363: at boot time, where you must manually mount a disk image.</p>
1364: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1365: <h3 class="title">Note</h3>
1366: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1367: 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>
1368: </div>
1369: <div class="sect3" lang="en">
1370: <div class="titlepage"><div><div><h4 class="title">
1371: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1372: <p>Create the disk image:</p>
1373: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1374: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1375: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1376: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1377: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1378: <h3 class="title">Note</h3>
1379: <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 journalling.</p>
1380: </div>
1381: <p>Allow suid:</p>
1382: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.5 weinem 1383: <p>Changing the build directory:</p>
1384: <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>
1385: <pre class="programlisting">
1386: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1387: </pre>
1.1 dsieger 1388: </div>
1389: <div class="sect3" lang="en">
1390: <div class="titlepage"><div><div><h4 class="title">
1391: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1392: <p>By default, <code class="filename">/usr</code> will be on your root file
1393: system, normally HFS+. It is possible to use the default
1394: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1395: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1396: or HFSX file system. Obviously, another symlink is required if you want to
1397: place the package database directory outside the
1398: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1399: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1400: <p>If you created your partitions at the time of installing Mac OS X
1401: and formatted the target partition as UFS or HFSX, it should automatically
1402: mount on <code class="filename">/Volumes/<volume name></code> when the
1403: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1404: to ensure that the partition map correctly reflects
1405: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1406: <p>The problem is that none of the disk tools will let you touch a
1407: disk that is booted from. You can unmount the partition, but even if
1408: you newfs it, the partition type will be incorrect and the
1409: automounter won't mount it. It can be mounted manually, but it won't
1410: appear in Finder.</p>
1411: <p>You'll need to boot off of the OS X Installation (User) CD. When
1412: the Installation program starts, go up to the menu and select Disk
1413: Utility. Now, you will be able to select the partition you want
1414: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1415: installer which will reboot your machine. The new UFS or HFSX file system
1416: will appear in Finder.</p>
1417: <p>Be aware that the permissions on the new file system will be writable
1418: by root only.</p>
1419: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1420: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1421: </div>
1422: </div>
1423: <div class="sect2" lang="en">
1424: <div class="titlepage"><div><div><h3 class="title">
1425: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1426: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1427: other versions may work.</p>
1428: <p>Care should be taken so that the tools that this kit installs do not conflict
1429: with the FreeBSD userland tools. There are several steps:</p>
1430: <div class="orderedlist"><ol type="1">
1431: <li><p>FreeBSD stores its ports pkg database in
1432: <code class="filename">/var/db/pkg</code>. It is therefore
1433: recommended that you choose a different location (e.g.
1434: <code class="filename">/usr/pkgdb</code>) by
1435: using the --pkgdbdir option to the bootstrap script.</p></li>
1436: <li>
1437: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1438: good idea to move them out of the way to avoid confusion, e.g.</p>
1439: <pre class="screen">
1440: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1441: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1442: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1443: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1444: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1445: </pre>
1446: </li>
1.4 rillig 1447: <li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1448: <code class="filename">/etc/mk.conf.example</code> file
1449: when you use the bootstrap script.</p></li>
1450: </ol></div>
1451: </div>
1452: <div class="sect2" lang="en">
1453: <div class="titlepage"><div><div><h3 class="title">
1454: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1455: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1456: providing a Unix-like environment with a tighter kernel integration than
1457: available with Cygwin. It is part of the Windows Services for Unix
1458: package, available for free for any licensed copy of Windows 2000, XP
1459: (not including XP Home), or 2003. SFU can be downloaded from <a href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1460: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1461: are not officially supported. (The main difference in 3.0/3.1 is lack
1462: of pthreads, but other parts of libc may also be lacking.)</p>
1463: <p>Services for Unix Applications (aka SUA) is an integrated component
1464: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1465: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1466: <div class="sect3" lang="en">
1467: <div class="titlepage"><div><div><h4 class="title">
1468: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1469: <p>At an absolute minimum, the following packages must be installed from
1470: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1471: <div class="itemizedlist"><ul type="disc">
1472: <li><p>Utilities -> Base Utilities</p></li>
1473: <li><p>Interix GNU Components -> (all)</p></li>
1474: <li><p>Remote Connectivity</p></li>
1475: <li><p>Interix SDK</p></li>
1476: </ul></div>
1477: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1478: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1479: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1480: pkgsrc (or from a binary package).</p>
1481: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1482: not need to be installed, but Remote Connectivity itself should be
1483: installed in order to have a working inetd.</p>
1484: <p>During installation you may be asked whether to enable setuid
1485: behavior for Interix programs, and whether to make pathnames default to
1486: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1487: enabled. (Without case-sensitivity, a large number of packages including
1488: perl will not build.)</p>
1489: <p>NOTE: Newer Windows service packs change the way binary execution
1490: works (via the Data Execution Prevention feature). In order to use
1491: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1492: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1493: must be installed. Hotfixes are available from Microsoft through a
1494: support contract; however, a NetBSD developer has made most Interix
1495: hotfixes available for personal use from <a href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1496: <p>In addition to the hotfix noted above, it may be necessary to
1497: disable Data Execution Prevention entirely to make Interix functional.
1498: This may happen only with certain types of CPUs; the cause is not fully
1499: understood at this time. If gcc or other applications still segfault
1500: repeatedly after installing one of the hotfixes note above, the
1501: following option can be added to the appropriate "boot.ini" line on the
1502: Windows boot drive: /NoExecute=AlwaysOff
1503: (WARNING, this will disable DEP completely, which may be a security
1504: risk if applications are often run as a user in the Administrators
1505: group!)</p>
1506: </div>
1507: <div class="sect3" lang="en">
1508: <div class="titlepage"><div><div><h4 class="title">
1509: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1510: <p>If SFU is already installed and you wish to alter these settings to work
1511: with pkgsrc, note the following things.</p>
1512: <div class="itemizedlist"><ul type="disc">
1513: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1514: Windows Services for UNIX, then click Change. In the installer, choose
1515: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1516: <li>
1517: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1518: change the following registry key:</p>
1519: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1520: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1521: </li>
1522: <li>
1523: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1524: following registry key:</p>
1525: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1526: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1527: </li>
1528: </ul></div>
1529: </div>
1530: <div class="sect3" lang="en">
1531: <div class="titlepage"><div><div><h4 class="title">
1532: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1533: <p>The package manager (either the pkgsrc "su" user, or the user
1534: running "pkg_add") must be a member of the local Administrators
1535: group. Such a user must also be used to run the bootstrap. This is
1536: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1537: <p>The package manager should use a umask of 002. "make install" will
1538: automatically complain if this is not the case. This ensures that
1539: directories written in /var/db/pkg are Administrators-group writeable.</p>
1540: <p>The popular Interix binary packages from http://www.interopsystems.com/
1541: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1542: NOT be used in conjunction with pkgsrc. If you choose to use them at
1543: the same time as the pkgsrc packages, ensure that you use the proper
1544: pkg_* tools for each type of binary package.</p>
1545: <p>The TERM setting used for DOS-type console windows (including those
1546: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1547: don't have a termcap/terminfo entry for it, but the following .termcap
1548: entry provides adequate emulation in most cases:</p>
1549: <pre class="programlisting">
1550: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1551: </pre>
1552: </div>
1553: <div class="sect3" lang="en">
1554: <div class="titlepage"><div><div><h4 class="title">
1555: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1556: <p>Though Interix suffices as a familiar and flexible substitute
1557: for a full Unix-like platform, it has some drawbacks that should
1558: be noted for those desiring to make the most of Interix.</p>
1559: <div class="itemizedlist"><ul type="disc">
1560: <li>
1561: <p><span class="strong"><strong>X11:</strong></span></p>
1562: <p>Interix comes with the standard set of X11R6 client libraries,
1563: and can run X11 based applications, but it does
1564: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1565: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1566: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1567: (available in a trimmed version for Interix from Interop Systems as the
1568: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1569: and the free X11 server included with
1570: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1571: </li>
1572: <li>
1573: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1574: <p>Because Interix runs in a completely different NT subsystem from
1575: Win32 applications, it does not currently support various X11
1576: protocol extensions for acceleration (such as MIT-SHM or DGA).
1577: Most interactive applications to a local X server will run
1578: reasonably fast, but full motion video and other graphics
1579: intensive applications may require a faster-than-expected CPU.</p>
1580: </li>
1581: <li>
1582: <p><span class="strong"><strong>Audio:</strong></span></p>
1583: <p>Interix has no native support for audio output. For audio
1584: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1585: audio system on Interix. Unlike on most platforms, the
1586: <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
1587: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1588: server component. To output audio via an Interix host, the
1589: <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
1590: must also be installed.</p>
1591: </li>
1592: <li>
1593: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1594: <p>Direct device access is not currently supported in Interix, so it
1595: is not currently possible to access CD/DVD drives, USB devices,
1596: or SCSI devices through non-filesystem means. Among other things,
1597: this makes it impossible to use Interix directly for CD/DVD
1598: burning.</p>
1599: </li>
1600: <li>
1601: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1602: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1603: drives are also not directly accessible in Interix. However,
1604: support is in work to make tape drive access possible by using
1605: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1606: esound server).</p>
1607: </li>
1608: </ul></div>
1609: </div>
1610: <div class="sect3" lang="en">
1611: <div class="titlepage"><div><div><h4 class="title">
1612: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1613: <p>It is not necessary, in general, to have a "root" user on the
1614: Windows system; any member of the local Administrators group will
1615: suffice. However, some packages currently assume that the user
1616: named "root" is the privileged user. To accommodate these, you
1617: may create such a user; make sure it is in the local group
1618: Administrators (or your language equivalent).</p>
1619: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1620: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1621: time being, install packages as the local Administrator (or
1622: your language equivalent), or run the following command after
1623: installing a package to work around the issue:</p>
1624: <pre class="screen">
1625: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1626: </pre>
1627: </div>
1628: </div>
1629: <div class="sect2" lang="en">
1630: <div class="titlepage"><div><div><h3 class="title">
1631: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1632: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1633: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1634: according to your preference. If you do not have a license for the MIPSpro
1635: compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1636: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1637: version of IRIX providing support for <a 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 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>,
1638: etc.</p>
1639: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1640: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1641: you start out using "abi=n32", that's what all your packages will be built
1642: with.</p>
1643: <p>Therefore, please make sure that you have no conflicting
1644: <code class="varname">CFLAGS</code> in your environment or the
1.4 rillig 1645: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1646: try to link n32 object files with lib64 or vice versa. Check your
1647: <code class="filename">/etc/compiler.defaults</code>!</p>
1648: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1649: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1650: as it appears that IRIX linker occasionally runs into issues when trying to
1651: link over a network-mounted file system.</p>
1652: <p>The bootstrapping process should set all the right options for programs such
1653: as imake(1), but you may want to set some options depending on your local
1654: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1655: course, your compiler's man pages for details.</p>
1656: <p>If you are using SGI's MIPSPro compiler, please set
1657:
1658: </p>
1659: <pre class="programlisting">
1660: PKGSRC_COMPILER= mipspro
1661: </pre>
1662: <p>
1663:
1.4 rillig 1664: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1665: are using gcc and may end up passing invalid flags to the compiler. Note that
1666: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1667: default.</p>
1668: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1669: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1670: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1671: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1672: '--preserve-path' flag.</p>
1673: </div>
1674: <div class="sect2" lang="en">
1675: <div class="titlepage"><div><div><h3 class="title">
1676: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1677: <p>Some versions of Linux (for example Debian GNU/Linux) need
1678: either libtermcap or libcurses (libncurses). Installing the
1679: distributions libncurses-dev package (or equivalent) should fix
1680: the problem.</p>
1681: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1682: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1683: i386 have been tested.</p>
1684: <p>To bootstrap using icc, assuming the default icc installation
1685: directory:</p>
1686: <pre class="programlisting">
1687: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1688: ac_cv___attribute__=yes ./bootstrap
1689: </pre>
1690: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1691: <h3 class="title">Note</h3>
1692: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1693: </div>
1694: <p>icc supports __attribute__, but the GNU configure test uses a nested
1695: function, which icc does not support. #undef'ing __attribute__ has the
1696: unfortunate side-effect of breaking many of the Linux header files, which
1697: cannot be compiled properly without __attribute__. The test must be
1698: overridden so that __attribute__ is assumed supported by the
1699: compiler.</p>
1700: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.4 rillig 1701: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1702: <pre class="programlisting">
1703: PKGSRC_COMPILER= icc
1704: </pre>
1705: <p>The default installation directory for icc is
1706: <code class="filename">/opt/intel_cc_80</code>, which
1707: is also the pkgsrc default. If you have installed it into a different
1708: directory, set <code class="varname">ICCBASE</code> in
1.4 rillig 1709: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1710: <pre class="programlisting">
1711: ICCBASE= /opt/icc
1712: </pre>
1713: <p>pkgsrc uses the static linking method of the runtime libraries
1714: provided by icc, so binaries can be run on other systems which do not
1715: have the shared libraries installed.</p>
1716: <p>Libtool, however, extracts a list of libraries from the
1717: <a 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
1718: records it, throwing away the -Bstatic and -Bdynamic options
1719: interspersed between the libraries. This means that
1720: libtool-linked C++ shared libraries will have a runtime
1721: dependency on the icc libraries until this is fixed in
1722: libtool.</p>
1723: </div>
1724: <div class="sect2" lang="en">
1725: <div class="titlepage"><div><div><h3 class="title">
1726: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1727: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1728: <p>Care should be taken so that the tools that this kit installs do not conflict
1729: with the OpenBSD userland tools. There are several steps:</p>
1730: <div class="orderedlist"><ol type="1">
1731: <li><p>OpenBSD stores its ports pkg database in
1732: <code class="filename">/var/db/pkg</code>. It is therefore
1733: recommended that you choose a different location (e.g.
1734: <code class="filename">/usr/pkgdb</code>) by
1735: using the --pkgdbdir option to the bootstrap script.</p></li>
1736: <li>
1737: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1738: good idea to move them out of the way to avoid confusion, e.g.</p>
1739: <pre class="screen">
1740: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1741: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1742: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1743: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1744: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1745: </pre>
1746: </li>
1747: <li>
1.4 rillig 1748: <p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1749: <code class="filename">/etc/mk.conf.example</code> file
1750: when you use the bootstrap script. OpenBSD's make program uses
1.4 rillig 1751: <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1752: as well. You can work around this by enclosing all the pkgsrc-specific parts
1753: of the file with:</p>
1754: <pre class="programlisting">
1755: .ifdef BSD_PKG_MK
1756: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1757: .else
1758: # OpenBSD stuff
1759: .endif
1760: </pre>
1761: </li>
1762: </ol></div>
1763: </div>
1764: <div class="sect2" lang="en">
1765: <div class="titlepage"><div><div><h3 class="title">
1766: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1767: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1768: You will need a working C compiler. Both gcc 2.95.3 and
1769: Sun WorkShop 5 have been tested.</p>
1770: <p>The following packages are required on Solaris 8 for the bootstrap
1771: process and to build packages.</p>
1772: <div class="itemizedlist"><ul type="disc">
1773: <li><p>SUNWsprot</p></li>
1774: <li><p>SUNWarc</p></li>
1775: <li><p>SUNWbtool</p></li>
1776: <li><p>SUNWtoo</p></li>
1777: <li><p>SUNWlibm</p></li>
1778: </ul></div>
1779: <p>Please note that the use of GNU binutils on Solaris is
1780: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1781: <p>Whichever compiler you use, please ensure the compiler tools and
1782: your $prefix are in your <code class="varname">PATH</code>. This includes
1783: <code class="filename">/usr/ccs/{bin,lib}</code>
1784: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1785: <div class="sect3" lang="en">
1786: <div class="titlepage"><div><div><h4 class="title">
1787: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1788: <p>It makes life much simpler if you only use the same gcc consistently
1789: for building all packages.</p>
1790: <p>It is recommended that an external gcc be used only for bootstrapping,
1791: then either build gcc from
1792: <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
1793: package, then remove gcc used during bootstrapping.</p>
1794: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1795: </div>
1796: <div class="sect3" lang="en">
1797: <div class="titlepage"><div><div><h4 class="title">
1798: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1799: <p>You will need at least the following packages installed (from WorkShop
1800: 5.0)</p>
1801: <div class="itemizedlist"><ul type="disc">
1802: <li><p>SPROcc
1803: - Sun WorkShop Compiler C 5.0</p></li>
1804: <li><p>SPROcpl
1805: - Sun WorkShop Compiler C++ 5.0</p></li>
1806: <li><p>SPROild
1807: - Sun WorkShop Incremental Linker</p></li>
1808: <li><p>SPROlang
1809: - Sun WorkShop Compilers common components</p></li>
1810: </ul></div>
1811: <p>You should set the following variables in your
1.4 rillig 1812: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1813: <pre class="programlisting">
1814: CC= cc
1815: CXX= CC
1816: CPP= cc -E
1817: CXXCPP= CC -E
1818: </pre>
1819: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1820: <h3 class="title">Note</h3>
1821: <p>The <code class="varname">CPP</code> setting might break some
1822: packages that use the C preprocessor for processing things other
1823: than C source code.</p>
1824: </div>
1825: </div>
1826: <div class="sect3" lang="en">
1827: <div class="titlepage"><div><div><h4 class="title">
1828: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1829: <p>To build 64-bit packages, you just need to have the
1.4 rillig 1830: following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1831: <pre class="programlisting">
1832: PKGSRC_COMPILER= sunpro
1833: ABI= 64
1834: </pre>
1835: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1836: <h3 class="title">Note</h3>
1837: <p>This setting has been tested for the SPARC
1838: architecture. Intel and AMD machines need some more
1839: work.</p>
1840: </div>
1841: </div>
1842: <div class="sect3" lang="en">
1843: <div class="titlepage"><div><div><h4 class="title">
1844: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1845: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1846: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1847: The workaround is to use another shell for the configure
1848: 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.4 rillig 1849: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1850: <pre class="programlisting">
1851: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1852: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1853: </pre>
1854: <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>
1855: </div>
1856: </div>
1857: </div>
1858: </div>
1859: <div class="chapter" lang="en">
1860: <div class="titlepage"><div><div><h2 class="title">
1861: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1862: <div class="toc">
1863: <p><b>Table of Contents</b></p>
1864: <dl>
1865: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1866: <dd><dl>
1867: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1868: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1869: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1870: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1871: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1872: <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>
1873: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1874: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1875: </dl></dd>
1876: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1877: <dd><dl>
1878: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1879: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1880: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1881: </dl></dd>
1882: </dl>
1883: </div>
1884: <p>Basically, there are two ways of using pkgsrc. The first
1885: is to only install the package tools and to use binary packages
1886: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1887: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1888: of pkgsrc, too. Then you are able to build your own packages,
1889: and you can still use binary packages from someone else.</p>
1890: <div class="sect1" lang="en">
1891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1892: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.5 weinem 1893: <p>To use binary packages, you need some tools to manage them. On
1894: NetBSD, these tools are already installed. On all other operating
1895: systems, you need to install them first. For some platforms, these
1896: tools are already packages in an archive, ready to be extracted in the
1897: <code class="filename">/</code> directory. They can be found in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/bootstrap-pkgsrc" target="_top"><code class="filename">bootstrap-pkgsrc</code></a>
1898: directory of the FTP server.</p>
1.1 dsieger 1899: <p>These pre-built package tools use
1900: <code class="filename">/usr/pkg</code> for the base directory, and
1901: <code class="filename">/var/db/pkg</code> for the database of installed
1902: packages. If you cannot use these directories for whatever
1903: reasons (maybe because you're not root), you have to build the
1904: package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1905: <div class="sect2" lang="en">
1906: <div class="titlepage"><div><div><h3 class="title">
1907: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1908: <p>To install binary packages, you first need to know from where
1909: to get them. The first place where you should look is on the main
1910: pkgsrc FTP server in the directory <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1911: <p>This directory contains binary packages for multiple
1912: platforms. First, select your operating system. (Ignore the
1913: directories with version numbers attached to it, they just exist for
1914: legacy reasons.) Then, select your hardware architecture, and in the
1915: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.
1916: This directory contains a subdirectory called
1917: <code class="filename">All</code>, where (almost) all binary packages are
1918: stored. Almost, because vulnerable packages are moved to the
1919: <code class="filename">vulnerable</code> directory so they don't get
1920: installed accidentally.</p>
1.1 dsieger 1921: </div>
1922: <div class="sect2" lang="en">
1923: <div class="titlepage"><div><div><h3 class="title">
1924: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1925: <p>If you have the files on a CD-ROM or downloaded them to
1926: your hard disk, you can install them with the following command
1927: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1928: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1929: <p>If you have FTP access and you don't want to download the
1930: packages via FTP prior to installation, you can do this
1931: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.5 weinem 1932: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add 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/<em class="replaceable"><code>package</code></em></code></strong></pre>
1.1 dsieger 1933: <p>Note that any prerequisite packages needed to run the
1934: package in question will be installed, too, assuming they are
1935: present where you install from.</p>
1936: <p>To save some typing, you can set the
1937: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1938: list of paths (including remote URLs); trailing slashes are not allowed.
1939: </p>
1940: <p>Additionally to the <code class="filename">All</code> directory
1941: there exists a <code class="filename">vulnerable</code> directory to
1942: which binary packages with known vulnerabilities are
1943: moved, since removing them could cause missing dependencies. To
1944: use these packages, add the <code class="filename">vulnerable</code>
1945: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1946: <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,
1947: especially after installing new packages, and verify that the
1948: vulnerabilities are acceptable for your configuration. An example
1949: <code class="varname">PKG_PATH</code> would be:
1950: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1951: Please note that semicolon (';') is a shell meta-character, so
1952: you'll probably have to quote it.</p>
1953: <p>After you've installed packages, be sure to have
1954: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1955: <code class="varname">PATH</code> so you can actually start the just
1956: installed program.</p>
1957: </div>
1958: <div class="sect2" lang="en">
1959: <div class="titlepage"><div><div><h3 class="title">
1960: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1961: <p>To deinstall a package, it does not matter whether it was
1962: installed from source code or from a binary package. The
1963: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1964: To delete a package, you can just run <span><strong class="command">pkg_delete
1965: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1966: name can be given with or without version number. Wildcards can
1967: also be used to deinstall a set of packages, for example
1968: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1969: so that the shell does not expand them before
1970: <code class="literal">pkg_delete</code> sees them.</p>
1971: <p>The <code class="option">-r</code> option is very powerful: it
1972: removes all the packages that require the package in question
1973: and then removes the package itself. For example:
1974:
1975: </p>
1976: <pre class="screen">
1977: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1978: </pre>
1979: <p>
1980:
1981: will remove jpeg and all the packages that used it; this allows
1982: upgrading the jpeg package.</p>
1983: </div>
1984: <div class="sect2" lang="en">
1985: <div class="titlepage"><div><div><h3 class="title">
1986: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1987: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1988: installed packages or binary package files.</p>
1989: </div>
1990: <div class="sect2" lang="en">
1991: <div class="titlepage"><div><div><h3 class="title">
1992: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1993: <p>
1994: The NetBSD Security-Officer and Packages Groups maintain a list of
1995: known security vulnerabilities to packages which are (or have been)
1996: included in pkgsrc. The list is available from the NetBSD
1997: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1998: </p>
1999: <p>
2000: 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>,
2001: this list can be downloaded
2002: automatically, and a security audit of all packages installed on a system
2003: can take place.
2004: </p>
2005: <p>
2006: There are two components to
2007: <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
2008: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2009: the list of vulnerabilities from the NetBSD FTP site. The second
2010: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2011: installed packages are vulnerable. If a package is vulnerable, you
2012: will see output similar to the following:
2013: </p>
2014: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
2015: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
2016: <p>
2017: 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
2018: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2019: file daily, and include a package audit in the daily security script.
2020: Details on this are located in the <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
2021: 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>.
2022: </p>
2023: </div>
2024: <div class="sect2" lang="en">
2025: <div class="titlepage"><div><div><h3 class="title">
2026: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2027: <p>
2028: 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
2029: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2030: argument to check if your packages are up-to-date, e.g.
2031: </p>
2032: <pre class="screen">
2033: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
2034: ...
2035: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2036: </pre>
2037: <p>You can then use <span><strong class="command">make update</strong></span> to update the
2038: package on your system and rebuild any dependencies.
2039: </p>
2040: </div>
2041: <div class="sect2" lang="en">
2042: <div class="titlepage"><div><div><h3 class="title">
2043: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2044: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
2045: administrative functions on the package system.</p>
2046: </div>
2047: <div class="sect2" lang="en">
2048: <div class="titlepage"><div><div><h3 class="title">
2049: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
2050: <p>Please pay very careful attention to the warnings
2051: expressed in the <a 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
2052: inherent dangers of installing binary packages which you did
2053: not create yourself, and the security holes that can be
2054: introduced onto your system by indiscriminate adding of such
2055: files.</p>
2056: <p>The same warning of course applies to every package you
2057: install from source when you haven't completely read and
2058: understood the source code of the package, the compiler that
2059: is used to build the package and all the other tools that are
2060: involved.</p>
2061: </div>
2062: </div>
2063: <div class="sect1" lang="en">
2064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2065: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
2066: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2067: directory now contains a set of packages, organized into
2068: categories. You can browse the online index of packages, or run
2069: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2070: directory to build local <code class="filename">README.html</code> files for
2071: 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>
2072: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2073: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2074: should do so by setting <code class="varname">LOCALBASE</code> in
1.4 rillig 2075: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 2076: different <code class="varname">LOCALBASE</code> definitions on the same
2077: system (inside a chroot is an exception). </p>
2078: <p>The rest of this chapter assumes that the package is already
2079: in pkgsrc. If it is not, see <a href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
2080: instructions how to create your own packages.</p>
2081: <div class="sect2" lang="en">
2082: <div class="titlepage"><div><div><h3 class="title">
2083: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
2084: <p>To build packages from source, you need a working C
2085: compiler. On NetBSD, you need to install the
2086: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2087: sets. If you want to build X11-related packages, the
2088: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2089: sets are required, too.</p>
2090: </div>
2091: <div class="sect2" lang="en">
2092: <div class="titlepage"><div><div><h3 class="title">
2093: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2094: <p>The first step for building a package is downloading the
2095: distfiles (i.e. the unmodified source). If they have not yet been
2096: downloaded, pkgsrc will fetch them automatically.</p>
2097: <p>If you have all files that you need in the
2098: <code class="filename">distfiles</code> directory,
2099: you don't need to connect. If the distfiles are on CD-ROM, you can
2100: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2101: </p>
2102: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2103: <p>
1.4 rillig 2104: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2105: <p>By default a list of distribution sites will be randomly
2106: intermixed to prevent huge load on servers which holding popular
2107: packages (for example, SourceForge.net mirrors). Thus, every
2108: time when you need to fetch yet another distfile all the mirrors
2109: will be tried in new (random) order. You can turn this feature
2110: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2111: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
2112: <p>You can overwrite some of the major distribution sites to
2113: fit to sites that are close to your own. By setting one or two
2114: variables you can modify the order in which the master sites are
2115: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2116: delimited list of domain suffixes.
2117: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2118: contains a whitespace delimited list of regular expressions. It
2119: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2120: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2121: some examples. This may save some of your bandwidth and
2122: time.</p>
2123: <p>You can change these settings either in your shell's environment, or,
2124: if you want to keep the settings, by editing the
1.4 rillig 2125: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 2126: and adding the definitions there.</p>
2127: <p>
2128: If a package depends on many other packages (such as
2129: <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
2130: alternate between periods of
2131: downloading source, and compiling. To ensure you have all the source
2132: downloaded initially you can run the command:
2133: </p>
2134: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2135: <p>
2136: which will output and run a set of shell commands to fetch the
2137: necessary files into the <code class="filename">distfiles</code> directory. You can
2138: also choose to download the files manually.
2139: </p>
2140: </div>
2141: <div class="sect2" lang="en">
2142: <div class="titlepage"><div><div><h3 class="title">
2143: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
2144: <p>
2145: Once the software has downloaded, any patches will be applied, then it
2146: will be compiled for you. This may take some time depending on your
2147: computer, and how many other packages the software depends on and their
2148: compile time.
2149: </p>
2150: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2151: <h3 class="title">Note</h3>
2152: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
2153: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2154: “<span class="quote">make</span>” in the examples in this guide.</p>
2155: </div>
2156: <p>For example, type</p>
2157: <pre class="screen">
2158: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2159: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2160: </pre>
2161: <p>at the shell prompt to build the various components of the
2162: package.</p>
2163: <p>The next stage is to actually install the newly compiled
2164: program onto your system. Do this by entering:
2165:
2166: </p>
2167: <pre class="screen">
2168: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2169: </pre>
2170: <p>
2171:
2172: while you are still in the directory for whatever package you
2173: are installing.</p>
2174: <p>Installing the package on your system may require you to
2175: be root. However, pkgsrc has a
2176: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2177: to only become root for the actual installation step.</p>
2178: <p>That's it, the software should now be installed and setup for use.
2179: You can now enter:
2180:
2181: </p>
2182: <pre class="screen">
2183: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2184: </pre>
2185: <p>
2186:
2187: to remove the compiled files in the work directory, as you shouldn't need
2188: them any more. If other packages were also added to your system
2189: (dependencies) to allow your program to compile, you can tidy these up
2190: also with the command:</p>
2191: <pre class="screen">
2192: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2193: </pre>
2194: <p>Taking the figlet utility as an example, we can install it on our
2195: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2196: <p>The program is installed under the default root of the
2197: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2198: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2199: variable in your environment, and it will use that value as the
2200: root of your packages tree. So, to use
2201: <code class="filename">/usr/local</code>, set
2202: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2203: Please note that you should use a directory which is dedicated to
2204: packages and not shared with other programs (i.e., do not try and
2205: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2206: to add any of your own files or directories (such as
2207: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2208: <code class="filename">pkgsrc/</code>) below the
2209: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2210: conflicts between programs and other files installed by the
2211: package system and whatever else may have been installed
2212: there.</p>
1.4 rillig 2213: <p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2214: alter some configuration options at build time. Have a look at
2215: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2216: of what will be set there by default. Environment variables such
2217: as <code class="varname">LOCALBASE</code> can be set in
1.4 rillig 2218: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2219: set them each time you want to use pkgsrc.</p>
2220: <p>Occasionally, people want to “<span class="quote">look under the
2221: covers</span>” to see what is going on when a package is building
2222: or being installed. This may be for debugging purposes, or out of
2223: simple curiosity. A number of utility values have been added to
2224: help with this.</p>
2225: <div class="orderedlist"><ol type="1">
2226: <li>
2227: <p>If you invoke the <a 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
2228: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2229: information will be displayed. For example,</p>
2230: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2231: <p>will show all the commands that are invoked, up to and
2232: including the “<span class="quote">patch</span>” stage.</p>
2233: </li>
2234: <li>
2235: <p>If you want to know the value of a certain <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
2236: definition, then the <code class="varname">VARNAME</code> definition
2237: should be used, in conjunction with the show-var
2238: target. e.g. to show the expansion of the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
2239: variable <code class="varname">LOCALBASE</code>:</p>
2240: <pre class="screen">
2241: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2242: /usr/pkg
2243: <code class="prompt">%</code>
2244: </pre>
2245: </li>
2246: </ol></div>
2247: <p>If you want to install a binary package that you've either
2248: created yourself (see next section), that you put into
2249: pkgsrc/packages manually or that is located on a remote FTP
2250: server, you can use the "bin-install" target. This target will
2251: install a binary package - if available - via <a 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>,
2252: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2253: sites searched is kept in the variable
2254: <code class="varname">BINPKG_SITES</code>, which defaults to
2255: ftp.NetBSD.org. Any flags that should be added to <a 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>
2256: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2257: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2258: details.</p>
2259: <p>A final word of warning: If you set up a system that has a
2260: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2261: set that before any packages are installed, as you cannot use
2262: several directories for the same purpose. Doing so will result in
2263: pkgsrc not being able to properly detect your installed packages,
2264: and fail miserably. Note also that precompiled binary packages are
2265: usually built with the default <code class="varname">LOCALBASE</code> of
2266: <code class="filename">/usr/pkg</code>, and that you should
2267: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2268: <code class="varname">LOCALBASE</code>.</p>
2269: </div>
2270: </div>
2271: </div>
2272: <div class="chapter" lang="en">
2273: <div class="titlepage"><div><div><h2 class="title">
2274: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2275: <div class="toc">
2276: <p><b>Table of Contents</b></p>
2277: <dl>
2278: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2279: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.4 rillig 2280: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
2281: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2282: <dd><dl>
1.4 rillig 2283: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2284: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2285: <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 2286: </dl></dd>
1.4 rillig 2287: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2288: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2289: </dl>
2290: </div>
1.4 rillig 2291: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2292: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2293: that file depends on the installation. On NetBSD, when you use
2294: <a 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
2295: <code class="filename">/etc/</code>. In all other cases the default location is
2296: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2297: bootstrap program to install the binary packages.</p>
2298: <p>During the bootstrap, an example configuration file is created. To
2299: use that, you have to create the directory
2300: <code class="filename">${PREFIX}/etc</code> and copy the example file
2301: there.</p>
2302: <p>The format of the configuration file is that of the usual
2303: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2304: is done by setting variables in this file. Note that you can define all
2305: kinds of variables, and no special error checking (for example for
2306: spelling mistakes) takes place, so you have to try it out to see if it
2307: works.</p>
2308: <div class="sect1" lang="en">
2309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2310: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2311: <p>In this section, you can find some variables that apply to all
2312: pkgsrc packages. A complete list of the variables that can be
2313: configured by the user is available in
2314: <code class="filename">mk/defaults/mk.conf</code>, together with some
2315: comments that describe each variable's intent.</p>
2316: <div class="itemizedlist"><ul type="disc">
2317: <li><p><code class="varname">LOCALBASE</code>: Where
2318: packages will be installed. The default is
2319: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2320: with different <code class="varname">LOCALBASE</code>s!</p></li>
2321: <li><p><code class="varname">CROSSBASE</code>: Where
2322: “<span class="quote">cross</span>” category packages will be
2323: installed. The default is
2324: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
2325: <li><p><code class="varname">X11BASE</code>: Where
2326: X11 is installed on the system. The default is
2327: <code class="filename">/usr/X11R6</code>.</p></li>
2328: <li><p><code class="varname">DISTDIR</code>: Where to store the
2329: downloaded copies of the original source distributions used
2330: for building pkgsrc packages. The default is
2331: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
2332: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2333: database about installed packages is stored. The default is
2334: <code class="filename">/var/db/pkg</code>.</p></li>
2335: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2336: If set, override the packages'
2337: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2338: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2339: Backup location(s) for distribution files and patch files
2340: if not found locally or in
2341: <code class="filename">${MASTER_SITES}</code> or
2342: <code class="filename">${PATCH_SITES}</code> respectively.
2343: The defaults are
2344: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
2345: and
2346: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
2347: <li><p><code class="varname">BINPKG_SITES</code>:
2348: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2349: <em class="replaceable"><code>arch</code></em> are replaced with OS
2350: release (“<span class="quote">2.0</span>”, etc.) and architecture
2351: (“<span class="quote">mipsel</span>”, etc.).</p></li>
2352: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2353: List of acceptable licenses. Whenever you try to build a package
2354: whose license is not in this list, you will get an error message
2355: that includes instructions on how to change this variable.</p></li>
2356: </ul></div>
2357: </div>
2358: <div class="sect1" lang="en">
2359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2360: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2361: <p>XXX
2362: </p>
2363: <div class="itemizedlist"><ul type="disc">
2364: <li><p><code class="varname">PACKAGES</code>: The top level
2365: directory for the binary packages. The default is
2366: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
2367: <li><p><code class="varname">WRKOBJDIR</code>:
2368: The top level directory where, if defined, the separate
2369: working directories will get created, and symbolically
2370: linked to from <code class="filename">${WRKDIR}</code> (see below).
2371: This is useful for building packages on several
2372: architectures, then <code class="filename">${PKGSRCDIR}</code>
2373: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2374: is local to every architecture. (It should be noted that
2375: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.6 rillig 2376: — it is an internal definition which refers to the
1.1 dsieger 2377: root of the pkgsrc tree. It is possible to have many
2378: pkgsrc tree instances.)</p></li>
2379: <li><p><code class="varname">LOCALPATCHES</code>:
2380: Directory for local patches that aren't part of pkgsrc.
1.6 rillig 2381: See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2382: information.</p></li>
2383: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.4 rillig 2384: the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2385: BSD-style Makefile. If this is not set,
2386: <code class="varname">MAKECONF</code> is set to
2387: <code class="filename">/dev/null</code> to avoid picking up
2388: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
2389: <li><p><code class="varname">DEPENDS_TARGET</code>:
2390: By default, dependencies are only installed, and no binary
2391: package is created for them. You can set this variable to
2392: <code class="literal">package</code> to automatically create binary
2393: packages after installing dependencies.</p></li>
2394: </ul></div>
2395: </div>
2396: <div class="sect1" lang="en">
2397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2398: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installion process</h2></div></div></div>
2399: <p>A growing number of packages support installation into a
2400: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2401: to be built, before the actual filesystem is touched. DESTDIR
2402: support exists in two variations:</p>
2403: <div class="itemizedlist"><ul type="disc">
2404: <li><p>Basic DESTDIR support means that the package
2405: installation and packaging is still run as
2406: root.</p></li>
2407: <li><p>Full DESTDIR support can run the complete build,
2408: installation and packaging as normal user. Root privileges are
2409: only needed to add packages.</p></li>
2410: </ul></div>
2411: <p>To use the DESTDIR support, set either
2412: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2413: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2414: get the full support with fallback to basic
2415: 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
2416: newer). It might become the default DESTDIR support later.</p>
2417: <p>DESTDIR support changes the behaviour of various targets
2418: slightly. To install a package after building it, use
2419: <code class="literal">package-install</code>. <code class="literal">package</code> and
2420: <code class="literal">install</code> don't do that any
2421: longer. <code class="literal">package-install</code> can be used as
2422: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2423: will ask for the root password to install the package and fail,
2424: <code class="literal">package-install</code> will ask again.</p>
2425: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2426: clean</code></strong> needs to be run as root.</p>
2427: </div>
2428: <div class="sect1" lang="en">
2429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2430: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.1 dsieger 2431: <div class="sect2" lang="en">
2432: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2433: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2434: <p>By default, pkgsrc will use GCC to build packages. This may be
2435: overridden by setting the following variables in /etc/mk.conf:</p>
2436: <div class="variablelist"><dl>
2437: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2438: <dd>
2439: <p>This is a list of values specifying the chain of
2440: compilers to invoke when building packages. Valid values
2441: are:</p>
2442: <div class="itemizedlist"><ul type="disc">
2443: <li><p><code class="varname">distcc</code>:
2444: distributed C/C++ (chainable)</p></li>
2445: <li><p><code class="varname">ccache</code>:
2446: compiler cache (chainable)</p></li>
2447: <li><p><code class="varname">gcc</code>:
2448: GNU C/C++ Compiler</p></li>
2449: <li><p><code class="varname">mipspro</code>:
2450: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2451: <li><p><code class="varname">mipspro</code>:
2452: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2453: <li><p><code class="varname">sunpro</code>:
2454: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2455: </ul></div>
2456: <p>The default is
2457: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2458: <code class="varname">ccache</code> and/or
2459: <code class="varname">distcc</code> with an appropriate
2460: <code class="varname">PKGSRC_COMPILER</code> setting,
2461: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
2462: variable should always be terminated with a value for
2463: a real compiler. Note that only one real compiler
2464: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2465: is not allowed).</p>
2466: </dd>
2467: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2468: <dd><p>This specifies the minimum version of GCC to use
2469: when building packages. If the system GCC doesn't
2470: satisfy this requirement, then pkgsrc will build and
2471: install one of the GCC packages to use instead.</p></dd>
2472: </dl></div>
2473: </div>
2474: <div class="sect2" lang="en">
2475: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2476: <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 2477: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2478: please make sure to use the <code class="literal">+=</code> operator
2479: instead of the <code class="literal">=</code> operator:</p>
2480: <pre class="programlisting">
2481: CFLAGS+= -your -flags
2482: </pre>
2483: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2484: “<span class="quote">+</span>”) may lead to problems with packages that need
2485: to add their own flags. Also, you may want to take a look at
2486: 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
2487: you're interested in optimization for the current CPU.</p>
2488: </div>
2489: <div class="sect2" lang="en">
2490: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2491: <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 2492: <p>If you want to pass flags to the linker, both in the configure
2493: step and the build step, you can do this in two ways. Either set
2494: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2495: between the two is that <code class="varname">LIBS</code> will be appended to
2496: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2497: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2498: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2499: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2500: <code class="varname">CFLAGS</code>, if you do not wish to override these
2501: settings, use the <code class="literal">+=</code> operator:</p>
2502: <pre class="programlisting">
2503: LDFLAGS+= -your -linkerflags
2504: </pre>
2505: </div>
2506: </div>
2507: <div class="sect1" lang="en">
2508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2509: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2510: <p>XXX
2511: </p>
2512: <div class="itemizedlist"><ul type="disc">
2513: <li>
2514: <p><code class="varname">PKG_DEVELOPER</code>:
2515: Run some sanity checks that package developers want:
2516: </p>
2517: <div class="itemizedlist"><ul type="circle">
2518: <li><p>make sure patches apply with zero
2519: fuzz</p></li>
2520: <li><p>run check-shlibs to see that all
2521: binaries will find their shared libs.</p></li>
2522: </ul></div>
2523: <p>
2524: </p>
2525: </li>
2526: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2527: of debugging output which is displayed whilst making and
2528: installing the package. The default value for this is 0,
2529: which will not display the commands as they are executed
2530: (normal, default, quiet operation); the value 1 will display
2531: all shell commands before their invocation, and the value 2
2532: will display both the shell commands before their invocation,
2533: and their actual execution progress with <span><strong class="command">set
2534: -x</strong></span> will be displayed.</p></li>
2535: </ul></div>
2536: <p>
2537: </p>
2538: </div>
2539: <div class="sect1" lang="en">
2540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2541: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2542: <p>Some packages have build time options, usually to select
2543: between different dependencies, enable optional support for big
2544: dependencies or enable experimental features.</p>
2545: <p>To see which options, if any, a package supports, and which
2546: options are mutually exclusive, run <span><strong class="command">make
2547: show-options</strong></span>, for example:</p>
2548: <pre class="programlisting">
2549: The following options are supported by this package:
2550: ssl Enable SSL support.
2551: Exactly one of the following gecko options is required:
2552: firefox Use firefox as gecko rendering engine.
2553: mozilla Use mozilla as gecko rendering engine.
2554: At most one of the following database options may be selected:
2555: mysql Enable support for MySQL database.
2556: pgsql Enable support for PostgreSQL database.
2557:
2558: These options are enabled by default: firefox
2559: These options are currently enabled: mozilla ssl
2560: </pre>
2561: <p>The following variables can be defined in
1.4 rillig 2562: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2563: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2564: which can be used to select or disable options for all packages
2565: that support them, and
2566: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2567: which can be used to select or disable options specifically for
2568: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2569: these variables are selected, options preceded by “<span class="quote">-</span>”
2570: are disabled. A few examples:</p>
2571: <pre class="screen">
1.4 rillig 2572: <code class="prompt">$</code> <span><strong class="command">grep "PKG.*OPTION" <a href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1 dsieger 2573: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2574: PKG_OPTIONS.kdebase= debug -sasl
2575: PKG_OPTIONS.apache= suexec </pre>
2576: <p>The following settings are consulted in the order given, and
2577: the last setting that selects or disables an option is
2578: used:</p>
2579: <div class="orderedlist"><ol type="1">
2580: <li><p>the default options as suggested by the package
2581: maintainer</p></li>
2582: <li><p>the options implied by the settings of legacy
2583: variables (see below)</p></li>
2584: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2585: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2586: </ol></div>
2587: <p>For groups of mutually exclusive options, the last option
2588: selected is used, all others are automatically disabled. If an
2589: option of the group is explicitly disabled, the previously
2590: selected option, if any, is used. It is an error if no option
2591: from a required group of options is selected, and building the
2592: package will fail.</p>
2593: <p>Before the options framework was introduced, build options
2594: were selected by setting a variable (often named
2595: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.4 rillig 2596: <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2597: transition to the options framework for the user, these legacy
2598: variables are converted to the appropriate options setting
2599: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2600: automatically. A warning is issued to prompt the user to update
1.4 rillig 2601: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2602: directly. Support for the legacy variables will be removed
2603: eventually.</p>
2604: </div>
2605: </div>
2606: <div class="chapter" lang="en">
2607: <div class="titlepage"><div><div><h2 class="title">
2608: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2609: <div class="toc">
2610: <p><b>Table of Contents</b></p>
2611: <dl>
2612: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2613: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2614: </dl>
2615: </div>
2616: <div class="sect1" lang="en">
2617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2618: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2619: <p>Once you have built and installed a package, you can create
2620: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2621: another system with <a 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
2622: the same package on a group of hosts and wasting CPU time. It also
2623: provides a simple means for others to install your package, should
2624: you distribute it.</p>
2625: <p>To create a binary package, change into the appropriate
2626: directory in pkgsrc, and run <span><strong class="command">make
2627: package</strong></span>:</p>
2628: <pre class="screen">
2629: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2630: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2631: </pre>
2632: <p>This will build and install your package (if not already done),
2633: and then build a binary package from what was installed. You can
2634: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2635: it. Binary packages are created by default in
2636: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2637: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
2638: 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.6 rillig 2639: <p>See <a 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 2640: such a binary package.</p>
2641: </div>
2642: <div class="sect1" lang="en">
2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2644: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.6 rillig 2645: <p>See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
2646: </div>
2647: </div>
2648: <div class="chapter" lang="en">
2649: <div class="titlepage"><div><div><h2 class="title">
2650: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2651: builds)</h2></div></div></div>
2652: <div class="toc">
2653: <p><b>Table of Contents</b></p>
2654: <dl>
2655: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2656: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2657: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2658: <dd><dl>
2659: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2660: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2661: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2662: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2663: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2664: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2665: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2666: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2667: </dl></dd>
2668: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
2669: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
2670: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2671: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2672: </dl>
2673: </div>
2674: <p>When you have multiple machines that should run the same packages,
2675: it is wasted time if they all build their packages themselves from
2676: source. There are two ways of getting a set of binary packages: The old
2677: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2678: system. This chapter describes how to set them up so that the packages
2679: are most likely to be usable later.</p>
2680: <div class="sect1" lang="en">
2681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2682: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2683: <p>Since a bulk build takes several days or even weeks to finish, you
2684: should think about the setup before you start everything. Pay attention
2685: to at least the following points:</p>
2686: <div class="itemizedlist"><ul type="disc">
2687: <li>
2688: <p>If you want to upload the binary packages to
2689: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2690: packages:</p>
2691: <div class="itemizedlist"><ul type="circle">
2692: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2693: by a NetBSD developer on a trusted machine (that is, where you and only
2694: you have root access).</p></li>
2695: <li><p>Packages on ftp.NetBSD.org should only be created from
2696: the stable branches (like 2007Q1), so that users browsing the available
2697: collections can see at a glance how old the packages
2698: are.</p></li>
2699: <li><p>The packages must be built as root, since some packages
2700: require set-uid binaries at runtime, and creating those packages as
2701: unprivileged user doesn't work well at the moment.</p></li>
2702: </ul></div>
2703: </li>
2704: <li><p>Make sure that the bulk build cannot break anything in
2705: your system. Most bulk builds run as root, so they should be run at least
2706: in a chroot environment or something even more restrictive, depending on
2707: what the operating system provides. There have been numerous cases where
2708: certain packages tried to install files outside the
2709: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2710: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2711: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2712: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2713: that you don't need any package during the build.</p></li>
2714: </ul></div>
2715: </div>
2716: <div class="sect1" lang="en">
2717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2718: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2719: <p>A complete bulk build requires lots of disk space. Some of the
2720: disk space can be read-only, some other must be writable. Some can be on
2721: remote filesystems (such as NFS) and some should be local. Some can be
2722: temporary filesystems, others must survive a sudden reboot.</p>
2723: <div class="itemizedlist"><ul type="disc">
2724: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2725: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2726: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2727: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2728: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2729: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2730: </ul></div>
1.1 dsieger 2731: </div>
2732: <div class="sect1" lang="en">
2733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2734: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
2735: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2736: <h3 class="title">Warning</h3>
2737: <p>The rest of this section is rather old. Don't rely on it
2738: too much.</p>
2739: </div>
1.1 dsieger 2740: <div class="sect2" lang="en">
2741: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2742: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.1 dsieger 2743: <div class="sect3" lang="en">
2744: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2745: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1 dsieger 2746: </h4></div></div></div>
2747: <p>The <code class="filename">build.conf</code> file is the main
2748: configuration file for bulk builds. You can configure how your
2749: copy of pkgsrc is kept up to date, how the distfiles are
2750: downloaded, how the packages are built and how the report is
2751: generated. You can find an annotated example file in
2752: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2753: it, copy <code class="filename">build.conf-example</code> to
2754: <code class="filename">build.conf</code> and edit it, following the
2755: comments in that file.</p>
2756: </div>
2757: <div class="sect3" lang="en">
2758: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2759: <a name="binary.mk.conf"></a>7.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4 rillig 2760: </h4></div></div></div>
2761: <p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1 dsieger 2762: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2763: details of the default settings. You will want to ensure that
2764: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2765: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.4 rillig 2766: completely bypasses the license check.</p>
1.1 dsieger 2767: <pre class="programlisting">
2768: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2769: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2770: BSDSRCDIR= /usr/src
2771: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2772: OBJHOSTNAME?= yes # use work.`hostname`
2773: FAILOVER_FETCH= yes # insist on the correct checksum
2774: PKG_DEVELOPER?= yes
2775: _ACCEPTABLE= yes
2776: </pre>
2777: <p>Some options that are especially useful for bulk builds
2778: can be found at the top lines of the file
2779: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2780: options of these are briefly described here.</p>
2781: <div class="itemizedlist"><ul type="disc">
2782: <li><p>If you are on a slow machine, you may want to
2783: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2784: “<span class="quote">no</span>”.</p></li>
2785: <li><p>If you are doing bulk builds from a read-only
2786: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2787: to the directory where all log files are created. Otherwise the
2788: log files are created in the pkgsrc directory.</p></li>
2789: <li><p>Another important variable is
2790: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2791: should be always available while building other
2792: packages.</p></li>
2793: </ul></div>
2794: <p>Some other options are scattered in the pkgsrc
2795: infrastructure:</p>
2796: <div class="itemizedlist"><ul type="disc">
2797: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2798: should be set to <code class="literal">yes</code>. The purpose of the bulk
2799: builds is creating binary packages, no matter if they are
2800: vulnerable or not. When uploading the packages to a public
2801: server, the vulnerable packages will be put into a directory of
2802: their own. Leaving this variable unset would prevent the bulk
2803: build system from even trying to build them, so possible
2804: building errors would not show up.</p></li>
2805: <li><p><code class="varname">CHECK_FILES</code>
2806: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
2807: “<span class="quote">yes</span>” to check that the installed set of files
2808: matches the <code class="filename">PLIST</code>.</p></li>
2809: <li><p><code class="varname">CHECK_INTERPRETER</code>
2810: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
2811: “<span class="quote">yes</span>” to check that the installed
2812: “<span class="quote">#!</span>”-scripts will find their
2813: interpreter.</p></li>
2814: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2815: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2816: package's self-test before installing it. Note that some
2817: packages make heavy use of “<span class="quote">good</span>” random
2818: numbers, so you need to assure that the machine on which you
2819: are doing the bulk builds is not completely idle. Otherwise
2820: some test programs will seem to hang, while they are just
2821: waiting for new random data to be
2822: available.</p></li>
2823: </ul></div>
2824: </div>
2825: <div class="sect3" lang="en">
2826: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2827: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1 dsieger 2828: </h4></div></div></div>
2829: <p>It is possible to configure the bulk build to perform
2830: certain site-specific tasks at the end of the pre-build
2831: stage. If the file
2832: <code class="filename">pre-build.local</code> exists in
2833: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2834: (as a <a 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
2835: stage. An example use of
2836: <code class="filename">pre-build.local</code> is to have the line:</p>
2837: <pre class="screen">echo "I do not have enough disk space to build this pig." \
2838: > misc/openoffice/$BROKENF</pre>
2839: <p>to prevent the system from trying to build a particular package
2840: which requires nearly 3 GB of disk space.</p>
2841: </div>
2842: </div>
2843: <div class="sect2" lang="en">
2844: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2845: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1 dsieger 2846: <p>As <code class="filename">/usr/pkg</code> will be completely
2847: deleted at the start of bulk builds, make sure your login
2848: shell is placed somewhere else. Either drop it into
2849: <code class="filename">/usr/local/bin</code> (and adjust your login
2850: shell in the passwd file), or (re-)install it via
2851: <a 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
2852: you can login after a reboot (remember that your current
2853: process won't die if the package is removed, you just can't
2854: start any new instances of the shell any more). Also, if you
2855: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2856: version of ssh for some reason, be sure to install ssh before
2857: starting it from <code class="filename">rc.local</code>:</p>
2858: <pre class="programlisting">
2859: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2860: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2861: /usr/pkg/etc/rc.d/sshd
2862: fi
2863: </pre>
2864: <p>Not doing so will result in you being not able to log in
2865: via ssh after the bulk build is finished or if the machine
2866: gets rebooted or crashes. You have been warned! :)</p>
2867: </div>
2868: <div class="sect2" lang="en">
2869: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2870: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1 dsieger 2871: <p>Make sure you don't need any of the packages still
2872: installed.</p>
2873: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2874: <h3 class="title">Warning</h3>
2875: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2876: configuration files and some more files from
2877: <code class="filename">/var</code>, <code class="filename">/home</code> and
2878: possibly other locations will be removed! So don't run a bulk
2879: build with privileges that might harm your
2880: system.</em></span></p>
2881: </div>
2882: <p>Be sure to remove all other things that might
2883: interfere with builds, like some libs installed in
2884: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2885: <pre class="screen">
2886: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2887: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2888: </pre>
2889: <p>If for some reason your last build didn't complete (power
2890: failure, system panic, ...), you can continue it by
2891: running:</p>
2892: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2893: <p>At the end of the bulk build, you will get a summary via mail,
2894: and find build logs in the directory specified by
2895: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2896: file.</p>
2897: </div>
2898: <div class="sect2" lang="en">
2899: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2900: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1 dsieger 2901: <p>The bulk builds consist of three steps:</p>
2902: <div class="variablelist"><dl>
2903: <dt><span class="term">1. pre-build</span></dt>
2904: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2905: cleans out any broken distfiles, and removes all
2906: packages installed.</p></dd>
2907: <dt><span class="term">2. the bulk build</span></dt>
2908: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2909: an optimised order in which packages will be
2910: built. Packages that don't require other packages will
2911: be built first, and packages with many dependencies will
2912: be built later.</p></dd>
2913: <dt><span class="term">3. post-build</span></dt>
2914: <dd><p>Generates a report that's placed in the directory
2915: specified in the <code class="filename">build.conf</code> file
2916: named <code class="filename">broken.html</code>, a short version
2917: of that report will also be mailed to the build's
2918: admin.</p></dd>
2919: </dl></div>
2920: <p>During the build, a list of broken packages will be compiled
2921: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2922: <code class="filename">.../.broken.${MACHINE}</code> if
2923: <code class="varname">OBJMACHINE</code> is set), individual build logs
2924: of broken builds can be found in the package's
2925: directory. These files are used by the bulk-targets to mark
2926: broken builds to not waste time trying to rebuild them, and
2927: they can be used to debug these broken package builds
2928: later.</p>
2929: </div>
2930: <div class="sect2" lang="en">
2931: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2932: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1 dsieger 2933: <p>Currently, roughly the following requirements are valid for
2934: NetBSD 2.0/i386:</p>
2935: <div class="itemizedlist"><ul type="disc">
2936: <li><p>10 GB - distfiles (NFS ok)</p></li>
2937: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2938: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2939: </ul></div>
2940: <p>Note that all pkgs will be de-installed as soon as they are
2941: turned into a binary package, and that sources are removed,
2942: so there is no excessively huge demand to disk
2943: space. Afterwards, if the package is needed again, it will
2944: be installed via <a 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
2945: there are no cycles wasted by recompiling.</p>
2946: </div>
2947: <div class="sect2" lang="en">
2948: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2949: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1 dsieger 2950: <p>If you don't want all the packages nuked from a machine
2951: (rendering it useless for anything but pkg compiling), there
2952: is the possibility of doing the package bulk build inside a
2953: chroot environment.</p>
2954: <p>The first step is to set up a chroot sandbox,
2955: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2956: using null mounts, or manually.</p>
2957: <p>There is a shell script called
2958: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2959: up the sandbox environment using null mounts. It will also
2960: create a script called <code class="filename">sandbox</code> in the
2961: root of the sandbox environment, which will allow the null
2962: mounts to be activated using the <span><strong class="command">sandbox
2963: mount</strong></span> command and deactivated using the
2964: <span><strong class="command">sandbox umount</strong></span> command.</p>
2965: <p>To set up a sandbox environment by hand, after extracting all
2966: the sets from a NetBSD installation or doing a <span><strong class="command">make
2967: distribution DESTDIR=/usr/sandbox</strong></span> in
2968: <code class="filename">/usr/src/etc</code>, be sure the following items
2969: are present and properly configured:</p>
2970: <div class="procedure"><ol type="1">
2971: <li>
2972: <p>Kernel</p>
2973: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2974: </li>
2975: <li>
2976: <p><code class="filename">/dev/*</code></p>
2977: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2978: </li>
2979: <li>
2980: <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>
2981: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2982: </li>
2983: <li>
2984: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2985: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2986: </li>
2987: <li>
2988: <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>
2989: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2990: </li>
2991: <li>
2992: <p><code class="filename">/usr/src</code> (system sources,
1.6 rillig 2993: 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 2994: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2995: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2996: </li>
2997: <li>
2998: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2999: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
3000: </li>
3001: <li>
3002: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
3003: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
3004: </li>
3005: <li>
3006: <p>Checkout pkgsrc via cvs into
3007: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
3008: <pre class="screen">
3009: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
3010: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
3011: </pre>
3012: <p>Do not mount/link this to the copy of your pkgsrc tree
3013: you do development in, as this will likely cause problems!</p>
3014: </li>
3015: <li><p>Make
3016: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
3017: <code class="filename">.../distfiles</code> point somewhere
3018: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.6 rillig 3019: <li><p>Edit <a href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a 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 3020: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
3021: </ol></div>
3022: <p>When the chroot sandbox is set up, you can start
3023: the build with the following steps:</p>
3024: <pre class="screen">
3025: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3026: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
3027: </pre>
3028: <p>This will just jump inside the sandbox and start building. At
3029: the end of the build, mail will be sent with the results of
3030: the build. Created binary pkgs will be in
3031: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
3032: (wherever that points/mounts to/from).</p>
3033: </div>
3034: <div class="sect2" lang="en">
3035: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3036: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1 dsieger 3037: <p>In addition to building a complete set of all packages in
3038: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
3039: may be used to build a subset of the packages contained in
3040: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.4 rillig 3041: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.1 dsieger 3042: <div class="itemizedlist"><ul type="disc">
3043: <li><p>SITE_SPECIFIC_PKGS</p></li>
3044: <li><p>HOST_SPECIFIC_PKGS</p></li>
3045: <li><p>GROUP_SPECIFIC_PKGS</p></li>
3046: <li><p>USER_SPECIFIC_PKGS</p></li>
3047: </ul></div>
3048: <p>will define the set of packages which should be built.
3049: The bulk build code will also include any packages which are
3050: needed as dependencies for the explicitly listed packages.</p>
3051: <p>One use of this is to do a bulk build with
3052: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
3053: periodically to have a complete set of the binary packages
3054: needed for your site available without the overhead of
3055: building extra packages that are not needed.</p>
3056: </div>
3057: <div class="sect2" lang="en">
3058: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3059: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1 dsieger 3060: <p>This section describes how pkgsrc developers can upload binary
3061: pkgs built by bulk builds to ftp.NetBSD.org.</p>
3062: <p>If you would like to automatically create checksum files for the
3063: binary packages you intend to upload, remember to set
3064: <code class="varname">MKSUMS=yes</code> in your
3065: <code class="filename">mk/bulk/build.conf</code>.</p>
3066: <p>If you would like to PGP sign the checksum files (highly
3067: recommended!), remember to set
3068: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
3069: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
3070: your GPG password to sign the files before uploading everything.</p>
3071: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
3072: set properly in your <code class="filename">mk/bulk/build.conf</code>
3073: file, i.e. adjust it to something like one of the following:</p>
3074: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
3075: <p>Please use appropriate values for "packages-200xQy",
3076: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
3077: is different from your local login, write your login directly
3078: into the variable, e.g. my local account is "feyrer", but for my
3079: login "hubertf", I use:</p>
3080: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
3081: <p>A separate <code class="filename">upload</code> directory is used
3082: here to allow "closing" the directory during upload. To do
3083: so, run the following command on ftp.NetBSD.org next:</p>
3084: <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>
3085: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3086: only appropriate for packages for the NetBSD operating
3087: system. Binary packages for other operating systems should go
3088: into <code class="filename">/pub/pkgsrc</code>.</p>
3089: <p>Before uploading the binary pkgs, ssh authentication needs
3090: to be set up. This example shows how to set up temporary keys
3091: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3092: (assuming that no keys should be present there usually):</p>
3093: <pre class="screen">
3094: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
3095: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3096: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
3097: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3098: </pre>
3099: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3100: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3101: file on ftp.NetBSD.org. You can remove the key after the
3102: upload is done!</p>
3103: <p>Next, test if your ssh connection really works:</p>
3104: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
3105: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3106: <p>Now after all this works, you can exit the sandbox and start
3107: the upload:</p>
3108: <pre class="screen">
3109: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
3110: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3111: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3112: </pre>
3113: <p>The upload process may take quite some time. Use <a 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
3114: <a 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
3115: upload. The upload script will take care of not uploading
3116: restricted packages and putting vulnerable packages into the
3117: <code class="filename">vulnerable</code> subdirectory.</p>
3118: <p>After the upload has ended, first thing is to revoke ssh access:</p>
3119: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
3120: Gdd:x! </pre>
3121: <p>Use whatever is needed to remove the key you've entered
3122: before! Last, move the uploaded packages out of the
3123: <code class="filename">upload</code> directory to have them accessible
3124: to everyone:</p>
3125: <pre class="screen">
3126: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
3127: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3128: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
3129: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3130: </pre>
3131: </div>
3132: </div>
3133: <div class="sect1" lang="en">
3134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3135: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
3136: <div class="sect2" lang="en">
3137: <div class="titlepage"><div><div><h3 class="title">
3138: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
3139: <p>TODO; see <a href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
3140: more information.</p>
3141: </div>
3142: </div>
3143: <div class="sect1" lang="en">
3144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3145: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 3146: <p>After your pkgsrc bulk-build has completed, you may wish to
3147: create a CD-ROM set of the resulting binary packages to assist
3148: in installing packages on other machines. The
3149: <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
3150: a simple tool for creating the ISO 9660 images.
3151: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3152: way that keeps all the dependencies for a given package on the same
3153: CD as that package.</p>
3154: <div class="sect2" lang="en">
3155: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3156: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 3157: <p>Complete documentation for cdpack is found in the cdpack(1)
3158: man page. The following short example assumes that the binary
3159: packages are left in
3160: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3161: sufficient disk space exists in <code class="filename">/u2</code> to
3162: hold the ISO 9660 images.</p>
3163: <pre class="screen">
3164: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
3165: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
3166: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3167: </pre>
3168: <p>If you wish to include a common set of files
3169: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3170: etc.) on each CD in the collection, then you need to create a
3171: directory which contains these files. e.g.</p>
3172: <pre class="screen">
3173: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
3174: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3175: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3176: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3177: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3178: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
3179: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3180: </pre>
3181: <p>Now create the images:</p>
3182: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3183: <p>Each image will contain <code class="filename">README</code>,
3184: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3185: in their root directories.</p>
3186: </div>
3187: </div>
3188: </div>
3189: <div class="chapter" lang="en">
3190: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3191: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 3192: <div class="toc">
3193: <p><b>Table of Contents</b></p>
3194: <dl>
1.6 rillig 3195: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3196: <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 3197: </dl>
3198: </div>
3199: <p>The files that are installed by pkgsrc are organized in a way that
3200: is similar to what you find in the <code class="filename">/usr</code> directory
3201: of the base system. But some details are different. This is because
3202: pkgsrc initially came from FreeBSD and had adopted its file system
3203: hierarchy. Later it was largely influenced by NetBSD. But no matter
3204: which operating system you are using pkgsrc with, you can expect the
3205: same layout for pkgsrc.</p>
3206: <p>There are mainly four root directories for pkgsrc, which are all
3207: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3208: When pkgsrc has been installed as root, the default locations
3209: are:</p>
3210: <pre class="programlisting">
3211: LOCALBASE= /usr/pkg
3212: PKG_SYSCONFBASE= /usr/pkg/etc
3213: VARBASE= /var
3214: PKG_DBDIR= /var/db/pkg
3215: </pre>
3216: <p>In unprivileged mode (when pkgsrc has been installed as any other
3217: user), the default locations are:</p>
3218: <pre class="programlisting">
3219: LOCALBASE= ${HOME}/pkg
3220: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3221: VARBASE= ${HOME}/pkg/var
3222: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
3223: </pre>
3224: <p>What these four directories are for, and what they look like is
3225: explained below.</p>
3226: <div class="itemizedlist"><ul type="disc">
3227: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3228: <code class="filename">/usr</code> directory in the base system. It is the
3229: “<span class="quote">main</span>” directory where the files are installed and contains
3230: the well-known subdirectories like <code class="filename">bin</code>,
3231: <code class="filename">include</code>, <code class="filename">lib</code>,
3232: <code class="filename">share</code> and
3233: <code class="filename">sbin</code>.</p></li>
3234: <li><p><code class="varname">VARBASE</code> corresponds to
3235: <code class="filename">/var</code> in the base system. Some programs (especially
3236: games, network daemons) need write access to it during normal
3237: operation.</p></li>
3238: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3239: <code class="filename">/etc</code> in the base system. It contains configuration
1.4 rillig 3240: files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 3241: itself.</p></li>
3242: </ul></div>
3243: <div class="sect1" lang="en">
3244: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3245: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 3246: </h2></div></div></div>
3247: <p>The following directories exist in a typical pkgsrc installation
3248: in <code class="filename">${LOCALBASE}</code>.</p>
3249: <div class="variablelist"><dl>
3250: <dt><span class="term"><code class="filename">bin</code></span></dt>
3251: <dd><p>Contains executable programs that are intended to be
3252: directly used by the end user.</p></dd>
3253: <dt><span class="term"><code class="filename">emul</code></span></dt>
3254: <dd><p>Contains files for the emulation layers of various other
3255: operating systems, especially for
3256: NetBSD.</p></dd>
3257: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3258: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3259: <dd><p>Contains
3260: the configuration files.</p></dd>
3261: <dt><span class="term"><code class="filename">include</code></span></dt>
3262: <dd><p>Contains headers for the C and C++ programming
3263: languages.</p></dd>
3264: <dt><span class="term"><code class="filename">info</code></span></dt>
3265: <dd><p>Contains GNU info files of various
3266: packages.</p></dd>
3267: <dt><span class="term"><code class="filename">lib</code></span></dt>
3268: <dd><p>Contains shared and static
3269: libraries.</p></dd>
3270: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3271: <dd><p>Contains data files that don't change after
3272: installation. Other data files belong into
3273: <code class="filename">${VARBASE}</code>.</p></dd>
3274: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3275: <dd><p>Contains programs that are not intended to be used by
3276: end users, such as helper programs or network
3277: daemons.</p></dd>
3278: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3279: <dd><p>Contains programs that are intended to be executed as
3280: CGI scripts by a web server.</p></dd>
3281: <dt><span class="term"><code class="filename">man</code> (the usual value of
3282: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3283: <dd><p>Contains brief
3284: documentation in form of manual pages.</p></dd>
3285: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3286: <dd><p>Contains programs that are intended to be used only by
3287: the super-user.</p></dd>
3288: <dt><span class="term"><code class="filename">share</code></span></dt>
3289: <dd><p>Contains platform-independent data files that don't
3290: change after installation.</p></dd>
3291: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3292: <dd><p>Contains documentation files provided by the
3293: packages.</p></dd>
3294: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3295: <dd><p>Contains example files provided by the packages. Among
3296: others, the original configuration files are saved here and copied to
3297: <code class="filename">${PKG_SYSCONFDIR}</code> during
3298: installation.</p></dd>
3299: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3300: <dd><p>Contains the original files for rc.d
3301: scripts.</p></dd>
3302: <dt><span class="term"><code class="filename">var</code> (the usual location of
3303: <code class="filename">${VARBASE}</code>)</span></dt>
3304: <dd><p>Contains files
3305: that may be modified after
3306: installation.</p></dd>
3307: </dl></div>
3308: </div>
3309: <div class="sect1" lang="en">
3310: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3311: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 3312: </h2></div></div></div>
3313: <div class="variablelist"><dl>
3314: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3315: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3316: <dd><p>Contains
3317: information about the currently installed
3318: packages.</p></dd>
3319: <dt><span class="term"><code class="filename">games</code></span></dt>
3320: <dd><p>Contains highscore
3321: files.</p></dd>
3322: <dt><span class="term"><code class="filename">log</code></span></dt>
3323: <dd><p>Contains log files.</p></dd>
3324: <dt><span class="term"><code class="filename">run</code></span></dt>
3325: <dd><p>Contains informational files about daemons that are
3326: currently running.</p></dd>
3327: </dl></div>
3328: </div>
3329: </div>
3330: <div class="chapter" lang="en">
3331: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3332: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 3333: <div class="toc">
3334: <p><b>Table of Contents</b></p>
3335: <dl>
1.6 rillig 3336: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3337: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3338: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3339: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3340: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3341: <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>
3342: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
3343: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
3344: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
3345: <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 3346: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 3347: <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>
3348: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3349: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3350: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
3351: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3352: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
3353: <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 3354: </dl>
3355: </div>
3356: <p>This section contains hints, tips & tricks on special things in
3357: pkgsrc that we didn't find a better place for in the previous chapters, and
3358: it contains items for both pkgsrc users and developers.</p>
3359: <div class="sect1" lang="en">
3360: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3361: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 3362: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3363: <div class="itemizedlist"><ul type="disc">
1.4 rillig 3364: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 3365: This is a general purpose list for most issues regarding
3366: pkgsrc, regardless of platform, e.g. soliciting user help
3367: for pkgsrc configuration, unexpected build failures, using
3368: particular packages, upgrading pkgsrc installations,
3369: questions regarding the pkgsrc release branches, etc. General announcements or
3370: proposals for changes that impact the pkgsrc user community,
3371: e.g. major infrastructure changes, new features, package
3372: removals, etc., may also be posted.</p></li>
1.4 rillig 3373: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 3374: A list where the results of pkgsrc bulk builds are sent and
3375: discussed.</p></li>
1.4 rillig 3376: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 3377: This list is for those who are interested in getting a
3378: commit message for every change committed to pkgsrc. It is
3379: also available in digest form, meaning one daily message
3380: containing all commit messages for changes to the package
3381: source tree in that 24 hour period.</p></li>
3382: </ul></div>
3383: <p>To subscribe, do:</p>
3384: <pre class="programlisting">
3385: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3386: </pre>
3387: <p>Archives for all these mailing lists are available from
3388: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3389: </div>
3390: <div class="sect1" lang="en">
3391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3392: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 3393: <p>Pkgviews is tightly integrated with buildlink. You can find a
3394: pkgviews User's guide in
3395: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3396: </div>
3397: <div class="sect1" lang="en">
3398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3399: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 3400: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3401: a number of useful utilities for both users and developers of pkgsrc. This
3402: section attempts only to make the reader aware of the utilities and when
3403: they might be useful, and not to duplicate the documentation that comes
3404: with each package.</p>
3405: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
3406: <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>:
3407: Symlinks for use by buildlink.</p></li></ul></div>
3408: <p>OS tool augmentation (automatically installed when needed):</p>
3409: <div class="itemizedlist"><ul type="disc">
3410: <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>:
3411: Calculates various kinds of checksums (including SHA1).</p></li>
3412: <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>:
3413: Compatibility library for pkgsrc tools.</p></li>
3414: <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
3415: non-BSD systems due to lack of native mtree.</p></li>
3416: <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>:
3417: Up-to-date replacement for
3418: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3419: systems where pkg_install is not present.</p></li>
3420: </ul></div>
3421: <p>Utilities used by pkgsrc (not automatically installed):</p>
3422: <div class="itemizedlist"><ul type="disc">
3423: <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>:
3424: Create a binary package from an
3425: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3426: save the old package.</p></li>
3427: <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>:
3428: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3429: from multiple locations. It currently supports the following
3430: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
3431: <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
3432: packages someplace else (enabled by default).</p></li>
3433: <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
3434: best compiler flags to optimise code for your current CPU and
3435: compiler.</p></li>
3436: </ul></div>
3437: <p>Utilities for keeping track of installed packages, being up to date,
3438: etc:</p>
3439: <div class="itemizedlist"><ul type="disc">
3440: <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
3441: packages whose installed versions do not match the latest pkgsrc
3442: entries.</p></li>
3443: <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
3444: dependency graphs of packages, to aid in choosing a strategy for
3445: updating.</p></li>
3446: <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
3447: 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>
3448: <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
3449: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3450: does various checks on the complete pkgsrc system.</p></li>
3451: <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
3452: packages you have installed.</p></li>
3453: </ul></div>
3454: <p>Utilities for people maintaining or creating individual packages:</p>
3455: <div class="itemizedlist"><ul type="disc">
3456: <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
3457: making and maintaining patches for a package (includes pkgdiff,
3458: pkgvi, mkpatches, etc.).</p></li>
3459: <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>,
3460: <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
3461: converting to pkgsrc.</p></li>
3462: <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
3463: pkgsrc to a Solaris package.</p></li>
3464: </ul></div>
3465: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3466: utilities)</p>
3467: <div class="itemizedlist"><ul type="disc">
3468: <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
3469: packages in a chrooted area.</p></li>
3470: <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
3471: kernel version for chrooted cross builds.</p></li>
3472: </ul></div>
3473: </div>
3474: <div class="sect1" lang="en">
3475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3476: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3477: <p>If you want to use pkgsrc as non-root user, you can set some
3478: variables to make pkgsrc work under these conditions. At the very least,
3479: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3480: will turn on unprivileged mode and set multiple related variables to allow
3481: installation of packages as non-root.</p>
3482: <p>In case the defaults are not enough, you may want to tune some other
3483: variables used. For example, if the automatic user/group detection leads
3484: to incorrect values (or not the ones you would like to use), you can change
3485: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3486: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3487: <p>As regards bootstrapping, please note that the
3488: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3489: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
3490: use multiple default directories under <code class="filename">~/pkg</code> as the
3491: installation targets. These directories can be overridden by the
3492: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3493: that allow finer tuning of the tree layout.</p>
3494: </div>
3495: <div class="sect1" lang="en">
3496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3497: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3498: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3499: enable this feature by adding the option
3500: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.4 rillig 3501: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3502: distfile is found, pkgsrc will try to resume it.</p>
3503: <p>You can also
3504: use a different program than the default <a 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
3505: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3506: <code class="varname">FETCH_RESUME_ARGS</code> and
3507: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3508: values.</p>
3509: <p>For example, if you want to use
3510: <code class="filename">wget</code> to resume downloads, you'll have to use something
3511: like:</p>
3512: <pre class="programlisting">
3513: FETCH_CMD= wget
3514: FETCH_BEFORE_ARGS= --passive-ftp
3515: FETCH_RESUME_ARGS= -c
3516: FETCH_OUTPUT_ARGS= -O
3517: </pre>
3518: </div>
3519: <div class="sect1" lang="en">
3520: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3521: <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 3522: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3523: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3524: you will have to add the following line into
1.4 rillig 3525: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3526: <pre class="programlisting">
1.4 rillig 3527: X11_TYPE=modular
1.1 dsieger 3528: </pre>
3529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3530: <h3 class="title">Note</h3>
1.4 rillig 3531: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3532: </p>
1.1 dsieger 3533: </div>
3534: </div>
3535: <div class="sect1" lang="en">
3536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3537: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3538: <p>If you are sitting behind a firewall which does not allow direct
3539: connections to Internet hosts (i.e. non-NAT), you may specify the
3540: relevant proxy hosts. This is done using an environment variable in the
3541: form of a URL, e.g. in Amdahl, the machine
3542: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3543: port 80 as the proxy port number. So the proxy environment variables
3544: are:</p>
3545: <pre class="programlisting">
3546: ftp_proxy=ftp://orpheus.amdahl.com:80/
3547: http_proxy=http://orpheus.amdahl.com:80/
3548: </pre>
3549: </div>
3550: <div class="sect1" lang="en">
3551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3552: <a name="passive-ftp"></a>9.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1 dsieger 3553: <p>This depends on which utility is used to retrieve distfiles. From
3554: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3555: the first available command from the following list:</p>
3556: <div class="itemizedlist"><ul type="disc">
3557: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3558: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
3559: </ul></div>
3560: <p>On a default NetBSD installation, this will be
3561: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3562: connections first, and falls back to active connections if the server
3563: refuses to do passive. For the other tools, add the following to your
1.4 rillig 3564: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3565: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3566: <p>Having that option present will prevent
3567: <code class="filename">/usr/bin/ftp</code> from falling back to active
3568: transfers.</p>
3569: </div>
3570: <div class="sect1" lang="en">
3571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3572: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3573: <p>You would like to download all the distfiles in a single batch
3574: from work or university, where you can't run a <span><strong class="command">make
3575: fetch</strong></span>. There is an archive of distfiles on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
3576: but downloading the entire directory may not be appropriate.</p>
3577: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
3578: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3579: resulting list to your machine at work/school and use it there. If you
3580: don't have a NetBSD-compatible <a 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
3581: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3582: URL:</p>
3583: <p>At home:</p>
3584: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3585: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3586: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3587: <p>At work:</p>
3588: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3589: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3590: home.</p>
3591: <p>If you have a machine running NetBSD, and you want to get
3592: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3593: machine architecture), you can do so by using the above-mentioned
3594: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3595: directly by running:</p>
3596: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3597: <p>If you even decide to ignore
3598: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3599: by running:</p>
3600: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3601: </div>
3602: <div class="sect1" lang="en">
3603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3604: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 3605: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
3606: <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>
3607: package, you get the error from make that it doesn't know how to make
3608: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
3609: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3610: the NetBSD base distribution on your machine. It is recommended to do
3611: that to format man pages.</p>
3612: <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
3613: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.4 rillig 3614: environment or in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3615: </div>
3616: <div class="sect1" lang="en">
3617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3618: <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 3619: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3620: when you installed your NetBSD machine. Please get and install it, by
3621: extracting it in <code class="filename">/</code>:</p>
3622: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3623: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3624: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
3625: the one that corresponds to your release (determine via <span><strong class="command">uname
3626: -r</strong></span>).</p>
3627: </div>
3628: <div class="sect1" lang="en">
3629: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3630: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3631: <p>When installing packages as non-root user and using the just-in-time
3632: <a 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
3633: password for each required package installed. To avoid this, the sudo
3634: package can be used, which does password caching over a limited time. To
3635: use it, install sudo (either as binary package or from
3636: <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.4 rillig 3637: following into your <a href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3638: <span class="emphasis"><em>after</em></span> the definition of the
3639: <code class="varname">LOCALBASE</code> variable:</p>
3640: <pre class="programlisting">
3641: .if exists(${LOCALBASE}/bin/sudo)
3642: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3643: .endif
3644: </pre>
3645: </div>
3646: <div class="sect1" lang="en">
3647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3648: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3649: <p>As the system administrator, you can choose where configuration files
3650: are installed. The default settings make all these files go into
3651: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3652: be suboptimal depending on your expectations (e.g., a read-only,
3653: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3654: configuration of the provided packages).</p>
3655: <p>In order to change the defaults, you can modify the
3656: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.4 rillig 3657: <a href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3658: directory; some common examples include <code class="filename">/etc</code> or
3659: <code class="filename">/etc/pkg</code>.</p>
3660: <p>Furthermore, you can change this value on a per-package basis by
3661: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3662: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3663: package you would like to modify, that is, the contents of
3664: <code class="varname">PKGBASE</code>.</p>
3665: <p>Note that after changing these settings, you must rebuild and
3666: reinstall any affected packages.</p>
3667: </div>
3668: <div class="sect1" lang="en">
3669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3670: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3671: <p>Please be aware that there can often be bugs in third-party software,
3672: and some of these bugs can leave a machine vulnerable to exploitation by
3673: attackers. In an effort to lessen the exposure, the NetBSD packages team
3674: maintains a database of known-exploits to packages which have at one time
3675: been included in pkgsrc. The database can be downloaded automatically, and
3676: a security audit of all packages installed on a system can take place. To
3677: 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
3678: components:</p>
3679: <div class="orderedlist"><ol type="1">
3680: <li>
3681: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3682: download a list of the security vulnerabilities information. This list
3683: is kept up to date by the NetBSD security officer and the NetBSD
3684: packages team, and is distributed from the NetBSD ftp server:</p>
3685: <p><a 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>
3686: </li>
3687: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3688: current machine, checking each vulnerability which is known. If a
3689: vulnerable package is installed, it will be shown by output to stdout,
3690: including a description of the type of vulnerability, and a URL
3691: containing more information.</p></li>
3692: </ol></div>
3693: <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>
3694: package is strongly recommended! After
3695: “<span class="quote">audit-packages</span>” is installed, please read
3696: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3697: audit-packages</code></strong>.</p>
3698: <p>If this package is installed, pkgsrc builds will use it to
3699: perform a security check before building any package. See <a 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
3700: check.</p>
3701: </div>
3702: <div class="sect1" lang="en">
3703: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3704: <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 3705: <p>When you add your own preferences to the
3706: <code class="varname">CFLAGS</code> variable in your
1.4 rillig 3707: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3708: environment variables to the <code class="filename">./configure</code>
3709: scripts and to <a 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
3710: <code class="varname">CFLAGS</code> from the environment variable by
3711: overriding them in the <code class="filename">Makefile</code>s of their
3712: package.</p>
3713: <p>Currently there is no solution to this problem. If you
3714: really need the package to use your <code class="varname">CFLAGS</code>
3715: you should run <span><strong class="command">make patch</strong></span> in the package
3716: directory and then inspect any <code class="filename">Makefile</code> and
3717: <code class="filename">Makefile.in</code> for whether they define
3718: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3719: these lines. But be aware that some “<span class="quote">smart</span>”
3720: programmers write so bad code that it only works for the
3721: specific combination of <code class="varname">CFLAGS</code> they have
3722: chosen.</p>
3723: </div>
3724: <div class="sect1" lang="en">
3725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3726: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.1 dsieger 3727: <div class="procedure"><ol type="1">
3728: <li><p>Make sure that your copy of pkgsrc is consistent. A
3729: case that occurs often is that people only update pkgsrc in
3730: parts, because of performance reasons. Since pkgsrc is one large
3731: system, not a collection of many small systems, there are
3732: sometimes changes that only work when the whole pkgsrc tree is
3733: updated.</p></li>
3734: <li><p>Make sure that you don't have any CVS conflicts.
3735: Search for “<span class="quote"><<<<<<</span>” or
3736: “<span class="quote">>>>>>></span>” in all your pkgsrc
3737: files.</p></li>
3738: <li><p>Make sure that you don't have old copies of the packages
3739: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3740: verify this.</p></li>
3741: <li><p>If the problem still exists, write a mail to the
3742: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3743: </ol></div>
3744: </div>
3745: <div class="sect1" lang="en">
3746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3747: <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 3748: <p>You have modified a file from pkgsrc, and someone else has
3749: modified that same file afterwards in the CVS repository. Both changes
3750: are in the same region of the file, so when you updated pkgsrc, the
3751: <code class="literal">cvs</code> command marked the conflicting changes in the
3752: file. Because of these markers, the file is no longer a valid
3753: <code class="filename">Makefile</code>.</p>
3754: <p>Have a look at that file, and if you don't need your local changes
3755: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3756: -dP</strong></span> in that directory to download the current version.</p>
3757: </div>
3758: </div>
3759: </div>
3760: <div class="part" lang="en">
3761: <div class="titlepage"><div><div><h1 class="title">
3762: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
3763: <div class="partintro" lang="en">
3764: <div></div>
3765: <p>This part of the book deals with creating and
3766: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3767: guide on creating a new package. The remaining chapters are more
3768: like a reference manual for pkgsrc.</p>
3769: <div class="toc">
3770: <p><b>Table of Contents</b></p>
3771: <dl>
1.6 rillig 3772: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3773: <dd><dl>
1.6 rillig 3774: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3775: <dd><dl>
1.6 rillig 3776: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3777: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 3778: </dl></dd>
1.6 rillig 3779: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3780: <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>
3781: </dl></dd>
3782: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3783: <dd><dl>
3784: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3785: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
3786: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3787: <dd><dl>
3788: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3789: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3790: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3791: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3792: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3793: </dl></dd>
3794: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3795: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3796: <dd><dl>
3797: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3798: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3799: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3800: </dl></dd>
3801: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3802: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
3803: </dl></dd>
3804: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3805: <dd><dl>
3806: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
3807: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
3808: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3809: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3810: <dd><dl>
3811: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3812: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3813: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3814: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3815: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3816: </dl></dd>
3817: </dl></dd>
3818: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3819: <dd><dl>
3820: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
3821: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3822: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
3823: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3824: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
3825: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3826: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3827: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3828: </dl></dd>
3829: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3830: <dd><dl>
3831: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
3832: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3833: <dd><dl>
3834: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3835: <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>
3836: </dl></dd>
3837: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3838: <dd><dl>
3839: <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>
3840: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3841: </dl></dd>
3842: </dl></dd>
3843: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3844: <dd><dl>
3845: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3846: <dd><dl>
3847: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3848: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3849: </dl></dd>
3850: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3851: <dd><dl>
3852: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3853: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3854: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3855: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3856: </dl></dd>
3857: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3858: <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>
3859: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3860: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3861: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3862: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3863: <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>
3864: </dl></dd>
3865: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3866: <dd><dl>
3867: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3868: <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>
3869: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3870: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3871: </dl></dd>
3872: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3873: <dd><dl>
3874: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3875: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3876: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3877: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
3878: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3879: <dd><dl>
3880: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3881: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3882: </dl></dd>
3883: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3884: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3885: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3886: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3887: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3888: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3889: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3890: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3891: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3892: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3893: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3894: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3895: </dl></dd>
3896: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3897: <dd><dl>
3898: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3899: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3900: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3901: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3902: </dl></dd>
3903: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3904: <dd><dl>
3905: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3906: <dd><dl>
3907: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
3908: <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>
3909: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3910: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3911: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3912: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3913: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3914: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3915: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3916: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3917: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3918: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3919: </dl></dd>
3920: <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>
3921: <dd><dl>
3922: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3923: <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>
3924: </dl></dd>
3925: <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>
3926: <dd><dl>
3927: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3928: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3929: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3930: </dl></dd>
3931: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3932: <dd><dl>
3933: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3934: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3935: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3936: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3937: </dl></dd>
3938: <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>
3939: <dd><dl>
3940: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3941: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
3942: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3943: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3944: </dl></dd>
3945: <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>
3946: <dd><dl>
3947: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3948: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3949: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3950: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3951: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3952: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3953: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3954: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3955: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 3956: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
3957: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3958: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3959: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3960: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3961: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3962: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3963: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3964: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3965: emulation</a></span></dt>
1.6 rillig 3966: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3967: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3968: </dl></dd>
1.6 rillig 3969: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3970: </dl></dd>
1.6 rillig 3971: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3972: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3973: <dd><dl>
1.6 rillig 3974: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3975: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3976: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3977: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3978: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3979: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
3980: </dl></dd>
3981: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3982: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3983: <dd><dl>
3984: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3985: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3986: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3987: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3988: </dl></dd>
3989: </dl>
3990: </div>
3991: </div>
3992: <div class="chapter" lang="en">
3993: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3994: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3995: <div class="toc">
3996: <p><b>Table of Contents</b></p>
3997: <dl>
1.6 rillig 3998: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3999: <dd><dl>
1.6 rillig 4000: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
4001: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 4002: </dl></dd>
1.6 rillig 4003: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
4004: <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 4005: </dl>
4006: </div>
4007: <p>When you find a package that is not yet in pkgsrc, you
4008: most likely have a URL from where you can download the source
4009: code. Starting with this URL, creating a package involves only a
4010: few steps.</p>
4011: <div class="procedure"><ol type="1">
4012: <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>
4013: <li><p>Then, choose one of the top-level directories as the
4014: category in which you want to place your package. You can also create a
4015: directory of your own (maybe called <code class="filename">local</code>). In that
4016: category directory, create another directory for your package and change
4017: into it.</p></li>
4018: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
4019: you for a URL. Enter the URL of the distribution file (in most cases a
4020: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
4021: of your package are created automatically. The distribution file is
4022: extracted automatically to fill in some details in the
4023: <code class="filename">Makefile</code> that would otherwise have to be done
4024: manually.</p></li>
4025: <li>
4026: <p>Examine the extracted files to determine the dependencies of
4027: your package. Ideally, this is mentioned in some
4028: <code class="filename">README</code> file, but things may differ. For each of
4029: these dependencies, look where it exists in pkgsrc, and if there is a
4030: file called <code class="filename">buildlink3.mk</code> in that directory, add a
4031: line to your package <code class="filename">Makefile</code> which includes that
4032: file just before the last line. If the
4033: <code class="filename">buildlink3.mk</code> file does not exist, add a
4034: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
4035: version of the dependency and where it can be found in pkgsrc. This line
4036: should be placed in the third paragraph. If the dependency is only
4037: needed for building the package, but not when using it, use
4038: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
4039: Your package may then look like this:</p>
4040: <pre class="programlisting">
4041: [...]
4042:
4043: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
4044: DEPENDS+= screen-[0-9]*:../../misc/screen
4045: DEPENDS+= screen>=4.0:../../misc/screen
4046:
4047: [...]
4048:
4049: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
4050: .include "../../devel/glib2/buildlink3.mk"
4051: .include "../../mk/bsd.pkg.mk"
4052: </pre>
4053: </li>
4054: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
4055: to be done to make your package a “<span class="quote">good</span>” one. If you don't
4056: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
4057: --explain</strong></span> or <span><strong class="command">pkglint
4058: -e</strong></span>, which outputs additional
4059: explanations.</p></li>
4060: <li><p>In many cases the package is not yet ready to build. You can
1.6 rillig 4061: find instructions for the most common cases in the next section, <a 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 4062: over there, you can hopefully continue here.</p></li>
4063: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
4064: directory from the extracted files. Besides these files, a lot of cache
4065: files and other system information has been saved in the working
4066: directory, which may become wrong after you edited the
4067: <code class="filename">Makefile</code>.</p></li>
4068: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
1.6 rillig 4069: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.1 dsieger 4070: <li><p>When the package builds fine, the next step is to install
4071: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
4072: everything works.</p></li>
4073: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
4074: contains a list of the files that are installed by the package, is
4075: nearly empty. Run <span><strong class="command">bmake print-PLIST
4076: >PLIST</strong></span> to generate a probably correct list. Check
4077: the file using your preferred text editor to see if the list of
4078: files looks plausible.</p></li>
4079: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
4080: <code class="filename">PLIST</code> contains garbage or not.</p></li>
4081: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
4082: has been registered in the database of installed files, but with an
4083: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
4084: and <span><strong class="command">bmake install</strong></span> again. Now the package is
4085: registered with the list of files from
4086: <code class="filename">PLIST</code>.</p></li>
4087: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
4088: package from the set of installed files.</p></li>
4089: </ol></div>
4090: <div class="sect1" lang="en">
4091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4092: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.1 dsieger 4093: <div class="sect2" lang="en">
4094: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4095: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 4096: <p>Simple Perl modules are handled automatically by
4097: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4098: </div>
4099: <div class="sect2" lang="en">
4100: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4101: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1 dsieger 4102: <p>KDE applications should always include
4103: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4104: settings that are typical of KDE packages.</p>
4105: </div>
4106: </div>
4107: <div class="sect1" lang="en">
4108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4109: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.1 dsieger 4110: <div class="sect2" lang="en">
4111: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4112: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.1 dsieger 4113: <div class="sect3" lang="en">
4114: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4115: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 4116: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4117: that the “<span class="quote">nvu</span>” package has not yet been imported into
4118: pkgsrc. As the description says it has to do with the web, the obvious
4119: choice for the category is “<span class="quote">www</span>”.</p>
4120: <pre class="programlisting">
4121: <code class="prompt">$</code> mkdir www/nvu
4122: <code class="prompt">$</code> cd www/nvu
4123: </pre>
4124: <p>The web site says that the sources are available as a tar file, so
4125: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4126: <pre class="programlisting">
4127: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4128: </pre>
4129: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4130: below the <code class="varname">DISTNAME</code> line, as the package name should
4131: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4132: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4133: <code class="varname">COMMENT</code> fields. Then the package
4134: <code class="filename">Makefile</code> looked like that:</p>
4135: <pre class="programlisting">
4136: # $NetBSD$
4137: #
4138:
4139: DISTNAME= nvu-1.0-sources
4140: PKGNAME= nvu-1.0
4141: CATEGORIES= www
4142: MASTER_SITES= http://cvs.nvu.com/download/
4143: EXTRACT_SUFX= .tar.bz2
4144:
4145: MAINTAINER= rillig@NetBSD.org
4146: HOMEPAGE= http://cvs.nvu.com/
4147: COMMENT= Web Authoring System
4148:
4149: # url2pkg-marker (please do not remove this line.)
4150: .include "../../mk/bsd.pkg.mk"
4151: </pre>
4152: <p>Then, I quit the editor and watched pkgsrc downloading a large
4153: source archive:</p>
4154: <pre class="programlisting">
4155: url2pkg> Running "make makesum" ...
4156: => Required installed package digest>=20010302: digest-20060826 found
4157: => Fetching nvu-1.0-sources.tar.bz2
4158: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4159: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4160: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4161: url2pkg> Running "make extract" ...
4162: => Required installed package digest>=20010302: digest-20060826 found
4163: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4164: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4165: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4166: ===> Installing dependencies for nvu-1.0
4167: ===> Overriding tools for nvu-1.0
4168: ===> Extracting for nvu-1.0
4169: url2pkg> Adjusting the Makefile.
4170:
4171: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4172:
4173: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4174: </pre>
4175: </div>
4176: <div class="sect3" lang="en">
4177: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4178: <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 4179: <p>Now that the package has been extracted, let's see what's inside
4180: it. The package has a <code class="filename">README.txt</code>, but that only
4181: says something about mozilla, so it's probably useless for seeing what
4182: dependencies this package has. But since there is a GNU configure script
4183: in the package, let's hope that it will complain about everything it
4184: needs.</p>
4185: <pre class="programlisting">
4186: <code class="prompt">$</code> bmake
4187: => Required installed package digest>=20010302: digest-20060826 found
4188: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4189: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4190: ===> Patching for nvu-1.0
4191: ===> Creating toolchain wrappers for nvu-1.0
4192: ===> Configuring for nvu-1.0
4193: [...]
4194: configure: error: Perl 5.004 or higher is required.
4195: [...]
4196: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4197: [...]
4198: </pre>
4199: <p>That worked quite well. So I opened the package Makefile in my
4200: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4201: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4202: package have changed now, and since a perl wrapper is automatically
4203: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4204: from scratch.</p>
4205: <pre class="programlisting">
4206: <code class="prompt">$</code> bmake clean
4207: ===> Cleaning for nvu-1.0
4208: <code class="prompt">$</code> bmake
4209: [...]
4210: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4211: GNU Make. You will not be able to build Mozilla without GNU Make.
4212: [...]
4213: </pre>
4214: <p>So I added “<span class="quote">gmake</span>” to the
4215: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4216: <pre class="programlisting">
4217: [...]
4218: checking for GTK - version >= 1.2.0... no
4219: *** Could not run GTK test program, checking why...
4220: [...]
4221: </pre>
4222: <p>Now to the other dependencies. The first question is: Where is the
4223: GTK package hidden in pkgsrc?</p>
4224: <pre class="programlisting">
4225: <code class="prompt">$</code> echo ../../*/gtk*
4226: [many packages ...]
4227: <code class="prompt">$</code> echo ../../*/gtk
4228: ../../x11/gtk
4229: <code class="prompt">$</code> echo ../../*/gtk2
4230: ../../x11/gtk2
4231: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4232: ../../x11/gtk2/buildlink3.mk
4233: </pre>
4234: <p>The first try was definitely too broad. The second one had exactly
4235: one result, which is very good. But there is one pitfall with GNOME
4236: packages. Before GNOME 2 had been released, there were already many
4237: GNOME 1 packages in pkgsrc. To be able to continue to use these
4238: packages, the GNOME 2 packages were imported as separate packages, and
4239: their names usually have a “<span class="quote">2</span>” appended. So I checked
4240: whether this was the case here, and indeed it was.</p>
4241: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4242: file, adding the dependency is very easy. I just inserted an
4243: <code class="literal">.include</code> line before the last line of the package
4244: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4245: <pre class="programlisting">
4246: [...]
4247: .include "../../x11/gtk2/buildlink3.mk"
4248: .include "../../mk/bsd.pkg.mk
4249: </pre>
4250: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4251: was:</p>
4252: <pre class="programlisting">
4253: [...]
4254: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4255: checking for GTK - version >= 1.2.0... no
4256: *** Could not run GTK test program, checking why...
4257: *** The test program failed to compile or link. See the file config.log for the
4258: *** exact error that occured. This usually means GTK was incorrectly installed
4259: *** or that you have moved GTK since it was installed. In the latter case, you
4260: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4261: configure: error: Test for GTK failed.
4262: [...]
4263: </pre>
4264: <p>In this particular case, the assumption that “<span class="quote">every package
4265: prefers GNOME 2</span>” had been wrong. The first of the lines above
4266: told me that this package really wanted to have the GNOME 1 version of
4267: GTK. If the package had looked for GTK2, it would have looked for
4268: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4269: So I changed the <code class="literal">x11/gtk2</code> to
4270: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4271: and tried again.</p>
4272: <pre class="programlisting">
4273: [...]
4274: 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
4275: In file included from xpidl.c:42:
4276: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4277: In file included from xpidl.c:42:
4278: xpidl.h:132: error: parse error before "IDL_ns"
4279: [...]
4280: </pre>
4281: <p>The package still does not find all of its dependencies. Now the
4282: question is: Which package provides the
4283: <code class="filename">libIDL/IDL.h</code> header file?</p>
4284: <pre class="programlisting">
4285: <code class="prompt">$</code> echo ../../*/*idl*
4286: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4287: <code class="prompt">$</code> echo ../../*/*IDL*
4288: ../../net/libIDL
4289: </pre>
4290: <p>Let's take the one from the second try. So I included the
4291: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4292: again. But the error didn't change. After digging through some of the
4293: code, I concluded that the build process of the package was broken and
4294: couldn't have ever worked, but since the Mozilla source tree is quite
4295: large, I didn't want to fix it. So I added the following to the package
4296: <code class="filename">Makefile</code> and tried again:</p>
4297: <pre class="programlisting">
4298: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4299: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4300: </pre>
4301: <p>The latter line is needed because the package expects the library
4302: <code class="filename">libIDL.so</code>, but only
4303: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4304: wrapper to rewrite that on the fly.</p>
4305: <p>The next problem was related to a recent change of the FreeType
4306: 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>
4307: which patch files were relevant for this issue and copied them to the
4308: <code class="filename">patches</code> directory. Then I retried, fixed the
4309: patches so that they applied cleanly and retried again. This time,
4310: everything worked.</p>
4311: </div>
4312: <div class="sect3" lang="en">
4313: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4314: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 4315: <pre class="programlisting">
4316: <code class="prompt">$</code> bmake CHECK_FILES=no install
4317: [...]
4318: <code class="prompt">$</code> bmake print-PLIST >PLIST
4319: <code class="prompt">$</code> bmake deinstall
4320: <code class="prompt">$</code> bmake install
4321: </pre>
4322: </div>
4323: </div>
4324: </div>
4325: </div>
4326: <div class="chapter" lang="en">
4327: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4328: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 4329: <div class="toc">
4330: <p><b>Table of Contents</b></p>
4331: <dl>
1.6 rillig 4332: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4333: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
4334: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4335: <dd><dl>
4336: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4337: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4338: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4339: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4340: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4341: </dl></dd>
4342: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4343: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4344: <dd><dl>
4345: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4346: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4347: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 4348: </dl></dd>
1.6 rillig 4349: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4350: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 4351: </dl>
4352: </div>
4353: <p>Whenever you're preparing a package, there are a number of
4354: files involved which are described in the following
4355: sections.</p>
4356: <div class="sect1" lang="en">
4357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4358: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 4359: </h2></div></div></div>
4360: <p>Building, installation and creation of a binary package are all
4361: controlled by the package's <code class="filename">Makefile</code>.
4362: The <code class="filename">Makefile</code> describes various things about
4363: a package, for example from where to get it, how to configure,
4364: build, and install it.</p>
4365: <p>A package <code class="filename">Makefile</code> contains several
4366: sections that describe the package.</p>
4367: <p>In the first section there are the following variables, which
4368: should appear exactly in the order given here. The order and
4369: grouping of the variables is mostly historical and has no further
4370: meaning.</p>
4371: <div class="itemizedlist"><ul type="disc">
4372: <li><p><code class="varname">DISTNAME</code> is the basename of the
4373: distribution file to be downloaded from the package's
4374: website.</p></li>
4375: <li><p><code class="varname">PKGNAME</code> is the name of the
4376: package, as used by pkgsrc. You only need to provide it if
4377: <code class="varname">DISTNAME</code> (which is the default) is not a good
4378: name for the package in pkgsrc. Usually it is the pkgsrc
4379: directory name together with the version number. It must match the
4380: regular expression
4381: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4382: starts with a letter or digit, and contains only letters, digits,
4383: dashes, underscores, dots and plus signs.</p></li>
4384: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4385: the package file to create if the <code class="varname">PKGNAME</code>
4386: isn't unique on a SVR4 system. The default is
4387: <code class="varname">PKGNAME</code>, which may be shortened when you use
4388: <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
4389: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4390: does not produce an unique package name on a SVR4 system.
4391: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4392: characters.</p></li>
4393: <li>
4394: <p><code class="varname">CATEGORIES</code> is a list of categories
4395: which the package fits in. You can choose any of the top-level
4396: directories of pkgsrc for it.</p>
4397: <p>Currently the following values are available for
4398: <code class="varname">CATEGORIES</code>. If more than
4399: one is used, they need to be separated by spaces:</p>
4400: <pre class="programlisting">
4401: archivers cross geography meta-pkgs security
4402: audio databases graphics misc shells
4403: benchmarks devel ham multimedia sysutils
4404: biology editors inputmethod net textproc
4405: cad emulators lang news time
4406: chat finance mail parallel wm
4407: comms fonts math pkgtools www
4408: converters games mbone print x11
4409: </pre>
4410: </li>
4411: <li><p><code class="varname">MASTER_SITES</code>,
4412: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4413: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4414: and <code class="varname">DISTFILES</code> are discussed in detail in
1.6 rillig 4415: <a 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 4416: </ul></div>
4417: <p>The second section contains information about separately
4418: downloaded patches, if any.
4419: </p>
4420: <div class="itemizedlist"><ul type="disc">
4421: <li><p><code class="varname">PATCHFILES:</code>
4422: Name(s) of additional files that contain distribution patches.
4423: There is no default. pkgsrc will look for them at
4424: <code class="varname">PATCH_SITES</code>.
4425: They will automatically be uncompressed before patching if
4426: the names end with <code class="filename">.gz</code> or
4427: <code class="filename">.Z</code>.</p></li>
4428: <li><p><code class="varname">PATCH_SITES</code>:
4429: Primary location(s) for distribution patch files (see
4430: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4431: </ul></div>
4432: <p>The third section contains the following variables.
4433: </p>
4434: <div class="itemizedlist"><ul type="disc">
4435: <li><p><code class="varname">MAINTAINER</code> is the email address
4436: of the person who feels responsible for this package, and who is
4437: most likely to look at problems or questions regarding this
4438: package which have been reported with <a 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
4439: developers should contact the <code class="varname">MAINTAINER</code> before
4440: making major changes to the package. When packaging a new program,
4441: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4442: maintain the package for future updates, set it to
4443: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
4444: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
4445: find more information about the package.</p></li>
4446: <li><p><code class="varname">COMMENT</code> is a one-line
4447: description of the package (should not include the package
4448: name).</p></li>
4449: </ul></div>
4450: <p>Other variables that affect the build:
4451: </p>
4452: <div class="itemizedlist"><ul type="disc"><li>
4453: <p><code class="varname">WRKSRC</code>: The directory where the
4454: interesting distribution files of the package are found. The
4455: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4456: works for most packages.</p>
4457: <p>If a package doesn't create a subdirectory for itself
4458: (most GNU software does, for instance), but extracts itself in
4459: the current directory, you should set
4460: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4461: <p>If a package doesn't create a subdirectory with the
4462: name of <code class="varname">DISTNAME</code> but some different name,
4463: set <code class="varname">WRKSRC</code> to point to the proper name in
4464: <code class="filename">${WRKDIR}</code>, for example
4465: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4466: <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>
4467: <p>The name of the working directory created by pkgsrc is
4468: taken from the <code class="varname">WRKDIR_BASENAME</code>
4469: variable. By default, its value is
4470: <code class="filename">work</code>. If you want to use the same
4471: pkgsrc tree for building different kinds of binary packages,
4472: you can change the variable according to your needs. Two
4473: other variables handle common cases of setting
4474: <code class="varname">WRKDIR_BASENAME</code> individually. If
4475: <code class="varname">OBJHOSTNAME</code> is defined in
1.4 rillig 4476: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4477: the host's name is attached to the directory name. If
4478: <code class="varname">OBJMACHINE</code> is defined, the platform name
4479: is attached, which might look like
4480: <code class="filename">work.i386</code> or
4481: <code class="filename">work.sparc</code>.</p>
4482: </li></ul></div>
4483: <p>Please pay attention to the following gotchas:</p>
4484: <div class="itemizedlist"><ul type="disc">
4485: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
4486: installed in compressed form by the package. For packages using
4487: BSD-style makefiles which honor MANZ, there is
4488: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
4489: <li><p>Replace <code class="filename">/usr/local</code> with
4490: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4491: below).</p></li>
1.6 rillig 4492: <li><p>If the package installs any info files, see <a 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 4493: </ul></div>
4494: </div>
4495: <div class="sect1" lang="en">
4496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4497: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4498: </h2></div></div></div>
4499: <p>The <code class="filename">distinfo</code> file contains the message
4500: digest, or checksum, of each distfile needed for the package. This
4501: ensures that the distfiles retrieved from the Internet have not been
4502: corrupted during transfer or altered by a malign force to introduce
4503: a security hole. Due to recent rumor about weaknesses of digest
4504: algorithms, all distfiles are protected using both SHA1 and RMD160
4505: message digests, as well as the file size.</p>
4506: <p>The <code class="filename">distinfo</code> file also contains the
4507: checksums for all the patches found in the
1.6 rillig 4508: <code class="filename">patches</code> directory (see <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 4509: <p>To regenerate the <code class="filename">distinfo</code> file, use the
4510: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4511: command.</p>
4512: <p>Some packages have different sets of distfiles depending on
4513: 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
4514: <code class="filename">distinfo</code> file and care should be taken when
4515: upgrading such a package to ensure distfile information is not
4516: lost.</p>
4517: </div>
4518: <div class="sect1" lang="en">
4519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4520: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4521: <p>Many packages still don't work out-of-the box on the various
4522: platforms that are supported by pkgsrc. Therefore, a number of custom
4523: patch files are needed to make the package work. These patch files are
4524: found in the <code class="filename">patches/</code> directory.</p>
4525: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4526: applied to the files in <code class="varname">WRKSRC</code> directory after
4527: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4528: order</a>, so <code class="filename">patch-aa</code> is applied before
4529: <code class="filename">patch-ab</code>, etc.</p>
4530: <div class="sect2" lang="en">
4531: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4532: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4533: <p>The <code class="filename">patch-*</code> files should be in
4534: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
4535: problems. (To force patches to apply with fuzz you can set
4536: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4537: should contain only changes for a single file, and no file should be
4538: patched by more than one patch file. This helps to keep future
4539: modifications simple.</p>
4540: <p>Each patch file is structured as follows: In the first line,
4541: there is the RCS Id of the patch itself. The second line should be
4542: empty for aesthetic reasons. After that, there should be a comment for
4543: each change that the patch does. There are a number of standard
4544: cases:</p>
4545: <div class="itemizedlist"><ul type="disc">
4546: <li><p>Patches that replace the <code class="literal">==</code>
4547: operator for <a 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
4548: should contain a reference to , to avoid
4549: redundant explanations.</p></li>
4550: <li><p>Patches for commonly known vulnerabilities should
4551: mention the vulnerability ID (CAN, CVE).</p></li>
4552: <li><p>Patches that change source code should mention the
4553: platform and other environment (for example, the compiler) that the
4554: patch is needed for.</p></li>
4555: </ul></div>
4556: <p>In all other cases, the patch should be commented so that any
4557: developer who knows the code of the application can make some use of
4558: the patch. Special care should be taken for the upstream developers,
4559: since we generally want that they accept our patches, so we have less
4560: work in the future.</p>
4561: </div>
4562: <div class="sect2" lang="en">
4563: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4564: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4565: <p>One important thing to mention is to pay attention that no RCS
4566: IDs get stored in the patch files, as these will cause problems when
4567: later checked into the NetBSD CVS tree. Use the
4568: <span><strong class="command">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
4569: problems.</p>
4570: <p>For even more automation, we recommend using
4571: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4572: whole set of patches. You just have to backup files before you
4573: edit them to <code class="filename">filename.orig</code>, e.g. with
4574: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4575: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4576: you upgrade a package this way, you can easily compare the new
4577: set of patches with the previously existing one with
4578: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4579: or update from the <code class="filename">work/.newpatches</code>
4580: directory to <code class="filename">patches/</code>.</p>
4581: <p>When you have finished a package, remember to generate
4582: the checksums for the patch files by using the <span><strong class="command">make
1.6 rillig 4583: makepatchsum</strong></span> command, see <a href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.1 dsieger 4584: <p>When adding a patch that corrects a problem in the
4585: distfile (rather than e.g. enforcing pkgsrc's view of where
4586: man pages should go), send the patch as a bug report to the
4587: maintainer. This benefits non-pkgsrc users of the package,
4588: and usually makes it possible to remove the patch in future
4589: version.</p>
1.2 rillig 4590: <p>The file names of the patch files are usually of the form
4591: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1 dsieger 4592: </div>
4593: <div class="sect2" lang="en">
4594: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4595: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4596: <p>If you want to share patches between multiple packages
4597: in pkgsrc, e.g. because they use the same distfiles, set
4598: <code class="varname">PATCHDIR</code> to the path where the patch files
4599: can be found, e.g.:</p>
4600: <pre class="programlisting">
4601: PATCHDIR= ${.CURDIR}/../xemacs/patches
4602: </pre>
4603: <p>Patch files that are distributed by the author or other
4604: maintainers can be listed in
4605: <code class="varname">PATCHFILES</code>.</p>
4606: <p>If it is desired to store any patches that should not be
4607: committed into pkgsrc, they can be kept outside the pkgsrc
4608: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4609: directory tree there is expected to have the same
4610: “<span class="quote">category/package</span>” structure as pkgsrc, and
4611: patches are expected to be stored inside these dirs (also
4612: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4613: example, if you want to keep a private patch for
4614: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4615: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4616: files in the named directory are expected to be patch files,
4617: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4618: applied</em></span>.</p>
4619: </div>
4620: <div class="sect2" lang="en">
4621: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4622: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4623: <p>When fixing a portability issue in the code do not use
4624: preprocessor magic to check for the current operating system nor
4625: platform. Doing so hurts portability to other platforms because
4626: the OS-specific details are not abstracted appropriately.</p>
4627: <p>The general rule to follow is: instead of checking for the
4628: operating system the application is being built on, check for the
4629: specific <span class="emphasis"><em>features</em></span> you need. For example,
4630: instead of assuming that kqueue is available under NetBSD and
4631: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.6 rillig 4632: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4633: yes, this generally involves patching the
4634: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4635: that prevents some OSes from adopting interfaces from other OSes
4636: (e.g. Linux implementing kqueue), something that the above checks
4637: cannot take into account.</p>
4638: <p>Of course, checking for features generally involves more
4639: work on the developer's side, but the resulting changes are
4640: cleaner and there are chances they will work on many other
4641: platforms. Not to mention that there are higher chances of being
4642: later integrated into the mainstream sources. Remember:
4643: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4644: <p>Some typical examples:</p>
4645: <div class="table">
1.6 rillig 4646: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4647: <div class="table-contents"><table summary="Patching examples" border="1">
4648: <colgroup>
4649: <col>
4650: <col>
4651: <col>
4652: </colgroup>
4653: <thead><tr>
4654: <th>Where</th>
4655: <th>Incorrect</th>
4656: <th>Correct</th>
4657: </tr></thead>
4658: <tbody>
4659: <tr>
4660: <td>configure script</td>
4661: <td>
4662: <pre class="programlisting">
4663: case ${target_os} in
4664: netbsd*) have_kvm=yes ;;
4665: *) have_kvm=no ;;
4666: esac
4667: </pre>
4668: </td>
4669: <td>
4670: <pre class="programlisting">
4671: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4672: </pre>
4673: </td>
4674: </tr>
4675: <tr>
4676: <td>C source file</td>
4677: <td>
4678: <pre class="programlisting">
4679: #if defined(__NetBSD__)
4680: # include <sys/event.h>
4681: #endif
4682: </pre>
4683: </td>
4684: <td>
4685: <pre class="programlisting">
4686: #if defined(HAVE_SYS_EVENT_H)
4687: # include <sys/event.h>
4688: #endif
4689: </pre>
4690: </td>
4691: </tr>
4692: <tr>
4693: <td>C source file</td>
4694: <td>
4695: <pre class="programlisting">
4696: int
4697: monitor_file(...)
4698: {
4699: #if defined(__NetBSD__)
4700: int fd = kqueue();
4701: ...
4702: #else
4703: ...
4704: #endif
4705: }
4706: </pre>
4707: </td>
4708: <td>
4709: <pre class="programlisting">
4710: int
4711: monitor_file(...)
4712: {
4713: #if defined(HAVE_KQUEUE)
4714: int fd = kqueue();
4715: ...
4716: #else
4717: ...
4718: #endif
4719: }
4720: </pre>
4721: </td>
4722: </tr>
4723: </tbody>
4724: </table></div>
4725: </div>
4726: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
4727: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4728: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4729: 2</a>). It summarizes multiple details on how to make
4730: software easier to package; all the suggestions in it were
4731: collected from our experience in pkgsrc work, so they are possibly
4732: helpful when creating patches too.</p>
4733: </div>
4734: <div class="sect2" lang="en">
4735: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4736: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4737: <p>Always, always, <span class="strong"><strong>always</strong></span>
4738: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4739: improvements you do to a package to the mainstream developers.
4740: This is the only way to get their attention on portability issues
4741: and to ensure that future versions can be built out-of-the box on
4742: NetBSD. Furthermore, any user that gets newer distfiles will get
4743: the fixes straight from the packaged code.</p>
4744: <p>This generally involves cleaning up the patches
4745: (because sometimes the patches that are
4746: added to pkgsrc are quick hacks), filling bug reports in the
4747: appropriate trackers for the projects and working with the
4748: mainstream authors to accept your changes. It is
4749: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4750: the packages in pkgsrc are kept simple and thus further changes
4751: can be done without much hassle.</p>
4752: <p>Support the idea of free software!</p>
4753: </div>
4754: </div>
4755: <div class="sect1" lang="en">
4756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4757: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1 dsieger 4758: <div class="variablelist"><dl>
4759: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4760: <dd><p>A multi-line description of the piece of software. This should include
4761: any credits where they are due. Please bear in mind that others do not
4762: share your sense of humour (or spelling idiosyncrasies), and that others
4763: will read everything that you write here.</p></dd>
4764: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4765: <dd><p>This file governs the files that are installed on your
4766: system: all the binaries, manual pages, etc. There are other
4767: directives which may be entered in this file, to control the
4768: creation and deletion of directories, and the location of
1.6 rillig 4769: inserted files. See <a href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4770: information.</p></dd>
4771: </dl></div>
4772: </div>
4773: <div class="sect1" lang="en">
4774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4775: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1 dsieger 4776: <div class="sect2" lang="en">
4777: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4778: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1 dsieger 4779: <div class="variablelist"><dl>
4780: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4781: <dd><p>This shell script is invoked twice by <a 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>.
4782: First time after package extraction and before files are
4783: moved in place, the second time after the files to install
4784: are moved in place. This can be used to do any custom
4785: procedures not possible with @exec commands in
4786: <code class="filename">PLIST</code>. See <a 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
1.6 rillig 4787: <a 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 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 4788: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4789: <dd><p>This script is executed before and after any files are removed. It is
4790: this script's responsibility to clean up any additional messy details
4791: around the package's installation, since all pkg_delete knows is how to
4792: delete the files created in the original distribution.
4793: See <a 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>
4794: and <a 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>
4795: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4796: <dd>
4797: <p>This file is displayed after installation of the package.
4798: Useful for things like legal notices on almost-free
4799: software and hints for updating config files after
4800: installing modules for apache, PHP etc.
4801: Please note that you can modify variables in it easily by using
4802: <code class="varname">MESSAGE_SUBST</code> in the package's
4803: <code class="filename">Makefile</code>:</p>
4804: <pre class="programlisting">
4805: MESSAGE_SUBST+= SOMEVAR="somevalue"
4806: </pre>
4807: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
4808: <code class="filename">MESSAGE</code>. By default, substitution is
4809: performed for <code class="varname">PKGNAME</code>,
4810: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4811: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4812: <code class="varname">X11BASE</code>,
4813: <code class="varname">PKG_SYSCONFDIR</code>,
4814: <code class="varname">ROOT_GROUP</code>, and
4815: <code class="varname">ROOT_GROUP</code>.</p>
4816: <p>You can display a different or additional files by
4817: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4818: default is <code class="filename">MESSAGE</code>, if the file
4819: exists.</p>
4820: </dd>
4821: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4822: <dd><p>FIXME: There is no documentation on the
4823: alternatives framework.</p></dd>
4824: </dl></div>
4825: </div>
4826: <div class="sect2" lang="en">
4827: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4828: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1 dsieger 4829: <div class="variablelist"><dl>
4830: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4831: <dd><p>This file contains arbitrary things that could
4832: also go into a <code class="filename">Makefile</code>, but its purpose is
4833: to be used by more than one package. This file should only be
4834: used when the packages that will use the file are known in
4835: advance. For other purposes it is often better to write a
4836: <code class="filename">*.mk</code> file and give it a good name that
4837: describes what it does.</p></dd>
4838: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4839: <dd><p>This file contains the dependency information
1.6 rillig 4840: for the buildlink3 framework (see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1 dsieger 4841: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4842: <dd><p>This file contains workarounds for compiler bugs
4843: and similar things. It is included automatically by the pkgsrc
4844: infrastructure, so you don't need an extra
4845: <code class="literal">.include</code> line for
4846: it.</p></dd>
4847: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4848: <dd><p>This file contains the code for the
1.6 rillig 4849: package-specific options (see <a href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1 dsieger 4850: selected by the user. If a package has only one or two options,
4851: it is equally acceptable to put the code directly into the
4852: <code class="filename">Makefile</code>.</p></dd>
4853: </dl></div>
4854: </div>
4855: <div class="sect2" lang="en">
4856: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4857: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1 dsieger 4858: <div class="variablelist"><dl>
4859: <dt><span class="term"><code class="filename">README*</code></span></dt>
4860: <dd><p>These files do not take place in the creation of
4861: a package and thus are purely informative to the package
4862: developer.</p></dd>
4863: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4864: <dd><p>This file contains things that need to be done
4865: to make the package even
4866: better.</p></dd>
4867: </dl></div>
4868: </div>
4869: </div>
4870: <div class="sect1" lang="en">
4871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4872: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4873: </h2></div></div></div>
4874: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
4875: unpacked into the directory denoted by
4876: <code class="varname">WRKDIR</code>. It can be removed by running
4877: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4878: directory is also used to keep various timestamp files.
4879: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4880: The default is <code class="filename">${.CURDIR}/work</code>
4881: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4882: if <code class="varname">OBJMACHINE</code> is set.</p>
4883: </div>
4884: <div class="sect1" lang="en">
4885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4886: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4887: </h2></div></div></div>
4888: <p>If you have any files that you wish to be placed in the package prior
4889: to configuration or building, you could place these files here and use
4890: a <span><strong class="command">${CP}</strong></span> command in the
4891: “<span class="quote">pre-configure</span>” target to achieve
4892: this. Alternatively, you could simply diff the file against
4893: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4894: the creation of this file.</p>
4895: <p>If you want to share files in this way with other
4896: packages, set the <code class="varname">FILESDIR</code> variable to point
4897: to the other package's <code class="filename">files</code> directory,
4898: e.g.:</p>
4899: <pre class="programlisting">
4900: FILESDIR=${.CURDIR}/../xemacs/files
4901: </pre>
4902: </div>
4903: </div>
4904: <div class="chapter" lang="en">
4905: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4906: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4907: <div class="toc">
4908: <p><b>Table of Contents</b></p>
4909: <dl>
1.6 rillig 4910: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
4911: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
4912: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4913: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4914: <dd><dl>
4915: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4916: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4917: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4918: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4919: <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 4920: </dl></dd>
4921: </dl>
4922: </div>
4923: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4924: each of which forms a well-defined part of the pkgsrc system. Using
4925: the <a 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
4926: like pkgsrc requires some discipline to keep the code correct and
4927: understandable.</p>
4928: <p>The basic ingredients for <code class="filename">Makefile</code>
4929: programming are variables (which are actually macros) and shell
4930: commands. Among these shell commands may even be more complex ones
4931: like <a 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
4932: as intended it is necessary to quote all variables correctly when they
4933: are used.</p>
4934: <p>This chapter describes some patterns, that appear quite often in
4935: <code class="filename">Makefile</code>s, including the pitfalls that come along
4936: with them.</p>
4937: <div class="sect1" lang="en">
4938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4939: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.1 dsieger 4940: <div class="itemizedlist"><ul type="disc"><li>
4941: <p>When you are creating a file as a
4942: target of a rule, always write the data to a temporary file first
4943: and finally rename that file. Otherwise there might occur an error
4944: in the middle of generating the file, and when the user runs
4945: <a 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
4946: regenerated properly. Example:</p>
4947: <pre class="programlisting">
4948: wrong:
4949: @echo "line 1" > ${.TARGET}
4950: @echo "line 2" >> ${.TARGET}
4951: @false
4952:
4953: correct:
4954: @echo "line 1" > ${.TARGET}.tmp
4955: @echo "line 2" >> ${.TARGET}.tmp
4956: @false
4957: @mv ${.TARGET}.tmp ${.TARGET}
4958: </pre>
4959: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4960: <code class="filename">wrong</code> will exist, although there was an error
4961: message in the first run. On the other hand, running <span><strong class="command">make
4962: correct</strong></span> gives an error message twice, as expected.</p>
4963: <p>You might remember that <a 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
4964: <code class="literal">${.TARGET}</code> in case of error, but this only
4965: happens when it is interrupted, for example by pressing
4966: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4967: when one of the commands fails (like <a 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>
4968: </li></ul></div>
4969: </div>
4970: <div class="sect1" lang="en">
4971: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4972: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4973: <p><code class="filename">Makefile</code> variables contain strings that
4974: can be processed using the five operators ``='', ``+='', ``?='',
4975: ``:='', and ``!='', which are described in the <a 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
4976: page.</p>
4977: <p>When a variable's value is parsed from a
4978: <code class="filename">Makefile</code>, the hash character ``#'' and the
4979: backslash character ``\'' are handled specially. If a backslash is
4980: followed by a newline, any whitespace immediately in front of the
4981: backslash, the backslash, the newline, and any whitespace
4982: immediately behind the newline are replaced with a single space. A
4983: backslash character and an immediately following hash character are
4984: replaced with a single hash character. Otherwise, the backslash is
4985: passed as is. In a variable assignment, any hash character that is
4986: not preceded by a backslash starts a comment that continues upto the
4987: end of the logical line.</p>
4988: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4989: the only way to create a variable consisting of a single backslash
4990: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4991: <p>So far for defining variables. The other thing you can do with
4992: variables is evaluating them. A variable is evaluated when it is
4993: part of the right side of the ``:='' or the ``!='' operator, or
4994: directly before executing a shell command which the variable is part
4995: of. In all other cases, <a 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
4996: is, variables are not evaluated until there's no other way. The
4997: ``modifiers'' mentioned in the man page also evaluate the
4998: variable.</p>
4999: <p>Some of the modifiers split the string into words and then
5000: operate on the words, others operate on the string as a whole. When
5001: a string is split into words, it is split as you would expect
5002: it from <a 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.6 rillig 5003: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.1 dsieger 5004: loop does not follow the shell quoting rules but splits at sequences
5005: of whitespace.</p>
5006: <p>There are several types of variables that should be handled
5007: differently. Strings and two types of lists.</p>
5008: <div class="itemizedlist"><ul type="disc">
5009: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
5010: characters. Nevertheless, you should restrict yourself to only
5011: using printable characters. Examples are
5012: <code class="varname">PREFIX</code> and
5013: <code class="varname">COMMENT</code>.</p></li>
5014: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
5015: are never exported to any shell command. Their elements are
5016: separated by whitespace. Therefore, the elements themselves cannot
5017: have embedded whitespace. Any other characters are allowed.
5018: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
5019: Examples are <code class="varname">DEPENDS</code> and
5020: <code class="varname">BUILD_DEPENDS</code>.</p></li>
5021: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
5022: may be exported to a shell command. Their elements can contain any
5023: characters, including whitespace. That's why they cannot be used
5024: in <span><strong class="command">.for</strong></span> loops. Examples are
5025: <code class="varname">DISTFILES</code> and
5026: <code class="varname">MASTER_SITES</code>.</p></li>
5027: </ul></div>
5028: <div class="sect2" lang="en">
5029: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5030: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.1 dsieger 5031: <div class="itemizedlist"><ul type="disc">
5032: <li><p>All variable names starting with an underscore
5033: are reserved for use by the pkgsrc infrastructure. They shall
5034: not be used by package
5035: <code class="filename">Makefile</code>s.</p></li>
5036: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
5037: lowercase variable names for the iteration
5038: variables.</p></li>
5039: <li><p>All list variables should have a ``plural''
5040: name, e.g. <code class="varname">PKG_OPTIONS</code> or
5041: <code class="varname">DISTFILES</code>.</p></li>
5042: </ul></div>
5043: </div>
5044: </div>
5045: <div class="sect1" lang="en">
5046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5047: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 5048: <p>This section presents you with some code snippets you should
5049: use in your own code. If you don't find anything appropriate here,
5050: you should test your code and add it here.</p>
5051: <div class="sect2" lang="en">
5052: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5053: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 5054: <pre class="programlisting">
5055: STRING= foo * bar `date`
5056: INT_LIST= # empty
5057: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
5058: EXT_LIST= # empty
5059: ANOTHER_EXT_LIST= a=b c=d
5060:
5061: INT_LIST+= ${STRING} # 1
5062: INT_LIST+= ${ANOTHER_INT_LIST} # 2
5063: EXT_LIST+= ${STRING:Q} # 3
5064: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
5065: </pre>
5066: <p>When you add a string to an external list (example 3), it
5067: must be quoted. In all other cases, you must not add a quoting
5068: level. You must not merge internal and external lists, unless you
5069: are sure that all entries are correctly interpreted in both
5070: lists.</p>
5071: </div>
5072: <div class="sect2" lang="en">
5073: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5074: <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 5075: <pre class="programlisting">
5076: EXT_LIST= # empty
5077: .for i in ${INT_LIST}
5078: EXT_LIST+= ${i:Q}""
5079: .endfor
5080: </pre>
5081: <p>This code converts the internal list
5082: <code class="varname">INT_LIST</code> into the external list
5083: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5084: are unquoted they must be quoted here. The reason for appending
5085: <code class="varname">""</code> is explained below.</p>
5086: </div>
5087: <div class="sect2" lang="en">
5088: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5089: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 5090: <p>Sometimes you may want to print an arbitrary string. There
5091: are many ways to get it wrong and only few that can handle every
5092: nastiness.</p>
5093: <pre class="programlisting">
5094: STRING= foo bar < > * `date` $$HOME ' "
5095: EXT_LIST= string=${STRING:Q} x=second\ item
5096:
5097: all:
5098: echo ${STRING} # 1
5099: echo "${STRING}" # 2
5100: echo "${STRING:Q}" # 3
5101: echo ${STRING:Q} # 4
5102: echo x${STRING:Q} | sed 1s,.,, # 5
5103: printf "%s\\n" ${STRING:Q}"" # 6
5104: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
5105: </pre>
5106: <p>Example 1 leads to a syntax error in the shell, as the
5107: characters are just copied.</p>
5108: <p>Example 2 leads to a syntax error too, and if you leave out
5109: the last " character from <code class="varname">${STRING}</code>,
5110: <a 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
5111: variable would be evaluated, too.</p>
5112: <p>Example 3 outputs each space character preceded by a
5113: backslash (or not), depending on the implementation of the
5114: <a 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>
5115: <p>Example 4 handles correctly every string that does not start
5116: with a dash. In that case, the result depends on the
5117: implementation of the <a 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
5118: guarantee that your input does not start with a dash, this form is
5119: appropriate.</p>
5120: <p>Example 5 handles even the case of a leading dash
5121: correctly.</p>
5122: <p>Example 6 also works with every string and is the
5123: light-weight solution, since it does not involve a pipe, which has
5124: its own problems.</p>
5125: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5126: because the quoting has already been done when adding elements to
5127: the list.</p>
5128: <p>As internal lists shall not be passed to the shell, there is
5129: no example for it.</p>
5130: </div>
5131: <div class="sect2" lang="en">
5132: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5133: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 5134: <p>There are many possible sources of wrongly quoted variables.
5135: This section lists some of the commonly known ones.</p>
5136: <div class="itemizedlist"><ul type="disc">
5137: <li>
5138: <p>Whenever you use the value of a list, think
5139: about what happens to leading or trailing whitespace. If the
5140: list is a well-formed shell expression, you can apply the
5141: <code class="varname">:M*</code> modifier to strip leading and trailing
5142: whitespace from each word. The <code class="varname">:M</code> operator
5143: first splits its argument according to the rules of the shell,
5144: and then creates a new list consisting of all words that match
5145: the shell glob expression <code class="varname">*</code>, that is: all.
5146: One class of situations where this is needed is when adding a
5147: variable like <code class="varname">CPPFLAGS</code> to
5148: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5149: invokes other configure scripts, it strips the leading and
5150: trailing whitespace from the variable and then passes it to the
5151: other configure scripts. But these configure scripts expect the
5152: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5153: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5154: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5155: here is how we do it:</p>
5156: <pre class="programlisting">
5157: CPPFLAGS= # empty
5158: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5159: CPPFLAGS+= ${MY_CPPFLAGS}
5160:
5161: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5162:
5163: all:
5164: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5165: echo x${CONFIGURE_ARGS}x # properly trimmed
5166: </pre>
5167: </li>
5168: <li><p>The example above contains one bug: The
5169: <code class="varname">${PREFIX}</code> is a properly quoted shell
5170: expression, but there is the C compiler after it, which also
5171: expects a properly quoted string (this time in C syntax). The
5172: version above is therefore only correct if
5173: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5174: or double quotes. If you want to allow these, you have to add
5175: another layer of quoting to each variable that is used as a C
5176: string literal. You cannot use the <code class="varname">:Q</code>
5177: operator for it, as this operator only works for the
5178: shell.</p></li>
5179: <li>
5180: <p>Whenever a variable can be empty, the
5181: <code class="varname">:Q</code> operator can have surprising results. Here
5182: are two completely different cases which can be solved with the
5183: same trick.</p>
5184: <pre class="programlisting">
5185: EMPTY= # empty
5186: empty_test:
5187: for i in a ${EMPTY:Q} c; do \
5188: echo "$$i"; \
5189: done
5190:
5191: for_test:
5192: .for i in a:\ a:\test.txt
5193: echo ${i:Q}
5194: echo "foo"
5195: .endfor
5196: </pre>
5197: <p>The first example will only print two of the three lines
5198: we might have expected. This is because
5199: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5200: the shell cannot see. The workaround is to write
5201: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5202: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5203: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5204: <p>The second example will only print three lines instead of
5205: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5206: This is because the backslash of the value
5207: <code class="varname">a:\</code> is interpreted as a line-continuation by
5208: <a 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
5209: <a 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
5210: <code class="varname">${i:Q}""</code>.</p>
5211: </li>
5212: </ul></div>
5213: </div>
5214: <div class="sect2" lang="en">
5215: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5216: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 5217: <p>The pkgsrc bmake program does not handle the following
5218: assignment correctly. In case <code class="varname">_othervar_</code>
5219: contains a ``-'' character, one of the closing braces is included
5220: in <code class="varname">${VAR}</code> after this code executes.</p>
5221: <pre class="programlisting">
5222: VAR:= ${VAR:N${_othervar_:C/-//}}
5223: </pre>
5224: <p>For a more complex code snippet and a workaround, see the
5225: 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
5226: <code class="varname">bug1</code>.</p>
5227: </div>
5228: </div>
5229: </div>
5230: <div class="chapter" lang="en">
5231: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5232: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 5233: <div class="toc">
5234: <p><b>Table of Contents</b></p>
5235: <dl>
1.6 rillig 5236: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
5237: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5238: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
5239: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5240: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
5241: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5242: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5243: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 5244: </dl>
5245: </div>
5246: <p>The <code class="filename">PLIST</code> file contains a package's
5247: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5248: the package (relative to the <code class="filename">${PREFIX}</code>
5249: directory it's been installed in) plus some additional statements
5250: - see the <a 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.
5251: This chapter addresses some issues that need attention when
5252: dealing with the <code class="filename">PLIST</code> file (or files, see
5253: below!).</p>
5254: <div class="sect1" lang="en">
5255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5256: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 5257: <p>Be sure to add a RCS ID line as the first thing in any
5258: <code class="filename">PLIST</code> file you write:</p>
5259: <pre class="programlisting">
5260: @comment $NetBSD$
5261: </pre>
5262: </div>
5263: <div class="sect1" lang="en">
5264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5265: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.1 dsieger 5266: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
5267: to output a PLIST that matches any new files since the package
1.6 rillig 5268: was extracted. See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.1 dsieger 5269: more information on this target.</p>
5270: </div>
5271: <div class="sect1" lang="en">
5272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5273: <a name="print-PLIST"></a>13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
1.1 dsieger 5274: </h2></div></div></div>
5275: <p>If you have used any of the *-dirs packages, as explained in
1.6 rillig 5276: <a href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
1.1 dsieger 5277: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5278: <code class="varname">@comment</code>s instead of real
5279: <code class="varname">@dirrm</code> lines. You can also do this for
5280: specific directories and files, so that the results of that
5281: command are very close to reality. This helps <span class="emphasis"><em>a
5282: lot</em></span> during the update of packages.</p>
5283: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5284: of AWK patterns and actions that are used to filter the output of
5285: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5286: scripting you like to it, but be careful with quoting.</p>
5287: <p>For example, to get all files inside the
5288: <code class="filename">libdata/foo</code> directory removed from the
5289: resulting PLIST:</p>
5290: <pre class="programlisting">
5291: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5292: </pre>
5293: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5294: to a specific (shared) directory converted to
5295: <code class="varname">@comment</code>s:</p>
5296: <pre class="programlisting">
5297: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5298: </pre>
5299: </div>
5300: <div class="sect1" lang="en">
5301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5302: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 5303: <p>A number of variables are substituted automatically in
5304: PLISTs when a package is installed on a system. This includes the
5305: following variables:</p>
5306: <div class="variablelist"><dl>
5307: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5308: <dd>
5309: <p>Some packages like emacs and perl embed information
5310: about which architecture they were built on into the
5311: pathnames where they install their files. To handle this
5312: case, PLIST will be preprocessed before actually used, and
5313: the symbol
5314: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5315: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5316: same is done if the string
5317: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5318: PLIST somewhere - use this on packages that have GNU
5319: autoconf-created configure scripts.</p>
5320: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5321: <h3 class="title">Legacy note</h3>
5322: <p>There used to be a symbol
5323: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5324: was replaced by the output of <span><strong class="command">uname
5325: -m</strong></span>, but that's no longer supported and has
5326: been removed.</p>
5327: </div>
5328: </dd>
5329: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5330: <dd>
5331: <p>Some packages want to embed the OS name and version
5332: into some paths. To do this, use these variables in the
5333: <code class="filename">PLIST</code>:
5334: </p>
5335: <div class="itemizedlist"><ul type="disc">
5336: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5337: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5338: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5339: </ul></div>
5340: </dd>
5341: </dl></div>
5342: <p>For a complete list of values which are replaced by
5343: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5344: search for <code class="varname">PLIST_SUBST</code>).</p>
5345: <p>If you want to change other variables not listed above, you
5346: can add variables and their expansions to this variable in the
1.6 rillig 5347: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.1 dsieger 5348: <pre class="programlisting">
5349: PLIST_SUBST+= SOMEVAR="somevalue"
5350: </pre>
5351: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
5352: in the <code class="filename">PLIST</code> with
5353: “<span class="quote">somevalue</span>”.</p>
5354: </div>
5355: <div class="sect1" lang="en">
5356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5357: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5358: <p>Man pages should be installed in compressed form if
5359: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5360: and uncompressed otherwise. To handle this in the
5361: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5362: appended/removed automatically for man pages according to
5363: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5364: or not, see above for details. This modification of the
5365: <code class="filename">PLIST</code> file is done on a copy of it, not
5366: <code class="filename">PLIST</code> itself.</p>
5367: </div>
5368: <div class="sect1" lang="en">
5369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5370: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5371: </h2></div></div></div>
5372: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5373: in generating the binary package, set the variable
5374: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5375: The files are later concatenated using <a 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
5376: important. The default for <code class="varname">PLIST_SRC</code> is
5377: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5378: </div>
5379: <div class="sect1" lang="en">
5380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5381: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5382: <p>Some packages decide to install a different set of files based on
5383: the operating system being used. These differences can be
5384: automatically handled by using the following files:</p>
5385: <div class="itemizedlist"><ul type="disc">
5386: <li><p><code class="filename">PLIST.common</code></p></li>
5387: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5388: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5389: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5390: <li><p><code class="filename">PLIST.common_end</code></p></li>
5391: </ul></div>
5392: </div>
5393: <div class="sect1" lang="en">
5394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5395: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.1 dsieger 5396: <p>A “<span class="quote">shared directory</span>” is a directory where
5397: multiple (and unrelated) packages install files. These
5398: directories are problematic because you have to add special tricks
5399: in the PLIST to conditionally remove them, or have some
5400: centralized package handle them.</p>
5401: <p>Within pkgsrc, you'll find both approaches. If a directory
5402: is shared by a few unrelated packages, it's often not worth to add
5403: an extra package to remove it. Therefore, one simply does:</p>
5404: <pre class="programlisting">
5405: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5406: </pre>
5407: <p>in the PLISTs of all affected packages, instead of the
5408: regular "@dirrm" line.</p>
5409: <p>However, if the directory is shared across many packages, two
5410: different solutions are available:</p>
5411: <div class="orderedlist"><ol type="1">
5412: <li><p>If the packages have a common dependency, the directory
5413: can be removed in that. For example, see
5414: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
5415: removes the shared directory
5416: <code class="filename">share/omf</code>.</p></li>
5417: <li><p>If the packages using the directory are not related at
5418: all (they have no common dependencies), a *-dirs package is
5419: used.</p></li>
5420: </ol></div>
5421: <p>From now on, we'll discuss the second solution. To get an
5422: idea of the *-dirs packages available, issue:</p>
5423: <pre class="programlisting">
5424: <code class="prompt">%</code> cd .../pkgsrc
5425: <code class="prompt">%</code> ls -d */*-dirs
5426: </pre>
5427: <p>Their use from other packages is very simple. The
5428: <code class="varname">USE_DIRS</code> variable takes a list of package names
5429: (without the “<span class="quote">-dirs</span>” part) together with the required
5430: version number (always pick the latest one when writing new
5431: packages).</p>
5432: <p>For example, if a package installs files under
5433: <code class="filename">share/applications</code>, it should have the
5434: following line in it:</p>
5435: <pre class="programlisting">
5436: USE_DIRS+= xdg-1.1
5437: </pre>
5438: <p>After regenerating the PLIST using <span><strong class="command">make
5439: print-PLIST</strong></span>, you should get the right (commented out)
5440: lines.</p>
5441: <p>Note that even if your package is using
5442: <code class="filename">$X11BASE</code>, it must not depend on the
5443: *-x11-dirs packages. Just specify the name without that part and
5444: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5445: care of it.</p>
5446: </div>
5447: </div>
5448: <div class="chapter" lang="en">
5449: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5450: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5451: <div class="toc">
5452: <p><b>Table of Contents</b></p>
5453: <dl>
1.6 rillig 5454: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
5455: <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 5456: <dd><dl>
1.6 rillig 5457: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5458: <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 5459: </dl></dd>
1.6 rillig 5460: <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 5461: <dd><dl>
1.6 rillig 5462: <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>
5463: <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 5464: </dl></dd>
5465: </dl>
5466: </div>
5467: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5468: are seen by a package's configure and build processes. This is implemented
5469: in a two step process:</p>
5470: <div class="orderedlist"><ol type="1">
5471: <li><p>Symlink headers and libraries for dependencies into
5472: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5473: of <code class="varname">WRKDIR</code>.</p></li>
5474: <li><p>Create wrapper scripts that are used in place of the normal compiler
5475: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5476: <code class="option">-L${LOCALBASE}/lib</code> into references to
5477: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5478: native compiler on some operating systems look like GCC, so that
5479: packages that expect GCC won't require modifications to build with
5480: those native compilers.</p></li>
5481: </ol></div>
5482: <p>This normalizes the environment in which a package is built so that the
5483: package may be built consistently despite what other software may be
5484: installed. Please note that the normal system header and library paths,
5485: e.g. <code class="filename">/usr/include</code>,
5486: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5487: designed to insulate the package build from non-system-supplied
5488: software.</p>
5489: <div class="sect1" lang="en">
5490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5491: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5492: <p>The process of converting packages to use the buildlink3
5493: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5494: The things to keep in mind are:</p>
5495: <div class="orderedlist"><ol type="1">
5496: <li><p>Ensure that the build always calls the wrapper scripts
5497: instead of the actual toolchain. Some packages are tricky,
5498: and the only way to know for sure is the check
5499: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5500: wrappers are being invoked.</p></li>
5501: <li><p>Don't override <code class="varname">PREFIX</code> from within
5502: the package Makefile, e.g. Java VMs, standalone shells,
5503: etc., because the code to symlink files into
5504: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5505: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5506: </p></li>
5507: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5508: <code class="filename">buildlink3.mk</code> files that you list in a
5509: package's Makefile are added as dependencies for that package.
5510: </p></li>
5511: </ol></div>
5512: <p>If a dependency on a particular package is required for its libraries and
5513: headers, then we replace:</p>
5514: <pre class="programlisting">
5515: DEPENDS+= foo>=1.1.0:../../category/foo
5516: </pre>
5517: <p>with</p>
5518: <pre class="programlisting">
5519: .include "../../category/foo/buildlink3.mk"
5520: </pre>
5521: <p>The buildlink3.mk files usually define the required dependencies.
5522: If you need a newer version of the dependency when using buildlink3.mk
5523: files, then you can define it in your Makefile; for example:</p>
5524: <pre class="programlisting">
5525: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5526: .include "../../category/foo/buildlink3.mk"
5527: </pre>
5528: <p>There are several <code class="filename">buildlink3.mk</code>
5529: files in <code class="filename">pkgsrc/mk</code>
5530: that handle special package issues:</p>
5531: <div class="itemizedlist"><ul type="disc">
5532: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
5533: the native or a pkgsrc Berkeley DB implementation based on
5534: the values of <code class="varname">BDB_ACCEPTED</code> and
5535: <code class="varname">BDB_DEFAULT</code>.</p></li>
5536: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
5537: comes with neither Curses nor NCurses, this will take care
5538: 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>
5539: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
5540: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5541: adding a dependency on Heimdal or MIT-krb5 for packages that
5542: require a Kerberos 5 implementation.</p></li>
5543: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5544: system-provided Motif installation or adds a dependency on
5545: <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
5546: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5547: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5548: which Motif version will be used.</p></li>
5549: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
5550: variables that may be used by packages that use the
5551: Open Sound System (OSS) API.</p></li>
5552: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
5553: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
5554: the file for more information.</p></li>
5555: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
5556: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5557: 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>
5558: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
5559: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5560: library.</p></li>
5561: </ul></div>
5562: <p>The comments in those <code class="filename">buildlink3.mk</code>
5563: files provide a more complete
5564: description of how to use them properly.</p>
5565: </div>
5566: <div class="sect1" lang="en">
5567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5568: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5569: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5570: included by Makefiles to indicate the need to compile and link
5571: against header files and libraries provided by the package. A
5572: <code class="filename">buildlink3.mk</code> file should always provide
5573: enough information to add the correct type of dependency
5574: relationship and include any other
5575: <code class="filename">buildlink3.mk</code> files that it needs to find
5576: headers and libraries that it needs in turn.</p>
5577: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5578: 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>
5579: package is highly recommended. For most packages, the following
5580: command will generate a good starting point for
5581: <code class="filename">buildlink3.mk</code> files:</p>
5582: <pre class="screen">
5583: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5584: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5585: </pre>
5586: <div class="sect2" lang="en">
5587: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5588: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5589: <p>The following real-life example
5590: <code class="filename">buildlink3.mk</code> is taken
5591: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5592: <pre class="programlisting">
5593: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
5594:
5595: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5596: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
5597:
5598: .if ${BUILDLINK_DEPTH} == "+"
5599: BUILDLINK_DEPENDS+= tiff
5600: .endif
5601:
5602: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5603: BUILDLINK_PACKAGES+= tiff
5604:
5605: .if ${TIFF_BUILDLINK3_MK} == "+"
5606: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5607: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5608: .endif # TIFF_BUILDLINK3_MK
5609:
5610: .include "../../devel/zlib/buildlink3.mk"
5611: .include "../../graphics/jpeg/buildlink3.mk"
5612:
5613: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5614: </pre>
5615: <p>The header and footer manipulate
5616: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5617: <code class="filename">buildlink3.mk</code> files and is used to track
5618: at what depth we are including
5619: <code class="filename">buildlink3.mk</code> files.</p>
5620: <p>The first section controls if the dependency on
5621: <em class="replaceable"><code>pkg</code></em> is added.
5622: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5623: packages for which dependencies are added by
5624: buildlink3.</p>
5625: <p>The second section advises pkgsrc that the
5626: <code class="filename">buildlink3.mk</code> file for
5627: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5628: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5629: packages for which <code class="filename">buildlink3.mk</code> files
5630: have been included. It must <span class="emphasis"><em>always</em></span> be
5631: appended to within a <code class="filename">buildlink3.mk</code>
5632: file.</p>
5633: <p>The third section is protected from multiple inclusion
5634: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5635: added. Several important variables are set in the section:</p>
5636: <div class="itemizedlist"><ul type="disc">
5637: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5638: is the actual dependency recorded in the installed
5639: package; this should always be set using
5640: <span><strong class="command">+=</strong></span> to ensure that
5641: we're appending to any pre-existing list of values. This
5642: variable should be set to the first version of the
5643: package that had an API change.
5644: </p></li>
5645: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5646: is the location of the <em class="replaceable"><code>pkg</code></em>
5647: pkgsrc directory.</p></li>
5648: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5649: (not shown above) controls whether we use
5650: <code class="varname">BUILD_DEPENDS</code> or
5651: <code class="varname">DEPENDS</code> to add the dependency on
5652: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5653: selected by setting
5654: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5655: to “<span class="quote">build</span>”. By default, the full dependency is
5656: used.</p></li>
5657: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
5658: and
5659: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5660: (not shown above) are lists of subdirectories of
5661: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5662: to add to the header and library search paths. These
5663: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
5664: respectively.</p></li>
5665: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
5666: (not shown above) is the list of preprocessor flags to add
5667: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5668: configure and build phases. The “<span class="quote">-I</span>” option
5669: should be avoided and instead be handled using
5670: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5671: above.</p></li>
5672: </ul></div>
5673: <p>The following variables are all optionally defined within
5674: this second section (protected against multiple inclusion) and
5675: control which package files are symlinked into
5676: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5677: transformed during the symlinking:</p>
5678: <div class="itemizedlist"><ul type="disc">
5679: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
5680: (not shown above) is a shell glob pattern relative to
5681: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5682: to be symlinked into
5683: <code class="filename">${BUILDLINK_DIR}</code>,
5684: e.g. <code class="filename">include/*.h</code>.</p></li>
5685: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5686: (not shown above) is a shell pipeline that
5687: outputs to stdout a list of files relative to
5688: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5689: The resulting files are to be symlinked
5690: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5691: this takes the <code class="filename">+CONTENTS</code> of a
5692: <em class="replaceable"><code>pkg</code></em> and filters it through
5693: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5694: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5695: (not shown above) is a filter command that filters
5696: <code class="filename">+CONTENTS</code> input into a list of files
5697: relative to
5698: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5699: on stdout. By default for overwrite packages,
5700: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5701: outputs the contents of the <code class="filename">include</code>
5702: and <code class="filename">lib</code> directories in the package
5703: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5704: it outputs any libtool archives in
5705: <code class="filename">lib</code> directories.</p></li>
5706: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
5707: (not shown above) is a list of sed arguments used to
5708: transform the name of the source filename into a
5709: destination filename, e.g. <span><strong class="command">-e
5710: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5711: </ul></div>
5712: <p>The last section includes any
5713: <code class="filename">buildlink3.mk</code> needed for
5714: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5715: Including these <code class="filename">buildlink3.mk</code> files
5716: means that the headers and libraries for these
5717: dependencies are also symlinked into
5718: <code class="filename">${BUILDLINK_DIR}</code>
5719: whenever the <em class="replaceable"><code>pkg</code></em>
5720: <code class="filename">buildlink3.mk</code>
5721: file is included.</p>
5722: </div>
5723: <div class="sect2" lang="en">
5724: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5725: <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 5726: <p>The situation that requires increasing the dependency listed in
5727: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5728: after a package update is when the API or interface to the
5729: header files change.</p>
5730: <p>In this case,
5731: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5732: should be adjusted to require at least the new package
5733: version. In some cases, the packages that depend on this new
5734: version may need their <code class="varname">PKGREVISION</code>s
5735: increased and, if they have <code class="filename">buildlink3.mk</code>
5736: files, their
5737: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5738: adjusted, too. This is needed so pkgsrc will require the
5739: correct package dependency and not settle for an older one
5740: when building the source.</p>
5741: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5742: should be increased when the binary interface or sonames
5743: (major number of the library version) of any installed
5744: shared libraries change. This is needed so that binary
5745: packages made using it will require the correct package
5746: dependency and not settle for an older one which will not
5747: contain the necessary shared libraries.</p>
1.6 rillig 5748: <p>See <a href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.1 dsieger 5749: more information about dependencies on other packages,
5750: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
5751: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5752: <p>Please take careful consideration before adjusting
5753: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5754: or
5755: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5756: as we don't want to cause unneeded package deletions and
5757: rebuilds. In many cases, new versions of packages work just
5758: fine with older dependencies.</p>
5759: <p>Also it is not needed to set
5760: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5761: when it is identical to
5762: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5763: </div>
5764: </div>
5765: <div class="sect1" lang="en">
5766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5767: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5768: <p>Some packages in pkgsrc install headers and libraries that
5769: coincide with headers and libraries present in the base system.
5770: Aside from a <code class="filename">buildlink3.mk</code> file, these
5771: packages should also include a <code class="filename">builtin.mk</code>
5772: file that includes the necessary checks to decide whether using
5773: the built-in software or the pkgsrc software is
5774: appropriate.</p>
5775: <p>The only requirements of a builtin.mk file for
5776: <em class="replaceable"><code>pkg</code></em> are:</p>
5777: <div class="orderedlist"><ol type="1">
5778: <li><p>It should set
5779: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5780: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5781: after it is included.</p></li>
5782: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5783: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5784: which is already set before the
5785: <code class="filename">builtin.mk</code> file is included.</p></li>
5786: <li><p>It should be written to allow multiple inclusion. This
5787: is <span class="emphasis"><em>very</em></span> important and takes careful
5788: attention to <code class="filename">Makefile</code> coding.</p></li>
5789: </ol></div>
5790: <div class="sect2" lang="en">
5791: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5792: <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 5793: <p>The following is the recommended template for builtin.mk
5794: files:</p>
5795: <pre class="programlisting">
5796: .if !defined(IS_BUILTIN.foo)
5797: #
5798: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5799: # genuinely exists in the system or not.
5800: #
5801: IS_BUILTIN.foo?= no
5802:
5803: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5804: # version can be determined.
5805: #
5806: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5807: BUILTIN_PKG.foo?= foo-1.0
5808: . endif
5809: .endif # IS_BUILTIN.foo
5810:
5811: .if !defined(USE_BUILTIN.foo)
5812: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5813: . if defined(BUILTIN_PKG.foo)
5814: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5815: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5816: USE_BUILTIN.foo!= \
5817: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5818: && ${ECHO} "yes" || ${ECHO} "no"
5819: . endif
5820: . endfor
5821: . endif
5822: .endif # USE_BUILTIN.foo
5823:
5824: CHECK_BUILTIN.foo?= no
5825: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5826: #
5827: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5828: # "yes" or "no".
5829: #
5830: .endif # CHECK_BUILTIN.foo
5831: </pre>
5832: <p>The first section sets
5833: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5834: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5835: in the base system. This should not be a base system software
5836: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5837: it should only be “<span class="quote">yes</span>” if the actual package is
5838: included as part of the base system. This variable is only
5839: used internally within the <code class="filename">builtin.mk</code>
5840: file.</p>
5841: <p>The second section sets
5842: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5843: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5844: system if it exists (if
5845: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5846: is “<span class="quote">yes</span>”). This variable is only used internally
5847: within the <code class="filename">builtin.mk</code> file.</p>
5848: <p>The third section sets
5849: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5850: and is <span class="emphasis"><em>required</em></span> in all
5851: <code class="filename">builtin.mk</code> files. The code in this
5852: section must make the determination whether the built-in
5853: software is adequate to satisfy the dependencies listed in
5854: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5855: This is typically done by comparing
5856: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5857: against each of the dependencies in
5858: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5859: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5860: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5861: end of the <code class="filename">builtin.mk</code> file. Note that
5862: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5863: may be “<span class="quote">yes</span>” even if
5864: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5865: is “<span class="quote">no</span>” because we may make the determination
5866: that the built-in version of the software is similar enough to
5867: be used as a replacement.</p>
5868: <p>The last section is guarded by
5869: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5870: and includes code that uses the value of
5871: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5872: set in the previous section. This typically includes, e.g.,
5873: adding additional dependency restrictions and listing additional
5874: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5875: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5876: </div>
5877: <div class="sect2" lang="en">
5878: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5879: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5880: <p>When building packages, it's possible to choose whether to set
5881: a global preference for using either the built-in (native)
5882: version or the pkgsrc version of software to satisfy a
5883: dependency. This is controlled by setting
5884: <code class="varname">PREFER_PKGSRC</code> and
5885: <code class="varname">PREFER_NATIVE</code>. These variables take values
5886: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5887: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5888: use the pkgsrc versions of software, while
5889: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5890: built-in versions. Preferences are determined by the most
5891: specific instance of the package in either
5892: <code class="varname">PREFER_PKGSRC</code> or
5893: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5894: in neither or in both variables, then
5895: <code class="varname">PREFER_PKGSRC</code> has precedence over
5896: <code class="varname">PREFER_NATIVE</code>. For example, to require
5897: using pkgsrc versions of software for all but the most basic
5898: bits on a NetBSD system, you can set:</p>
5899: <pre class="programlisting">
5900: PREFER_PKGSRC= yes
5901: PREFER_NATIVE= getopt skey tcp_wrappers
5902: </pre>
5903: <p>A package <span class="emphasis"><em>must</em></span> have a
5904: <code class="filename">builtin.mk</code>
5905: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5906: otherwise it is simply ignored in that list.</p>
5907: </div>
5908: </div>
5909: </div>
5910: <div class="chapter" lang="en">
5911: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5912: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5913: <div class="toc">
5914: <p><b>Table of Contents</b></p>
5915: <dl>
1.6 rillig 5916: <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 5917: <dd><dl>
1.6 rillig 5918: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5919: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5920: </dl></dd>
1.6 rillig 5921: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5922: <dd><dl>
1.6 rillig 5923: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5924: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5925: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5926: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5927: </dl></dd>
5928: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5929: <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>
5930: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5931: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5932: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5933: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5934: <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 5935: </dl>
5936: </div>
5937: <p>This chapter describes the framework known as
5938: <code class="literal">pkginstall</code>, whose key features are:</p>
5939: <div class="itemizedlist"><ul type="disc">
5940: <li><p>Generic installation and manipulation of directories and files
5941: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5942: <li><p>Automatic handling of configuration files during installation,
5943: provided that packages are correctly designed.</p></li>
5944: <li><p>Generation and installation of system startup scripts.</p></li>
5945: <li><p>Registration of system users and groups.</p></li>
5946: <li><p>Registration of system shells.</p></li>
5947: <li><p>Automatic updating of fonts databases.</p></li>
5948: </ul></div>
5949: <p>The following sections inspect each of the above points in detail.</p>
5950: <p>You may be thinking that many of the things described here could be
5951: easily done with simple code in the package's post-installation target
5952: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5953: as the code in them is only executed when building from source. Machines
5954: using binary packages could not benefit from it at all (as the code itself
5955: could be unavailable). Therefore, the only way to achieve any of the items
5956: described above is by means of the installation scripts, which are
5957: automatically generated by pkginstall.</p>
5958: <div class="sect1" lang="en">
5959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5960: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5961: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5962: of files and directories that belong to a package. The names used in it
5963: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5964: which means that it cannot register files outside this directory (absolute
5965: path names are not allowed). Despite this restriction, some packages need
5966: to install files outside this location; e.g., under
5967: <code class="filename">${VARBASE}</code> or
5968: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5969: is to create such files during installation time by using
5970: installation scripts.</p>
5971: <p>The generic installation scripts are shell scripts that can
5972: contain arbitrary code. The list of scripts to execute is taken from
5973: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5974: <code class="filename">INSTALL</code>. A similar variable exists for package
5975: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5976: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5977: commands, so they have the potential to create and manage files
5978: anywhere in the file system.</p>
5979: <p>Using these general installation files is not recommended, but
5980: may be needed in some special cases. One reason for avoiding them is
5981: that the user has to trust the packager that there is no unwanted or
5982: simply erroneous code included in the installation script. Also,
5983: previously there were many similar scripts for the same functionality,
5984: and fixing a common error involved finding and changing all of
5985: them.</p>
5986: <p>The pkginstall framework offers another, standardized way. It
5987: provides generic scripts to abstract the manipulation of such files
5988: and directories based on variables set in the package's
5989: <code class="filename">Makefile</code>. The rest of this section describes
5990: these variables.</p>
5991: <div class="sect2" lang="en">
5992: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5993: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5994: <p>The following variables can be set to request the creation of
5995: directories anywhere in the file system:</p>
5996: <div class="itemizedlist"><ul type="disc">
5997: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5998: contain a list of directories that should be created and should attempt
5999: to be destroyed by the installation scripts. The difference between
6000: the two is that the latter prompts the administrator to remove any
6001: directories that may be left after deinstallation (because they were
6002: not empty), while the former does not.</p></li>
6003: <li>
6004: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6005: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6006: which directories should be created and should attempt to be destroyed
6007: by the installation scripts. Each tuple holds the following values,
6008: separated by spaces: the directory name, its owner, its group and its
6009: numerical mode. For example:</p>
6010: <pre class="programlisting">
6011: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
6012: </pre>
6013: <p>The difference between the two is exactly the same as their
6014: non-<code class="varname">PERMS</code> counterparts.</p>
6015: </li>
6016: </ul></div>
6017: </div>
6018: <div class="sect2" lang="en">
6019: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6020: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 6021: <p>Creating non-empty files outside the installation prefix is tricky
6022: because the <code class="filename">PLIST</code> forces all files to be inside it.
6023: To overcome this problem, the only solution is to extract the file in the
6024: known place (i.e., inside the installation prefix) and copy it to the
6025: appropriate location during installation (done by the installation scripts
6026: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6027: file</em></span> in the following paragraphs, which describe the variables
6028: that can be used to automatically and consistently handle files outside the
6029: installation prefix:</p>
6030: <div class="itemizedlist"><ul type="disc">
6031: <li>
6032: <p><code class="varname">CONF_FILES</code> and
6033: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
6034: During installation time, the master file is copied to the target one
6035: if and only if the latter does not exist. Upon deinstallation, the
6036: target file is removed provided that it was not modified by the
6037: installation.</p>
6038: <p>The difference between the two is that the latter prompts the
6039: administrator to remove any files that may be left after
6040: deinstallation (because they were not empty), while the former does
6041: not.</p>
6042: </li>
6043: <li>
6044: <p><code class="varname">CONF_FILES_PERMS</code> and
6045: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
6046: files as well as their target locations. For each of them, it also
6047: specifies their owner, their group and their numeric permissions, in
6048: this order. For example:</p>
6049: <pre class="programlisting">
6050: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
6051: </pre>
6052: <p>The difference between the two is exactly the same as their
6053: non-<code class="varname">PERMS</code> counterparts.</p>
6054: </li>
6055: </ul></div>
6056: </div>
6057: </div>
6058: <div class="sect1" lang="en">
6059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6060: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 6061: <p>Configuration files are special in the sense that they are installed
6062: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6063: need special treatment during installation (most of which is automated by
6064: pkginstall). The main concept you must bear in mind is that files marked
6065: as configuration files are automatically copied to the right place (somewhere
6066: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6067: and only if</em></span> they didn't exist before. Similarly, they will not
6068: be removed if they have local modifications. This ensures that
6069: administrators never lose any custom changes they may have made.</p>
6070: <div class="sect2" lang="en">
6071: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6072: <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 6073: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6074: specifies where configuration files shall be installed. Its contents are
6075: set based upon the following variables:</p>
6076: <div class="itemizedlist"><ul type="disc">
6077: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
6078: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
6079: be overridden by the user to point to his preferred location (e.g.,
6080: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
6081: Packages must not use it directly.</p></li>
6082: <li>
6083: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6084: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6085: for the package being built shall be installed. The definition of this
6086: variable only makes sense in the package's
6087: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
6088: <p>As an example, consider the Apache package,
6089: <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
6090: configuration files under the
6091: <code class="filename">httpd/</code> subdirectory of
6092: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6093: Makefile.</p>
6094: </li>
6095: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6096: variable that holds this package's configuration directory (if
6097: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6098: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6099: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6100: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6101: directory where the configuration files for the package identified by
6102: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6103: </ul></div>
6104: <p>Based on the above variables, pkginstall determines the value of
6105: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6106: variable that can be used within a package to refer to its configuration
6107: directory. The algorithm used to set its value is basically the
6108: following:</p>
6109: <div class="orderedlist"><ol type="1">
6110: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6111: its value is used.</p></li>
6112: <li><p>If the previous variable is not defined but
6113: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
6114: <code class="filename">Makefile</code>, the resulting value is
6115: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
6116: <li><p>Otherwise, it is set to
6117: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
6118: </ol></div>
6119: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.6 rillig 6120: automatically added to <code class="filename">OWN_DIRS</code>. See <a href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, “Directory manipulation”</a> what this means.</p>
1.1 dsieger 6121: </div>
6122: <div class="sect2" lang="en">
6123: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6124: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 6125: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6126: known place, you need to teach each package where it shall install its
6127: files. In some cases you will have to patch the package Makefiles to
6128: achieve it. If you are lucky, though, it may be as easy as passing an
6129: extra flag to the configuration script; this is the case of GNU Autoconf-
6130: generated files:</p>
6131: <pre class="programlisting">
6132: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
6133: </pre>
6134: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6135: for</em></span> its configuration files, not where they will be originally
6136: installed (although the difference is never explicit,
6137: unfortunately).</p>
6138: </div>
6139: <div class="sect2" lang="en">
6140: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6141: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 6142: <p>As said before, pkginstall automatically handles configuration files.
6143: This means that <span class="strong"><strong>the packages themselves must not
6144: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6145: directly</strong></span>. Bad news is that many software installation scripts
6146: will, out of the box, mess with the contents of that directory. So what is
6147: the correct procedure to fix this issue?</p>
6148: <p>You must teach the package (usually by manually patching it) to
6149: install any configuration files under the examples hierarchy,
6150: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6151: <code class="filename">PLIST</code> registers them and the administrator always
6152: has the original copies available.</p>
6153: <p>Once the required configuration files are in place (i.e., under the
6154: examples hierarchy), the pkginstall framework can use them as master copies
6155: during the package installation to update what is in
6156: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
6157: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.6 rillig 6158: used. Check out <a href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.1 dsieger 6159: about their syntax and their purpose. Here is an example, taken from the
6160: <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>
6161: <pre class="programlisting">
6162: EGDIR= ${PREFIX}/share/doc/mutt/samples
6163: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6164: </pre>
6165: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6166: package and has no meaning outside it.</p>
6167: </div>
6168: <div class="sect2" lang="en">
6169: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6170: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 6171: <p>The automatic copying of config files can be toggled by setting the
6172: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6173: installation.</p>
6174: </div>
6175: </div>
6176: <div class="sect1" lang="en">
6177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6178: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 6179: <p>System startup scripts are special files because they must be
6180: installed in a place known by the underlying OS, usually outside the
1.6 rillig 6181: installation prefix. Therefore, the same rules described in <a 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 6182: can be used. However, pkginstall provides a special mechanism to handle
6183: these files.</p>
6184: <p>In order to provide system startup scripts, the package has
6185: to:</p>
6186: <div class="orderedlist"><ol type="1">
6187: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
6188: the <code class="literal">.sh</code> suffix appended. Considering the
6189: <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
6190: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
6191: <li>
6192: <p>Tell pkginstall to handle it, appending the name of the script,
6193: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6194: Continuing the previous example:</p>
6195: <pre class="programlisting">
6196: RCD_SCRIPTS+= cupsd
6197: </pre>
6198: </li>
6199: </ol></div>
6200: <p>Once this is done, pkginstall will do the following steps for each
6201: script in an automated fashion:</p>
6202: <div class="orderedlist"><ol type="1">
6203: <li><p>Process the file found in the files directory applying all the
6204: substitutions described in the <code class="filename">FILES_SUBST</code>
6205: variable.</p></li>
6206: <li><p>Copy the script from the files directory to the examples
6207: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
6208: that this master file must be explicitly registered in the
6209: <code class="filename">PLIST</code>.</p></li>
6210: <li><p>Add code to the installation scripts to copy the startup script
6211: from the examples hierarchy into the system-wide startup scripts
6212: directory.</p></li>
6213: </ol></div>
6214: <div class="sect2" lang="en">
6215: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6216: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 6217: <p>The automatic copying of config files can be toggled by setting the
6218: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6219: installation. Note that the scripts will be always copied inside the
6220: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6221: matter what the value of this variable is.</p>
6222: </div>
6223: </div>
6224: <div class="sect1" lang="en">
6225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6226: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 6227: <p>If a package needs to create special users and/or groups during
6228: installation, it can do so by using the pkginstall framework.</p>
6229: <p>Users can be created by adding entries to the
6230: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6231: syntax:</p>
6232: <pre class="programlisting">
6233: user:group
6234: </pre>
6235: <p>Further specification of user details may be done by setting
6236: per-user variables.
6237: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6238: numeric UID for the user.
6239: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6240: user's description or comment.
6241: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6242: user's home directory, and defaults to
6243: <code class="filename">/nonexistent</code> if not specified.
6244: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6245: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6246: not specified.</p>
6247: <p>Similarly, groups can be created by adding entries to the
6248: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6249: <pre class="programlisting">
6250: group
6251: </pre>
6252: <p>The numeric GID of the group may be set by defining
6253: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6254: <p>If a package needs to create the users and groups at an earlier
6255: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6256: either <code class="literal">configure</code> or <code class="literal">build</code> to
6257: indicate the phase before which the users and groups are created. In
6258: this case, the numeric UIDs and GIDs of the created users and groups
6259: are automatically hardcoded into the final installation scripts.</p>
6260: </div>
6261: <div class="sect1" lang="en">
6262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6263: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 6264: <p>Packages that install system shells should register them in the shell
6265: database, <code class="filename">/etc/shells</code>, to make things easier to the
6266: administrator. This must be done from the installation scripts to keep
6267: binary packages working on any system. pkginstall provides an easy way to
6268: accomplish this task.</p>
6269: <p>When a package provides a shell interpreter, it has to set the
6270: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6271: add some hooks to the installation scripts to handle it. Consider the
6272: 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>
6273: <pre class="programlisting">
6274: PKG_SHELL= ${PREFIX}/bin/zsh
6275: </pre>
6276: <div class="sect2" lang="en">
6277: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6278: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 6279: <p>The automatic registration of shell interpreters can be disabled by
6280: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6281: environment variable to <code class="literal">NO</code>.</p>
6282: </div>
6283: </div>
6284: <div class="sect1" lang="en">
6285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6286: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 6287: <p>Packages that install X11 fonts should update the database files
6288: that index the fonts within each fonts directory. This can easily be
6289: accomplished within the pkginstall framework.</p>
6290: <p>When a package installs X11 fonts, it must list the directories in
6291: which fonts are installed in the
6292: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6293: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6294: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6295: installation scripts to run the appropriate commands to update the fonts
6296: database files within each of those directories. For convenience, if the
6297: directory path is relative, it is taken to be relative to the package's
6298: 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>
6299: <pre class="programlisting">
6300: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6301: </pre>
6302: <div class="sect2" lang="en">
6303: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6304: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6305: <p>The automatic update of fonts databases can be disabled by
6306: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6307: environment variable to <code class="literal">NO</code>.</p>
6308: </div>
6309: </div>
6310: </div>
6311: <div class="chapter" lang="en">
6312: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6313: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6314: <div class="toc">
6315: <p><b>Table of Contents</b></p>
6316: <dl>
1.6 rillig 6317: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
6318: <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>
6319: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 6320: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6321: </dl>
6322: </div>
6323: <p>Many packages have the ability to be built to support different
6324: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6325: in pkgsrc that provides generic handling of those options that
6326: determine different ways in which the packages can be built. It's
6327: possible for the user to specify exactly which sets of options will be
6328: built into a package or to allow a set of global default options
6329: apply.</p>
1.7 rillig 6330: <p>There are two broad classes of behaviors that one might want to
6331: control via options. One is whether some particular feature is
6332: enabled in a program that will be built anyway, often by including or
6333: not including a dependency on some other package. The other is
6334: whether or not an additional program will be built as part of the
6335: package. Generally, it is better to make a split package for such
6336: additional programs instead of using options, because it enables
6337: binary packages to be built which can then be added separately. For
6338: example, the foo package might have minimal dependencies (those
6339: packages without which foo doesn't make sense), and then the foo-gfoo
6340: package might include the GTK frontend program gfoo. This is better
6341: than including a gtk option to foo that adds gfoo, because either that
6342: option is default, in which case binary users can't get foo without
6343: gfoo, or not default, in which case they can't get gfoo. With split
6344: packages, they can install foo without having GTK, and later decide to
6345: install gfoo (pulling in GTK at that time). This is an advantage to
6346: source users too, avoiding the need for rebuilds.</p>
6347: <p>Plugins with widely varying dependencies should usually be split
6348: instead of options.</p>
6349: <p>It is often more work to maintain split packages, especially if
6350: the upstream package does not support this. The decision of split
6351: vs. option should be made based on the likelihood that users will want
6352: or object to the various pieces, the size of the dependencies that are
6353: included, and the amount of work.</p>
6354: <p>A further consideration is licensing. Non-free parts, or parts
6355: that depend on non-free dependencies (especially plugins) should
6356: almost always be split if feasible.</p>
1.1 dsieger 6357: <div class="sect1" lang="en">
6358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6359: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6360: <p>Global default options are listed in
6361: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6362: that should be built into every package if that option is supported.
1.4 rillig 6363: This variable should be set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6364: </div>
6365: <div class="sect1" lang="en">
6366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6367: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6368: </h2></div></div></div>
6369: <p>The following example shows how
6370: <code class="filename">bsd.options.mk</code> should be used
6371: by the hypothetical ``wibble'' package, either in the package
6372: <code class="filename">Makefile</code>, or in a file,
6373: e.g. <code class="filename">options.mk</code>, that is included by the
6374: main package <code class="filename">Makefile</code>.</p>
6375: <pre class="programlisting">
6376: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6377: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6378: PKG_OPTIONS_OPTIONAL_GROUPS= database
6379: PKG_OPTIONS_GROUP.database= mysql pgsql
6380: PKG_SUGGESTED_OPTIONS= wibble-foo
6381: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6382: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6383:
6384: .include "../../mk/bsd.prefs.mk"
6385:
6386: # this package was previously named wibble2
6387: .if defined(PKG_OPTIONS.wibble2)
6388: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6389: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6390: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6391: .endif
6392:
6393: .include "../../mk/bsd.options.mk"
6394:
6395: # Package-specific option-handling
6396:
6397: ###
6398: ### FOO support
6399: ###
6400: .if !empty(PKG_OPTIONS:Mwibble-foo)
6401: CONFIGURE_ARGS+= --enable-foo
6402: .endif
6403:
6404: ###
6405: ### LDAP support
6406: ###
6407: .if !empty(PKG_OPTIONS:Mldap)
6408: . include "../../databases/openldap-client/buildlink3.mk"
6409: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6410: .endif
6411:
6412: ###
6413: ### database support
6414: ###
6415: .if !empty(PKG_OPTIONS:Mmysql)
6416: . include "../../mk/mysql.buildlink3.mk"
6417: .endif
6418: .if !empty(PKG_OPTIONS:Mpgsql)
6419: . include "../../mk/pgsql.buildlink3.mk"
6420: .endif
6421: </pre>
6422: <p>The first section contains the information about which build
6423: options are supported by the package, and any default options settings
6424: if needed.</p>
6425: <div class="orderedlist"><ol type="1">
6426: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6427: <a 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
6428: options. It should be set to
6429: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6430: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6431: at the point where the options are processed.</p></li>
6432: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6433: build options supported by the package.</p></li>
6434: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6435: list of names of groups of mutually exclusive options. The options in
6436: each group are listed in
6437: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6438: The most specific setting of any option from the group takes
6439: precedence over all other options in the group. Options from the
6440: groups will be automatically added to
6441: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6442: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6443: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6444: packages will fail if no option from the group is
6445: selected.</p></li>
6446: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6447: of names of sets of options. At least one option from each set must
6448: be selected. The options in each set are listed in
6449: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6450: Options from the sets will be automatically added to
6451: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6452: fail if no option from the set is selected.</p></li>
6453: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6454: build options which are enabled by default.</p></li>
6455: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6456: of
6457: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.4 rillig 6458: pairs that map legacy <a href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6459: their option counterparts. Pairs should be added with
6460: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6461: warning will be issued if the user uses a legacy
6462: variable.</p></li>
6463: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6464: of
6465: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6466: pairs that map options that have been renamed to their new
6467: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6468: the listing of global legacy options. A warning will be issued if
6469: the user uses a legacy option.</p></li>
6470: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6471: options implied by deprecated variables used. This can be used for
6472: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6473: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6474: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6475: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6476: a list of warnings about deprecated variables or options used, and
6477: what to use instead.</p></li>
6478: </ol></div>
6479: <p>A package should never modify
6480: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6481: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6482: To suggest a default set of options, use
6483: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6484: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6485: including <code class="filename">bsd.options.mk</code>. If none of
6486: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6487: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6488: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6489: happen with platform-specific options if none of them is supported on
6490: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6491: empty list and the package is otherwise treated as not using the
6492: options framework.</p>
6493: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6494: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6495: build options, properly filtered to remove unsupported and duplicate
6496: options.</p>
6497: <p>The remaining sections contain the logic that is specific to
6498: each option. The correct way to check for an option is to check
6499: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6500: <pre class="programlisting">
6501: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6502: </pre>
6503: </div>
6504: <div class="sect1" lang="en">
6505: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6506: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6507: <p>Options that enable similar features in different packages (like
6508: optional support for a library) should use a common name in all
6509: packages that support it (like the name of the library). If another
6510: package already has an option with the same meaning, use the same
6511: name.</p>
6512: <p>Options that enable features specific to one package, where it's
6513: unlikely that another (unrelated) package has the same (or a similar)
6514: optional feature, should use a name prefixed with
6515: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6516: <p>If a group of related packages share an optional feature
6517: specific to that group, prefix it with the name of the
6518: “<span class="quote">main</span>” package
6519: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6520: <p>For new options, add a line to
6521: <code class="filename">mk/defaults/options.description</code>. Lines have two
6522: fields, separated by tab. The first field is the option name, the
6523: second its description. The description should be a whole sentence
6524: (starting with an uppercase letter and ending with a period) that
6525: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6526: support.</span>” The file is sorted by option names.</p>
6527: </div>
1.7 rillig 6528: <div class="sect1" lang="en">
6529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6530: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6531: <p>When writing <a href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6532: different dependencies based on the options with which the package was
6533: built. For querying these options, the file
6534: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6535: typical example looks like this:</p>
6536: <pre class="programlisting">
6537: pkgbase := libpurple
6538: .include "../../mk/pkg-build-options.mk"
6539:
6540: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6541: ...
6542: .endif
6543: </pre>
6544: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6545: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6546: options of the libpurple package, which can then be queried like
6547: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6548: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6549: details.</p>
6550: </div>
1.1 dsieger 6551: </div>
6552: <div class="chapter" lang="en">
6553: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6554: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6555: <div class="toc">
6556: <p><b>Table of Contents</b></p>
6557: <dl>
1.6 rillig 6558: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6559: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6560: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6561: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
6562: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6563: <dd><dl>
6564: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6565: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6566: </dl></dd>
6567: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6568: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6569: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6570: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6571: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6572: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6573: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6574: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6575: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6576: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6577: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6578: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6579: </dl>
6580: </div>
6581: <div class="sect1" lang="en">
6582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6583: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6584: <p>This chapter gives a detailed description on how a package is
6585: built. Building a package is separated into different
6586: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6587: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6588: described in the following sections. Each phase is splitted into
6589: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6590: containing phase, prefixed by one of <code class="varname">pre-</code>,
6591: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6592: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6593: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6594: <p>Never override the regular targets (like
6595: <code class="varname">fetch</code>), if you have to, override the
6596: <code class="varname">do-*</code> ones instead.</p>
6597: <p>The basic steps for building a program are always the same. First
6598: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6599: the local system and then extracted. After any pkgsrc-specific patches
6600: to compile properly are applied, the software can be configured, then
6601: built (usually by compiling), and finally the generated binaries, etc.
6602: can be put into place on the system.</p>
6603: <p>To get more details about what is happening at each step,
6604: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6605: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6606: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6607: </div>
6608: <div class="sect1" lang="en">
6609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6610: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6611: <p>Before outlining the process performed by the NetBSD package system in
6612: the next section, here's a brief discussion on where programs are
6613: installed, and which variables influence this.</p>
6614: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6615: where all files of the final program shall be installed. It is
6616: usually set to <code class="varname">LOCALBASE</code>
6617: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6618: for pkgs in the <code class="filename">cross</code> category. The value of
6619: <code class="varname">PREFIX</code> needs to be put
6620: into the various places in the program's source where paths to
1.6 rillig 6621: these files are encoded. See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a 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 6622: <p>When choosing which of these variables to use,
6623: follow the following rules:</p>
6624: <div class="itemizedlist"><ul type="disc">
6625: <li><p><code class="varname">PREFIX</code> always points to the location
6626: where the current pkg will be installed. When referring to a
6627: pkg's own installation path, use
6628: “<span class="quote">${PREFIX}</span>”.</p></li>
6629: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6630: are installed. If you need to construct a -I or -L argument
6631: to the compiler to find includes and libraries installed by
6632: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
6633: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6634: installed all packages in <code class="filename">/usr/local</code>. As
6635: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6636: administrator, this variable is a misnomer.</p></li>
6637: <li><p><code class="varname">X11BASE</code> is where the actual X11
6638: distribution (from xsrc, etc.) is installed. When looking for
6639: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6640: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6641: <li>
6642: <p>X11-based packages are special in that they may be
6643: installed in either <code class="varname">X11BASE</code> or
6644: <code class="varname">LOCALBASE</code>.</p>
6645: <p>Usually, X11 packages should be installed under
6646: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6647: will need to include
6648: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6649: request the presence of X11 and to get the right compilation
6650: flags.</p>
6651: <p>Even though, there are some packages that cannot be installed
6652: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6653: files. These packages are special and they must be placed under
6654: <code class="varname">X11BASE</code>. To accomplish this, set either
6655: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6656: your package.</p>
6657: <p>Some notes: If you need
6658: to find includes or libraries installed by a pkg that has
6659: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6660: its pkg <code class="filename">Makefile</code>, you need to look in
6661: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6662: <code class="filename">${LOCALBASE}</code>. To force installation of
6663: all X11 packages in <code class="varname">LOCALBASE</code>, the
6664: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6665: is enabled by default.</p>
6666: </li>
6667: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6668: the installed location of an X11
6669: package. <code class="varname">X11PREFIX</code> will be set to
6670: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6671: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6672: installed.</p></li>
6673: <li>
6674: <p>If xpkgwedge is installed, it is possible to have some
6675: packages installed in <code class="varname">X11BASE</code> and some in
6676: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6677: installed package, the <code class="varname">EVAL_PREFIX</code>
6678: definition can be used. It takes pairs in the format
6679: “<span class="quote">DIRNAME=<package></span>”, and the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
6680: variable <code class="varname">DIRNAME</code> will be set to the prefix
6681: of the installed package <package>, or
6682: “<span class="quote">${X11PREFIX}</span>” if the package is not
6683: installed.</p>
6684: <p>This is best illustrated by example.</p>
6685: <p>The following lines are taken from
6686: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6687: <pre class="programlisting">
6688: EVAL_PREFIX+= GTKDIR=gtk+
6689: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6690: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6691: CONFIGURE_ARGS+= --enable-multibyte
6692: </pre>
6693: <p>Specific defaults can be defined for the packages
6694: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6695: definition of the form:</p>
6696: <pre class="programlisting">
6697: GTKDIR_DEFAULT= ${LOCALBASE}
6698: </pre>
6699: <p>where <code class="varname">GTKDIR</code> corresponds
6700: to the first definition in
6701: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6702: </li>
6703: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
6704: install files according to <a 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
6705: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6706: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6707: </ul></div>
6708: </div>
6709: <div class="sect1" lang="en">
6710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6711: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.1 dsieger 6712: <p>When building a package, a number of directories is used to store
6713: source files, temporary files, pkgsrc-internal files, and so on. These
6714: directories are explained here.</p>
6715: <p>Some of the directory variables contain relative pathnames. There
6716: are two common base directories for these relative directories:
6717: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6718: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6719: inside the package itself.</p>
6720: <div class="variablelist"><dl>
6721: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6722: <dd><p>This is an absolute pathname that points to the pkgsrc
6723: root directory. Generally, you don't need
6724: it.</p></dd>
6725: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6726: <dd><p>This is an absolute pathname that points to the
6727: current package.</p></dd>
6728: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6729: <dd><p>This is a pathname relative to
6730: <code class="varname">PKGSRCDIR</code> that points to the current
6731: package.</p></dd>
6732: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6733: <dd><p>This is an absolute pathname pointing to the directory
6734: where all work takes place. The distfiles are extracted to this
6735: directory. It also contains temporary directories and log files used by
6736: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6737: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6738: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6739: <dd><p>This is an absolute pathname pointing to the directory
6740: where the distfiles are extracted. It is usually a direct subdirectory
6741: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6742: that isn't hidden. This variable may be changed by a package
6743: <code class="filename">Makefile</code>.</p></dd>
6744: </dl></div>
6745: </div>
6746: <div class="sect1" lang="en">
6747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6748: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.1 dsieger 6749: <p>You can run a particular phase by typing <span><strong class="command">make
6750: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6751: phase. This will automatically run all phases that are required for this
6752: phase. The default phase is <code class="varname">build</code>, that is, when you
6753: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6754: the package will be built, but not installed.</p>
6755: </div>
6756: <div class="sect1" lang="en">
6757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6758: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6759: <p>The first step in building a package is to fetch the
6760: distribution files (distfiles) from the sites that are providing
6761: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6762: phase.</p>
6763: <div class="sect2" lang="en">
6764: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6765: <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 6766: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6767: defines all URLs from where the distfile, whose name is
6768: derived from the <code class="varname">DISTNAME</code> variable, is
6769: fetched. The more complicated cases are described
6770: below.</p>
6771: <p>The variable <code class="varname">DISTFILES</code> specifies
6772: the list of distfiles that have to be fetched. Its value
6773: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6774: so that most packages don't need to define it at all.
6775: <code class="varname">EXTRACT_SUFX</code> is
6776: <code class="literal">.tar.gz</code> by default, but can be changed
6777: freely. Note that if your package requires additional
6778: distfiles to the default one, you cannot just append the
6779: additional filenames using the <code class="literal">+=</code>
6780: operator, but you have write for example:</p>
6781: <pre class="programlisting">
6782: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6783: </pre>
6784: <p>Each distfile is fetched from a list of sites, usually
6785: <code class="varname">MASTER_SITES</code>. If the package has multiple
6786: <code class="varname">DISTFILES</code> or multiple
6787: <code class="varname">PATCHFILES</code> from different sites, you can
6788: set
6789: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6790: to the list of URLs where the file
6791: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6792: (including the suffix) can be found.</p>
6793: <pre class="programlisting">
6794: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6795: DISTFILES+= foo-file.tar.gz
6796: SITES.foo-file.tar.gz= \
6797: http://www.somewhere.com/somehow/ \
6798: http://www.somewhereelse.com/mirror/somehow/
6799: </pre>
6800: <p>When actually fetching the distfiles, each item from
6801: <code class="varname">MASTER_SITES</code> or
6802: <code class="varname">SITES.*</code> gets the name of each distfile
6803: appended to it, without an intermediate slash. Therefore,
6804: all site values have to end with a slash or other separator
6805: character. This allows for example to set
6806: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6807: that gets the name of the distfile as a parameter. In this
6808: case, the definition would look like:</p>
6809: <pre class="programlisting">
6810: MASTER_SITES= http://www.example.com/download.cgi?file=
6811: </pre>
6812: <p>There are some predefined values for
6813: <code class="varname">MASTER_SITES</code>, which can be used in
6814: packages. The names of the variables should speak for
6815: themselves.</p>
6816: <pre class="programlisting">
6817: ${MASTER_SITE_APACHE}
6818: ${MASTER_SITE_BACKUP}
6819: ${MASTER_SITE_CYGWIN}
6820: ${MASTER_SITE_DEBIAN}
6821: ${MASTER_SITE_FREEBSD}
6822: ${MASTER_SITE_FREEBSD_LOCAL}
6823: ${MASTER_SITE_GENTOO}
6824: ${MASTER_SITE_GNOME}
6825: ${MASTER_SITE_GNU}
6826: ${MASTER_SITE_GNUSTEP}
6827: ${MASTER_SITE_IFARCHIVE}
6828: ${MASTER_SITE_KDE}
6829: ${MASTER_SITE_MOZILLA}
6830: ${MASTER_SITE_MYSQL}
6831: ${MASTER_SITE_OPENOFFICE}
6832: ${MASTER_SITE_PERL_CPAN}
6833: ${MASTER_SITE_PGSQL}
6834: ${MASTER_SITE_R_CRAN}
6835: ${MASTER_SITE_SOURCEFORGE}
6836: ${MASTER_SITE_SOURCEFORGE_JP}
6837: ${MASTER_SITE_SUNSITE}
6838: ${MASTER_SITE_SUSE}
6839: ${MASTER_SITE_TEX_CTAN}
6840: ${MASTER_SITE_XCONTRIB}
6841: ${MASTER_SITE_XEMACS}
6842: </pre>
6843: <p>Some explanations for the less self-explaining ones:
6844: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
6845: for packages that are maintained in <a 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
6846: package source distributions that are maintained in <a 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>
6847: <p>If you choose one of these predefined sites, you may
6848: want to specify a subdirectory of that site. Since these
6849: macros may expand to more than one actual site, you
6850: <span class="emphasis"><em>must</em></span> use the following construct to
6851: specify a subdirectory:</p>
6852: <pre class="programlisting">
6853: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6854: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6855: </pre>
6856: <p>Note the trailing slash after the subdirectory
6857: name.</p>
6858: </div>
6859: <div class="sect2" lang="en">
6860: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6861: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6862: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6863: all the distfiles exist in a local directory
6864: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6865: user). If the files do not exist, they are fetched using
6866: commands of the form</p>
6867: <pre class="programlisting">
6868: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6869: </pre>
6870: <p>where <code class="literal">${site}</code> varies through
6871: several possibilities in turn: first,
6872: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6873: sites specified in either <code class="varname">SITES.file</code> if
6874: defined, else <code class="varname">MASTER_SITES</code> or
6875: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6876: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6877: all except the first and the last can be optionally sorted
6878: by the user, via setting either
6879: <code class="varname">MASTER_SORT_RANDOM</code>, and
6880: <code class="varname">MASTER_SORT_AWK</code> or
6881: <code class="varname">MASTER_SORT_REGEX</code>.</p>
6882: <p>The distfiles mirror run by the NetBSD Foundation uses the
6883: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6884: distfiles, if they are freely distributable. Packages setting
6885: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6886: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6887: mirrored.</p>
6888: </div>
6889: </div>
6890: <div class="sect1" lang="en">
6891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6892: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6893: <p>After the distfile(s) are fetched, their checksum is
6894: generated and compared with the checksums stored in the
6895: distinfo file. If the checksums don't match, the build is
6896: aborted. This is to ensure the same distfile is used for
6897: building, and that the distfile wasn't changed, e.g. by some
6898: malign force, deliberately changed distfiles on the master
6899: distribution site or network lossage.</p>
6900: </div>
6901: <div class="sect1" lang="en">
6902: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6903: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6904: <p>When the distfiles are present on the local system, they
6905: need to be extracted, as they usually come in the form of some
6906: compressed archive format.</p>
6907: <p>By default, all <code class="varname">DISTFILES</code> are
6908: extracted. If you only need some of them, you can set the
6909: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6910: files.</p>
6911: <p>Extracting the files is usually done by a little
6912: program, <code class="filename">mk/extract/extract</code>, which
6913: already knows how to extract various archive formats, so most
6914: likely you will not need to change anything here. But if you
6915: need, the following variables may help you:</p>
6916: <div class="variablelist"><dl>
6917: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6918: <dd><p>Use these variables to override the default
6919: options for an extract command, which are defined in
6920: <code class="filename">mk/extract/extract</code>.</p></dd>
6921: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6922: <dd><p>This variable can be set to
6923: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6924: default value), <code class="literal">pax</code>, or an
6925: absolute pathname pointing to the command with which tar
6926: archives should be
6927: extracted.</p></dd>
6928: </dl></div>
6929: <p>If the <code class="filename">extract</code> program doesn't
6930: serve your needs, you can also override the
6931: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6932: command used for extracting the files. This command is
6933: executed in the <code class="filename">${WRKSRC}</code>
6934: directory. During execution of this command, the shell
6935: variable <code class="varname">extract_file</code> holds the absolute
6936: pathname of the file that is going to be extracted.</p>
6937: <p>And if that still does not suffice, you can override the
6938: <code class="varname">do-extract</code> target in the package
6939: Makefile.</p>
6940: </div>
6941: <div class="sect1" lang="en">
6942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6943: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6944: <p>After extraction, all the patches named by the
6945: <code class="varname">PATCHFILES</code>, those present in the patches
6946: subdirectory of the package as well as in
6947: $LOCALPATCHES/$PKGPATH (e.g.
6948: <code class="filename">/usr/local/patches/graphics/png</code>) are
6949: applied. Patchfiles ending in <code class="filename">.Z</code> or
6950: <code class="filename">.gz</code> are uncompressed before they are
6951: applied, files ending in <code class="filename">.orig</code> or
6952: <code class="filename">.rej</code> are ignored. Any special options to
6953: <a 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
1.6 rillig 6954: <code class="varname">PATCH_DIST_ARGS</code>. See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
1.1 dsieger 6955: <p>By default <a 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
6956: it fail if the patches apply with some lines of fuzz. Please
6957: fix (regen) the patches so that they apply cleanly. The
6958: rationale behind this is that patches that don't apply cleanly
6959: may end up being applied in the wrong place, and cause severe
6960: harm there.</p>
6961: </div>
6962: <div class="sect1" lang="en">
6963: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6964: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6965: <p>This is covered in <a 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 6966: </p>
6967: </div>
6968: <div class="sect1" lang="en">
6969: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6970: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6971: <p>This phase creates wrapper programs for the compilers and
6972: linkers. The following variables can be used to tweak the
6973: wrappers.</p>
6974: <div class="variablelist"><dl>
6975: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6976: <dd><p>The command used to print progress
6977: messages. Does nothing by default. Set to
6978: <code class="literal">${ECHO}</code> to see the progress
6979: messages.</p></dd>
6980: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6981: <dd><p>This variable can be set to
6982: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6983: depending on whether you want additional information in the
6984: wrapper log file.</p></dd>
6985: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6986: <dd><p>This variable can be set to
6987: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6988: on whether the wrapper should use its cache, which will
6989: improve the speed. The default value is
6990: <code class="literal">yes</code>, but is forced to
6991: <code class="literal">no</code> if the platform does not support
6992: it.</p></dd>
6993: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6994: <dd><p>A list of reordering commands. A reordering
6995: command has the form
6996: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6997: It ensures that that
6998: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6999: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
7000: </p></dd>
7001: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
7002: <dd><p>A list of transformation commands. [TODO:
7003: investigate further]</p></dd>
7004: </dl></div>
7005: </div>
7006: <div class="sect1" lang="en">
7007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7008: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 7009: <p>Most pieces of software need information on the header
7010: files, system calls, and library routines which are available
7011: on the platform they run on. The process of determining this
7012: information is known as configuration, and is usually
7013: automated. In most cases, a script is supplied with the
7014: distfiles, and its invocation results in generation of header
7015: files, Makefiles, etc.</p>
7016: <p>If the package contains a configure script, this can be
7017: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
7018: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
7019: script, you should set <code class="varname">GNU_CONFIGURE</code> to
7020: “<span class="quote">yes</span>” instead. What happens in the
7021: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
7022: <pre class="programlisting">
7023: .for d in ${CONFIGURE_DIRS}
7024: cd ${WRKSRC} \
7025: && cd ${d} \
7026: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
7027: .endfor
7028: </pre>
7029: <p><code class="varname">CONFIGURE_DIRS</code> (default:
7030: “<span class="quote">.</span>”) is a list of pathnames relative to
7031: <code class="varname">WRKSRC</code>. In each of these directories, the
7032: configure script is run with the environment
7033: <code class="varname">CONFIGURE_ENV</code> and arguments
7034: <code class="varname">CONFIGURE_ARGS</code>. The variables
7035: <code class="varname">CONFIGURE_ENV</code>,
7036: <code class="varname">CONFIGURE_SCRIPT</code> (default:
7037: “<span class="quote">./configure</span>”) and
7038: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
7039: package.</p>
7040: <p>If the program uses an <code class="filename">Imakefile</code>
7041: for configuration, the appropriate steps can be invoked by
7042: setting <code class="varname">USE_IMAKE</code> to
7043: “<span class="quote">yes</span>”. (If you only want the package installed in
7044: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
7045: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
7046: xmkmf's environment by adding them to the
7047: <code class="varname">SCRIPTS_ENV</code> variable.</p>
7048: <p>If there is no configure step at all, set
7049: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
7050: </div>
7051: <div class="sect1" lang="en">
7052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7053: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7054: <p>For building a package, a rough equivalent of the
7055: following code is executed.</p>
7056: <pre class="programlisting">
7057: .for d in ${BUILD_DIRS}
7058: cd ${WRKSRC} \
7059: && cd ${d} \
7060: && env ${MAKE_ENV} \
7061: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
7062: -f ${MAKE_FILE} \
7063: ${BUILD_TARGET}
7064: .endfor
7065: </pre>
7066: <p><code class="varname">BUILD_DIRS</code> (default:
7067: “<span class="quote">.</span>”) is a list of pathnames relative to
7068: <code class="varname">WRKSRC</code>. In each of these directories,
7069: <code class="varname">MAKE_PROGRAM</code> is run with the environment
7070: <code class="varname">MAKE_ENV</code> and arguments
7071: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
7072: <code class="varname">MAKE_ENV</code>,
7073: <code class="varname">BUILD_MAKE_FLAGS</code>,
7074: <code class="varname">MAKE_FILE</code> and
7075: <code class="varname">BUILD_TARGET</code> may all be changed by the
7076: package.</p>
7077: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
7078: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
7079: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
7080: default value of <code class="varname">MAKE_FILE</code> is
7081: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
7082: defaults to “<span class="quote">all</span>”.</p>
7083: <p>If there is no build step at all, set
7084: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
7085: </div>
7086: <div class="sect1" lang="en">
7087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7088: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 7089: <p>[TODO]</p>
7090: </div>
7091: <div class="sect1" lang="en">
7092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7093: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 7094: <p>Once the build stage has completed, the final step is to
7095: install the software in public directories, so users can
7096: access the programs and files.</p>
7097: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
7098: equivalent of the following code is executed. Additionally,
7099: before and after this code, much magic is performed to do
7100: consistency checks, registering the package, and so on.</p>
7101: <pre class="programlisting">
7102: .for d in ${INSTALL_DIRS}
7103: cd ${WRKSRC} \
7104: && cd ${d} \
7105: && env ${MAKE_ENV} \
7106: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7107: -f ${MAKE_FILE} \
7108: ${INSTALL_TARGET}
7109: .endfor
7110: </pre>
7111: <p>The variable's meanings are analogous to the ones in the
7112: <span class="emphasis"><em>build</em></span> phase.
7113: <code class="varname">INSTALL_DIRS</code> defaults to
7114: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7115: is “<span class="quote">install</span>” by default, plus
7116: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
7117: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7118: defined.</p>
7119: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7120: variables are useful. They are all variations of the
7121: <a 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
7122: permissions preset. <code class="varname">INSTALL</code> is the plain
7123: install command. The specialized variants, together with their
7124: intended use, are:</p>
7125: <div class="variablelist"><dl>
7126: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7127: <dd><p>directories that contain
7128: binaries</p></dd>
7129: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7130: <dd><p>directories that contain
7131: scripts</p></dd>
7132: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7133: <dd><p>directories that contain shared and static
7134: libraries</p></dd>
7135: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7136: <dd><p>directories that contain data
7137: files</p></dd>
7138: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7139: <dd><p>directories that contain man
7140: pages</p></dd>
7141: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7142: <dd><p>binaries that can be stripped from debugging
7143: symbols</p></dd>
7144: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7145: <dd><p>binaries that cannot be
7146: stripped</p></dd>
7147: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7148: <dd><p>game
7149: binaries</p></dd>
7150: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7151: <dd><p>shared and static
7152: libraries</p></dd>
7153: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7154: <dd><p>data files</p></dd>
7155: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7156: <dd><p>data files for
7157: games</p></dd>
7158: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7159: <dd><p>man pages</p></dd>
7160: </dl></div>
7161: <p>Some other variables are:</p>
7162: <div class="variablelist"><dl>
7163: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7164: <dd><p>A list of directories relative to
7165: <code class="varname">PREFIX</code> that are created by pkgsrc at the
7166: beginning of the <span class="emphasis"><em>install</em></span> phase.
7167: The package is supposed to create all needed directories itself
7168: before installing files to it and list all other directories here.
7169: </p></dd>
7170: </dl></div>
7171: <p>In the rare cases that a package shouldn't install anything,
7172: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7173: mostly relevant for packages in the <code class="filename">regress</code>
7174: category.</p>
7175: </div>
7176: <div class="sect1" lang="en">
7177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7178: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 7179: <p>Once the install stage has completed, a binary package of
7180: the installed files can be built. These binary packages can be
7181: used for quick installation without previous compilation, e.g. by
7182: the <span><strong class="command">make bin-install</strong></span> or by using
7183: <span><strong class="command">pkg_add</strong></span>.</p>
7184: <p>By default, the binary packages are created in
7185: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7186: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7187: one for each category in the <code class="varname">CATEGORIES</code>
7188: variable. <code class="varname">PACKAGES</code> defaults to
7189: <code class="filename">pkgsrc/packages</code>.</p>
7190: <p>If there should be no binary package, set
7191: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7192: This should only be used in rare cases, like when a package
7193: definitely is only usable on the machine where it is built and even
7194: then, a binary package can be useful.</p>
7195: </div>
7196: <div class="sect1" lang="en">
7197: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7198: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 7199: <p>Once you're finished with a package, you can clean the work
7200: directory by running <span><strong class="command">make clean</strong></span>. If you want
7201: to clean the work directories of all dependencies too, use
7202: <span><strong class="command">make clean-depends</strong></span>.</p>
7203: </div>
7204: <div class="sect1" lang="en">
7205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7206: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1 dsieger 7207: <div class="variablelist"><dl>
7208: <dt><span class="term">pre/post-*</span></dt>
7209: <dd><p>For any of the main targets described in the
7210: previous section, two auxiliary targets exist with
7211: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7212: prefix for the main target's name. These targets are
7213: invoked before and after the main target is called,
7214: allowing extra configuration or installation steps be
7215: performed from a package's Makefile, for example, which
7216: a program's configure script or install target
7217: omitted.</p></dd>
7218: <dt><span class="term">do-*</span></dt>
7219: <dd><p>Should one of the main targets do the wrong thing,
7220: and should there be no variable to fix this, you can
7221: redefine it with the do-* target. (Note that redefining
7222: the target itself instead of the do-* target is a bad
7223: idea, as the pre-* and post-* targets won't be called
7224: anymore, etc.) You will not usually need to do
7225: this.</p></dd>
7226: <dt><span class="term">reinstall</span></dt>
7227: <dd>
7228: <p>If you did a <span><strong class="command">make install</strong></span> and
7229: you noticed some file was not installed properly, you
7230: can repeat the installation with this target, which will
7231: ignore the “<span class="quote">already installed</span>” flag.</p>
7232: <p>This is the default value of
7233: <code class="varname">DEPENDS_TARGET</code> except in the case of
7234: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7235: package</strong></span>, where the defaults are
7236: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7237: respectively.</p>
7238: </dd>
7239: <dt><span class="term">deinstall</span></dt>
7240: <dd>
7241: <p>This target does a <a 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
7242: current directory, effectively de-installing the
7243: package. The following variables can be used to tune the
7244: behaviour:</p>
7245: <div class="variablelist"><dl>
7246: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7247: <dd><p>Add a "-v" to the <a 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>
7248: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7249: <dd><p>Remove all packages that require (depend on)
7250: the given package. This can be used to remove any
7251: packages that may have been pulled in by a given
7252: package, e.g. if <span><strong class="command">make deinstall
7253: DEINSTALLDEPENDS=1</strong></span> is done in
7254: <code class="filename">pkgsrc/x11/kde</code>, this is
7255: likely to remove whole KDE. Works by adding
7256: “<span class="quote">-R</span>” to the <a 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>
7257: command line.</p></dd>
7258: </dl></div>
7259: </dd>
7260: <dt><span class="term">bin-install</span></dt>
7261: <dd><p>Install a binary package from local disk and via FTP
7262: from a list of sites (see the
7263: <code class="varname">BINPKG_SITES</code> variable), and do a
7264: <span><strong class="command">make package</strong></span> if no binary package is
7265: available anywhere. The arguments given to
7266: <span><strong class="command">pkg_add</strong></span> can be set via
7267: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7268: operation, etc.</p></dd>
7269: <dt><span class="term">update</span></dt>
7270: <dd>
7271: <p>This target causes the current package to be
7272: updated to the latest version. The package and all
7273: depending packages first get de-installed, then current
7274: versions of the corresponding packages get compiled and
7275: installed. This is similar to manually noting which
7276: packages are currently installed, then performing a
7277: series of <span><strong class="command">make deinstall</strong></span> and
7278: <span><strong class="command">make install</strong></span> (or whatever
7279: <code class="varname">UPDATE_TARGET</code> is set to) for these
7280: packages.</p>
7281: <p>You can use the “<span class="quote">update</span>” target to
7282: resume package updating in case a previous <span><strong class="command">make
7283: update</strong></span> was interrupted for some reason.
7284: However, in this case, make sure you don't call
7285: <span><strong class="command">make clean</strong></span> or otherwise remove the
7286: list of dependent packages in <code class="varname">WRKDIR</code>.
7287: Otherwise, you lose the ability to automatically update
7288: the current package along with the dependent packages
7289: you have installed.</p>
7290: <p>Resuming an interrupted <span><strong class="command">make
7291: update</strong></span> will only work as long as the package
7292: tree remains unchanged. If the source code for one of
7293: the packages to be updated has been changed, resuming
7294: <span><strong class="command">make update</strong></span> will most certainly
7295: fail!</p>
7296: <p>The following variables can be used either on the
1.4 rillig 7297: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7298: alter the behaviour of <span><strong class="command">make
7299: update</strong></span>:</p>
7300: <div class="variablelist"><dl>
7301: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7302: <dd><p>Install target to recursively use for the
7303: updated package and the dependent packages.
7304: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7305: set, “<span class="quote">install</span>” otherwise for
7306: <span><strong class="command">make update</strong></span>. Other good
7307: targets are “<span class="quote">package</span>” or
7308: “<span class="quote">bin-install</span>”. Do not set this to
7309: “<span class="quote">update</span>” or you will get stuck in an
7310: endless loop!</p></dd>
7311: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7312: <dd><p>Don't clean up after updating. Useful if
7313: you want to leave the work sources of the updated
7314: packages around for inspection or other purposes.
7315: Be sure you eventually clean up the source tree
7316: (see the “<span class="quote">clean-update</span>” target below)
7317: or you may run into troubles with old source code
7318: still lying around on your next
7319: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7320: update</strong></span>.</p></dd>
7321: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7322: <dd><p>Deinstall each package before installing
7323: (making <code class="varname">DEPENDS_TARGET</code>). This
7324: may be necessary if the
7325: “<span class="quote">clean-update</span>” target (see below) was
7326: called after interrupting a running <span><strong class="command">make
7327: update</strong></span>.</p></dd>
7328: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7329: <dd><p>Allows you to disable recursion and hardcode
7330: the target for packages. The default is
7331: “<span class="quote">update</span>” for the update target,
7332: facilitating a recursive update of prerequisite
7333: packages. Only set
7334: <code class="varname">DEPENDS_TARGET</code> if you want to
7335: disable recursive updates. Use
7336: <code class="varname">UPDATE_TARGET</code> instead to just
7337: set a specific target for each package to be
7338: installed during <span><strong class="command">make update</strong></span>
7339: (see above).</p></dd>
7340: </dl></div>
7341: </dd>
7342: <dt><span class="term">clean-update</span></dt>
7343: <dd>
7344: <p>Clean the source tree for all packages that would
7345: get updated if <span><strong class="command">make update</strong></span> was called
7346: from the current directory. This target should not be
7347: used if the current package (or any of its depending
7348: packages) have already been de-installed (e.g., after
7349: calling <span><strong class="command">make update</strong></span>) or you may lose
7350: some packages you intended to update. As a rule of
7351: thumb: only use this target <span class="emphasis"><em>before</em></span>
7352: the first time you run <span><strong class="command">make update</strong></span>
7353: and only if you have a dirty package tree (e.g., if you
7354: used <code class="varname">NOCLEAN</code>).</p>
7355: <p>If you are unsure about whether your tree is
7356: clean, you can either perform a <span><strong class="command">make
7357: clean</strong></span> at the top of the tree, or use the
7358: following sequence of commands from the directory of the
7359: package you want to update (<span class="emphasis"><em>before</em></span>
7360: running <span><strong class="command">make update</strong></span> for the first
7361: time, otherwise you lose all the packages you wanted to
7362: update!):</p>
7363: <pre class="screen">
7364: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7365: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7366: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7367: </pre>
7368: <p>The following variables can be used either on the
1.4 rillig 7369: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7370: <span><strong class="command">make clean-update</strong></span>:</p>
1.1 dsieger 7371: <div class="variablelist"><dl>
7372: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
7373: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7374: reconstruct the list of directories to update for
7375: this package. Only use this if <span><strong class="command">make
7376: update</strong></span> successfully installed all
7377: packages you wanted to update. Normally, this is
7378: done automatically on <span><strong class="command">make
7379: update</strong></span>, but may have been suppressed by
7380: the <code class="varname">NOCLEAN</code> variable (see
7381: above).</p></dd>
7382: </dl></div>
7383: </dd>
7384: <dt><span class="term">replace</span></dt>
7385: <dd>
7386: <p>Update the installation of the current package. This
7387: differs from update in that it does not replace dependent
7388: 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
7389: target to work.</p>
7390: <p><span class="emphasis"><em>Be careful when using this
7391: target!</em></span> There are no guarantees that dependent
7392: packages will still work, in particular they will most
7393: certainly break if you <span><strong class="command">make replace</strong></span> a
7394: library package whose shared library major version changed
7395: between your installed version and the new one. For this
7396: reason, this target is not officially supported and only
7397: recommended for advanced users.</p>
7398: </dd>
7399: <dt><span class="term">info</span></dt>
7400: <dd><p>This target invokes <a 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
7401: package. You can use this to check which version of a
7402: package is installed.</p></dd>
7403: <dt><span class="term">index</span></dt>
7404: <dd>
7405: <p>This is a top-level command, i.e. it should be used in
7406: the <code class="filename">pkgsrc</code> directory. It creates a
7407: database of all packages in the local pkgsrc tree, including
7408: dependencies, comment, maintainer, and some other useful
7409: information. Individual entries are created by running
7410: <span><strong class="command">make describe</strong></span> in the packages'
7411: directories. This index file is saved as
7412: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7413: verbose format by running <span><strong class="command">make
7414: print-index</strong></span>. You can search in it with
7415: <span><strong class="command">make search
7416: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7417: extract a list of all packages that depend on a particular
7418: one by running <span><strong class="command">make show-deps
7419: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7420: <p>Running this command takes a very long time, some
7421: hours even on fast machines!</p>
7422: </dd>
7423: <dt><span class="term">readme</span></dt>
7424: <dd>
7425: <p>This target generates a
7426: <code class="filename">README.html</code> file, which can be
7427: 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
7428: contain references to any packages which are in the
7429: <code class="varname">PACKAGES</code> directory on the local
7430: host. The generated files can be made to refer to URLs
7431: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7432: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7433: wanted to generate <code class="filename">README.html</code>
7434: files which pointed to binary packages on the local
7435: machine, in the directory
7436: <code class="filename">/usr/packages</code>, set
7437: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7438: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7439: <code class="varname">${PACKAGES}</code> directory and its
7440: subdirectories will be searched for all the binary
7441: packages.</p>
7442: <p>The target can be run at the toplevel or in category
7443: directories, in which case it descends recursively.</p>
7444: </dd>
7445: <dt><span class="term">readme-all</span></dt>
7446: <dd><p>This is a top-level command, run it in
7447: <code class="filename">pkgsrc</code>. Use this target to create a
7448: file <code class="filename">README-all.html</code> which contains a
7449: list of all packages currently available in the NetBSD
7450: Packages Collection, together with the category they belong
7451: to and a short description. This file is compiled from the
7452: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7453: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7454: readme</strong></span>.</p></dd>
7455: <dt><span class="term">cdrom-readme</span></dt>
7456: <dd><p>This is very much the same as the
7457: “<span class="quote">readme</span>” target (see above), but is to be
7458: used when generating a pkgsrc tree to be written to a
7459: CD-ROM. This target also produces
7460: <code class="filename">README.html</code> files, and can be made
7461: to refer to URLs based on
7462: <code class="varname">CDROM_PKG_URL_HOST</code> and
7463: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7464: <dt><span class="term">show-distfiles</span></dt>
7465: <dd><p>This target shows which distfiles and patchfiles
7466: are needed to build the package
7467: (<code class="varname">ALLFILES</code>, which contains all
7468: <code class="varname">DISTFILES</code> and
7469: <code class="varname">PATCHFILES</code>, but not
7470: <code class="filename">patches/*</code>).</p></dd>
7471: <dt><span class="term">show-downlevel</span></dt>
7472: <dd><p>This target shows nothing if the package is not
7473: installed. If a version of this package is installed,
7474: but is not the version provided in this version of
7475: pkgsrc, then a warning message is displayed. This target
7476: can be used to show which of your installed packages are
7477: downlevel, and so the old versions can be deleted, and
7478: the current ones added.</p></dd>
7479: <dt><span class="term">show-pkgsrc-dir</span></dt>
7480: <dd><p>This target shows the directory in the pkgsrc
7481: hierarchy from which the package can be built and
7482: installed. This may not be the same directory as the one
7483: from which the package was installed. This target is
7484: intended to be used by people who may wish to upgrade
7485: many packages on a single host, and can be invoked from
7486: the top-level pkgsrc Makefile by using the
7487: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
7488: <dt><span class="term">show-installed-depends</span></dt>
7489: <dd><p>This target shows which installed packages match
7490: the current package's <code class="varname">DEPENDS</code>. Useful
7491: if out of date dependencies are causing build
7492: problems.</p></dd>
7493: <dt><span class="term">check-shlibs</span></dt>
7494: <dd><p>After a package is installed, check all its
7495: binaries and (on ELF platforms) shared libraries to see
7496: if they find the shared libs they need. Run by default
1.4 rillig 7497: if <code class="varname">PKG_DEVELOPER</code> is set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1 dsieger 7498: <dt><span class="term">print-PLIST</span></dt>
7499: <dd>
7500: <p>After a “<span class="quote">make install</span>” from a new or
7501: upgraded pkg, this prints out an attempt to generate a
7502: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7503: -newer work/.extract_done</strong></span>. An attempt is made
7504: to care for shared libs etc., but it is
7505: <span class="emphasis"><em>strongly</em></span> recommended to review the
7506: result before putting it into
7507: <code class="filename">PLIST</code>. On upgrades, it's useful to
7508: diff the output of this command against an already
7509: existing <code class="filename">PLIST</code> file.</p>
7510: <p>If the package installs files via <a 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
7511: other methods that don't update file access times, be
7512: sure to add these files manually to your
7513: <code class="filename">PLIST</code>, as the “<span class="quote">find
7514: -newer</span>” command used by this target won't catch
7515: them!</p>
1.6 rillig 7516: <p>See <a href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span><strong class="command">make print-PLIST</strong></span>”</a> for more
1.1 dsieger 7517: information on this target.</p>
7518: </dd>
7519: <dt><span class="term">bulk-package</span></dt>
7520: <dd>
7521: <p>Used to do bulk builds. If an appropriate binary
7522: package already exists, no action is taken. If not, this
7523: target will compile, install and package it (and its
7524: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.6 rillig 7525: properly. See <a href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.1 dsieger 7526: After creating the binary package, the sources, the
7527: just-installed package and its required packages are
7528: removed, preserving free disk space.</p>
7529: <p><span class="emphasis"><em>Beware that this target may deinstall
7530: all packages installed on a system!</em></span></p>
7531: </dd>
7532: <dt><span class="term">bulk-install</span></dt>
7533: <dd>
7534: <p>Used during bulk-installs to install required
7535: packages. If an up-to-date binary package is available,
7536: it will be installed via <a 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,
7537: <span><strong class="command">make bulk-package</strong></span> will be executed,
7538: but the installed binary won't be removed.</p>
7539: <p>A binary package is considered
7540: “<span class="quote">up-to-date</span>” to be installed via
7541: <a 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>
7542: <div class="itemizedlist"><ul type="disc">
7543: <li><p>None of the package's files
7544: (<code class="filename">Makefile</code>, ...) were modified
7545: since it was built.</p></li>
7546: <li><p>None of the package's required (binary)
7547: packages were modified since it was built.</p></li>
7548: </ul></div>
7549: <p><span class="emphasis"><em>Beware that this target may deinstall
7550: all packages installed on a system!</em></span></p>
7551: </dd>
7552: </dl></div>
7553: </div>
7554: </div>
7555: <div class="chapter" lang="en">
7556: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7557: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7558: <div class="toc">
7559: <p><b>Table of Contents</b></p>
7560: <dl>
1.6 rillig 7561: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7562: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7563: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7564: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7565: </dl>
7566: </div>
7567: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7568: by pkgsrc and also for individual packages to define what commands
7569: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7570: or for later run-time of an installed packaged (such as
7571: <code class="varname">DEPENDS</code>).
7572: If the native system provides an adequate tool, then in many cases, a pkgsrc
7573: package will not be used.</p>
7574: <p>When building a package, the replacement tools are
7575: made available in a directory (as symlinks or wrapper scripts)
7576: that is early in the executable search path. Just like the buildlink
7577: system, this helps with consistent builds.</p>
7578: <p>A tool may be needed to help build a specific package. For example,
7579: perl, GNU make (gmake) or yacc may be needed.</p>
7580: <p>Also a tool may be needed, for example, because the native system's supplied
7581: tool may be inefficient for building a package with pkgsrc.
7582: For example, a package may need GNU awk, bison (instead of
7583: yacc) or a better sed.</p>
7584: <p>The tools used by a package can be listed by running
7585: <span><strong class="command">make show-tools</strong></span>.</p>
7586: <div class="sect1" lang="en">
7587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7588: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7589: <p>The default set of tools used by pkgsrc is defined in
7590: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
7591: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7592: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7593: These can be seen by running:
7594: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7595: <p>If a package needs a specific program to build
7596: then the <code class="varname">USE_TOOLS</code> variable can be used
7597: to define the tools needed.</p>
7598: </div>
7599: <div class="sect1" lang="en">
7600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7601: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.1 dsieger 7602: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
7603: and not the native version for a build dependency.
7604: And the :run means that it is used for a
7605: run-time dependencies also (and becomes a DEPENDS).
7606: The default is a build dependency which can be set with
7607: :build. (So in this example, it is the same as gmake:build
7608: and pkg-config:build.)</p>
7609: <pre class="programlisting">
7610: USE_TOOLS+= mktemp:pkgsrc
7611: USE_TOOLS+= gmake perl:run pkg-config
7612: </pre>
7613: <p>When using the tools framework, a
7614: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7615: which contains the full path to the appropriate tool. For example,
7616: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
7617: on Linux systems.</p>
7618: <p>If you always need a pkgsrc version of the
7619: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7620: </p>
7621: </div>
7622: <div class="sect1" lang="en">
7623: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7624: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7625: <p>When improving or porting pkgsrc to a new platform, have a look
7626: at (or create) the corresponding platform specific make file fragment under
7627: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7628: the name of the common tools. For example:</p>
7629: <pre class="programlisting">
7630: .if exists(/usr/bin/bzcat)
7631: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7632: .elif exists(/usr/bin/bzip2)
7633: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7634: .endif
7635:
7636: TOOLS_PLATFORM.true?= true # shell builtin
7637: </pre>
7638: </div>
7639: <div class="sect1" lang="en">
7640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7641: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.1 dsieger 7642: <div class="qandaset">
7643: <dl>
1.6 rillig 7644: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7645: </dt>
1.6 rillig 7646: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7647: tools?</a>
7648: </dt>
1.6 rillig 7649: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7650: package is using while being built? I want to know whether it
7651: uses sed or not.</a>
7652: </dt>
7653: </dl>
7654: <table border="0" summary="Q and A Set">
7655: <col align="left" width="1%">
7656: <tbody>
7657: <tr class="question">
7658: <td align="left" valign="top">
1.7 rillig 7659: <a name="tools.new"></a><a name="id2708188"></a><b>18.4.1.</b>
1.1 dsieger 7660: </td>
7661: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7662: </tr>
7663: <tr class="answer">
7664: <td align="left" valign="top"></td>
7665: <td align="left" valign="top"><p>TODO</p></td>
7666: </tr>
7667: <tr class="question">
7668: <td align="left" valign="top">
1.7 rillig 7669: <a name="tools.listall"></a><a name="id2708198"></a><b>18.4.2.</b>
1.1 dsieger 7670: </td>
7671: <td align="left" valign="top"><p>How do I get a list of all available
7672: tools?</p></td>
7673: </tr>
7674: <tr class="answer">
7675: <td align="left" valign="top"></td>
7676: <td align="left" valign="top"><p>TODO</p></td>
7677: </tr>
7678: <tr class="question">
7679: <td align="left" valign="top">
1.7 rillig 7680: <a name="tools.used"></a><a name="id2708209"></a><b>18.4.3.</b>
1.1 dsieger 7681: </td>
7682: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7683: package is using while being built? I want to know whether it
7684: uses sed or not.</p></td>
7685: </tr>
7686: <tr class="answer">
7687: <td align="left" valign="top"></td>
7688: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7689: to do it.)</p></td>
7690: </tr>
7691: </tbody>
7692: </table>
7693: </div>
7694: </div>
7695: </div>
7696: <div class="chapter" lang="en">
7697: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7698: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7699: <div class="toc">
7700: <p><b>Table of Contents</b></p>
7701: <dl>
1.6 rillig 7702: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7703: <dd><dl>
1.6 rillig 7704: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
7705: <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>
7706: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7707: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7708: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7709: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7710: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7711: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7712: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7713: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7714: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7715: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7716: </dl></dd>
7717: <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>
7718: <dd><dl>
7719: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7720: <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>
7721: </dl></dd>
7722: <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>
7723: <dd><dl>
7724: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7725: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7726: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7727: </dl></dd>
7728: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7729: <dd><dl>
7730: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7731: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7732: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7733: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7734: </dl></dd>
7735: <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>
7736: <dd><dl>
7737: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7738: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
7739: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7740: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7741: </dl></dd>
7742: <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>
7743: <dd><dl>
7744: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7745: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7746: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7747: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7748: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7749: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7750: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7751: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7752: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 7753: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
7754: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7755: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7756: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7757: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7758: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7759: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7760: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7761: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7762: emulation</a></span></dt>
1.6 rillig 7763: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7764: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7765: </dl></dd>
1.6 rillig 7766: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7767: </dl>
7768: </div>
7769: <div class="sect1" lang="en">
7770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7771: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 7772: <div class="sect2" lang="en">
7773: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7774: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7775: <p>One appealing feature of pkgsrc is that it runs on many
7776: different platforms. As a result, it is important to ensure,
7777: where possible, that packages in pkgsrc are portable. This
7778: chapter mentions some particular details you should pay
7779: attention to while working on pkgsrc.</p>
7780: </div>
7781: <div class="sect2" lang="en">
7782: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7783: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 7784: </h3></div></div></div>
7785: <p>The pkgsrc user can configure pkgsrc by overriding several
7786: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.4 rillig 7787: which is <a href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7788: want to use those variables in the preprocessor directives of
7789: <a 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
7790: <code class="literal">.for</code>), you need to include the file
7791: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7792: loads the user preferences.</p>
7793: <p>But note that some variables may not be completely defined
7794: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7795: included, as they may contain references to variables that are
7796: not yet defined. In shell commands this is no problem, since
7797: variables are actually macros, which are only expanded when they
7798: are used. But in the preprocessor directives mentioned above and
7799: in dependency lines (of the form <code class="literal">target:
7800: dependencies</code>) the variables are expanded at load
7801: time.</p>
7802: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7803: <h3 class="title">Note</h3>
7804: <p>Currently there is no exhaustive list of all
7805: variables that tells you whether they can be used at load time
7806: or only at run time, but it is in preparation.</p>
7807: </div>
7808: </div>
7809: <div class="sect2" lang="en">
7810: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7811: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7812: <p>Occasionally, packages require interaction from the user,
7813: and this can be in a number of ways:</p>
7814: <div class="itemizedlist"><ul type="disc">
7815: <li><p>When fetching the distfiles, some packages require user
7816: interaction such as entering username/password or accepting a
7817: license on a web page.</p></li>
7818: <li><p>When extracting the distfiles, some packages may ask for
7819: passwords.</p></li>
7820: <li><p>help to configure the package before it is built</p></li>
7821: <li><p>help during the build process</p></li>
7822: <li><p>help during the installation of a package</p></li>
7823: </ul></div>
7824: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7825: provided to notify the pkgsrc mechanism of an interactive stage
7826: which will be needed, and this should be set in the package's
7827: <code class="filename">Makefile</code>, e.g.:</p>
7828: <pre class="programlisting">
7829: INTERACTIVE_STAGE= build
7830: </pre>
7831: <p>Multiple interactive stages can be specified:</p>
7832: <pre class="programlisting">
7833: INTERACTIVE_STAGE= configure install
7834: </pre>
7835: <p>The user can then decide to skip this package by setting the
7836: <code class="varname">BATCH</code> variable.</p>
7837: </div>
7838: <div class="sect2" lang="en">
7839: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7840: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7841: <p>Authors of software can choose the licence under which
7842: software can be copied. This is due to copyright law, and reasons
7843: for license choices are outside the scope of pkgsrc. The pkgsrc
7844: system recognizes that there are a number of licenses which some
7845: users may find objectionable or difficult or impossible to comply
7846: with. The Free Software Foundation has declared some licenses
7847: "Free", and the Open Source Initiative has a definition of "Open
7848: Source". The pkgsrc system, as a policy choice, does not label
7849: packages which have licenses that are Free or Open Source.
7850: However, packages without a license meeting either of those tests
7851: are labeled with a license tag denoting the license. Note that a
7852: package with no license to copy trivially does not meet either the
7853: Free or Open Source test.</p>
7854: <p>For packages which are not Free or Open Source, pkgsrc will
7855: not build the package unless the user has indicated to pkgsrc that
7856: packages with that particular license may be built. Note that
7857: this documentation avoids the term "accepted the license". The
7858: pkgsrc system is merely providing a mechanism to avoid
7859: accidentally building a package with a non-free license;
7860: judgement and responsibility remain with the user. (Installation
7861: of binary packages are not currently subject to this mechanism;
7862: this is a bug.)</p>
7863: <p>One might want to only install packages with a BSD license,
7864: or the GPL, and not the other. The pkgsrc license tag mechanism
7865: does not provide a way to do this. It might be possible to put in
7866: tags for free licenses, and have a default
7867: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7868: widely viewed as having a very poor ratio of benefit to
7869: work.</p>
7870: <p>The license tag mechanism is intended to address
7871: copyright-related issues surrounding building, installing and
7872: using a package, and not to address redistribution issues (see
7873: <code class="varname">RESTRICTED</code> and
7874: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7875: definition of licenses for which tags are not needed implies
7876: that packages with redistribution restrictions should have
7877: tags, because Free or Open Source programs do not have
7878: redistribution restrictions.</p>
7879: <p>Denoting that a package may be copied according to a
7880: particular license is done by placing the license in
7881: <code class="filename">pkgsrc/licenses</code> and setting the
7882: <code class="varname">LICENSE</code> variable to a string identifying the
7883: 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>
7884: <pre class="programlisting">
7885: LICENSE= xv-license
7886: </pre>
7887: <p>When trying to build, the user will get a notice that the
7888: package is covered by a license which has not been placed in the
7889: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7890: <pre class="programlisting">
7891: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7892: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7893: ===> To view the license, enter "/usr/bin/make show-license".
7894: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7895: ===> ACCEPTABLE_LICENSES+=xv-license
7896: *** Error code 1
7897: </pre>
7898: <p>The license can be viewed with <span><strong class="command">make
7899: show-license</strong></span>, and if the user so chooses, the line
1.4 rillig 7900: printed above can be added to <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7901: convey to pkgsrc that it should not in the future fail because of
7902: that license:</p>
7903: <pre class="programlisting">
7904: ACCEPTABLE_LICENSES+=xv-license
7905: </pre>
7906: <p>When adding a package with a new license, the license text
7907: should be added to <code class="filename">pkgsrc/licenses</code> for
7908: displaying. A list of known licenses can be seen in this
7909: directory.</p>
7910: <p>When the license changes (in a way other than formatting),
7911: please make sure that the new license has a different name (e.g.,
7912: append the version number if it exists, or the date). Just
7913: because a user told pkgsrc to build programs under a previous
7914: version of a license does not mean that pkgsrc should build
7915: programs under the new licenses. The higher-level point is that
7916: pkgsrc does not evaluate licenses for reasonableness; the only
7917: test is a mechanistic test of whether a particular text has been
7918: approved by either of two bodies.</p>
7919: <p>The use of <code class="varname">LICENSE=shareware</code>,
7920: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7921: is deprecated because it does not crisply refer to a particular
7922: license text. Another problem with such usage is that it does not
7923: enable a user to tell pkgsrc to proceed for a single package
7924: without also telling pkgsrc to proceed for all packages with that
7925: tag.</p>
7926: </div>
7927: <div class="sect2" lang="en">
7928: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7929: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7930: <p>Some licenses restrict how software may be re-distributed.
7931: Because a license tag is required unless the package is Free or
7932: Open Source, all packages with restrictions should have license
7933: tags. By declaring the restrictions, package tools can
7934: automatically refrain from e.g. placing binary packages on FTP
7935: sites.</p>
7936: <p>There are four restrictions that may be encoded, which are
7937: the cross product of sources (distfiles) and binaries not being
7938: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7939: language in any license, and because non-Free licenses tend to be
7940: different from each other, pkgsrc adopts a definition of FTP and
7941: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7942: should not be made available over the Internet at no charge.
7943: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7944: made available on some kind of media, together with other source
7945: and binary packages, and which is sold for a distribution charge.
7946: </p>
7947: <p>In order to encode these restrictions, the package system
7948: defines five make variables that can be set to note these
7949: restrictions:</p>
7950: <div class="itemizedlist"><ul type="disc">
7951: <li>
7952: <p><code class="varname">RESTRICTED</code></p>
7953: <p>This variable should be set whenever a restriction
7954: exists (regardless of its kind). Set this variable to a
7955: string containing the reason for the restriction. It should
7956: be understood that those wanting to understand the restriction
7957: will have to read the license, and perhaps seek advice of
7958: counsel.</p>
7959: </li>
7960: <li>
7961: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7962: <p>Binaries may not be placed on CD-ROM containing other
7963: binary packages, for which a distribution charge may be made.
7964: In this case, set this variable to
7965: <code class="varname">${RESTRICTED}</code>.</p>
7966: </li>
7967: <li>
7968: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7969: <p>Binaries may not made available on the Internet without
7970: charge. In this case, set this variable to
7971: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7972: binary packages will not be included on ftp.NetBSD.org.</p>
7973: </li>
7974: <li>
7975: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7976: <p>Distfiles may not be placed on CD-ROM, together with
7977: other distfiles, for which a fee may be charged. In this
7978: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7979: </p>
7980: </li>
7981: <li>
7982: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7983: <p>Distfiles may not made available via FTP at no charge.
7984: In this case, set this variable to
7985: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7986: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7987: </li>
7988: </ul></div>
7989: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
7990: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7991: generic make variables to denote restrictions is deprecated,
7992: because they unconditionally prevent users from generating
7993: binary packages!</p>
7994: </div>
7995: <div class="sect2" lang="en">
7996: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7997: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7998: <p>Your package may depend on some other package being present
7999: - and there are various ways of expressing this dependency.
8000: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
8001: <code class="varname">DEPENDS</code> definitions, the
8002: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
8003: via <code class="filename">buildlink3.mk</code>, which is the preferred way
8004: to handle dependencies, and which uses the variables named above.
1.6 rillig 8005: See <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 8006: <p>The basic difference between the two variables is as
8007: follows: The <code class="varname">DEPENDS</code> definition registers
8008: that pre-requisite in the binary package so it will be pulled in
8009: when the binary package is later installed, whilst the
8010: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
8011: dependency that is only needed for building the package.</p>
8012: <p>This means that if you only need a package present whilst
8013: you are building, it should be noted as a
8014: <code class="varname">BUILD_DEPENDS</code>.</p>
8015: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
8016: <code class="varname">DEPENDS</code> definition is:</p>
8017: <pre class="programlisting">
8018: <pre-req-package-name>:../../<category>/<pre-req-package>
8019: </pre>
8020: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
8021: may include any of the wildcard version numbers recognized by
8022: <a 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>
8023: <div class="orderedlist"><ol type="1">
8024: <li>
8025: <p>If your package needs another package's binaries or
8026: libraries to build or run, and if that package has a
8027: <code class="filename">buildlink3.mk</code> file available, use it:</p>
8028: <pre class="programlisting">
8029: .include "../../graphics/jpeg/buildlink3.mk"
8030: </pre>
8031: </li>
8032: <li>
8033: <p>If your package needs to use another package to build
8034: itself and there is no <code class="filename">buildlink3.mk</code>
8035: file available, use the <code class="varname">BUILD_DEPENDS</code>
8036: definition:</p>
8037: <pre class="programlisting">
8038: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
8039: </pre>
8040: </li>
8041: <li>
8042: <p>If your package needs a library with which to link and
8043: again there is no <code class="filename">buildlink3.mk</code> file
8044: available, this is specified using the
8045: <code class="varname">DEPENDS</code> definition. For example:</p>
8046: <pre class="programlisting">
8047: DEPENDS+= xpm-3.4j:../../graphics/xpm
8048: </pre>
8049: <p>You can also use wildcards in package dependences:</p>
8050: <pre class="programlisting">
8051: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
8052: </pre>
8053: <p>Note that such wildcard dependencies are retained when
8054: creating binary packages. The dependency is checked when
8055: installing the binary package and any package which matches
8056: the pattern will be used. Wildcard dependencies should be
8057: used with care.</p>
8058: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
8059: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
8060: such as “<span class="quote">tk-postgresql</span>” matching a
8061: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
8062: <p>Wildcards can also be used to specify that a package
8063: will only build against a certain minimum version of a
8064: pre-requisite:</p>
8065: <pre class="programlisting">
8066: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
8067: </pre>
8068: <p>This means that the package will build against version
8069: 3.5.4 of the tiff library or newer. Such a dependency may
8070: be warranted if, for example, the API of the library has
8071: changed with version 3.5.4 and a package would not compile
8072: against an earlier version of tiff.</p>
8073: <p>Please note that such dependencies should only be
8074: updated if a package requires a newer pre-requisite, but
8075: not to denote recommendations such as
8076: ABI changes that do not prevent a package from building
8077: correctly. Such recommendations can be expressed using
8078: <code class="varname">ABI_DEPENDS</code>:</p>
8079: <pre class="programlisting">
8080: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
8081: </pre>
8082: <p>In addition to the above <code class="varname">DEPENDS</code>
8083: line, this denotes that while a package will build against
8084: tiff>=3.5.4, at least version 3.6.1 is recommended.
8085: <code class="varname">ABI_DEPENDS</code> entries will be turned into
8086: dependencies unless explicitly ignored (in which case a
8087: warning will be printed).</p>
8088: <p>To ignore these ABI dependency recommendations and just
8089: use the required <code class="varname">DEPENDS</code>, set
8090: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
8091: it easier and faster to update packages built using pkgsrc,
8092: since older compatible dependencies can continue to be
8093: used. This is useful for people who watch their rebuilds
8094: very carefully; it is not very good as a general-purpose
8095: hammer. If you use it, you need to be mindful of possible
8096: ABI changes, including those from the underlying OS.</p>
8097: <p>Packages that are built with recommendations ignored
8098: may not be uploaded to ftp.NetBSD.org by developers and
8099: should not be used across different systems that may have
8100: different versions of binary packages installed.</p>
8101: <p>For security fixes, please update the package
1.6 rillig 8102: vulnerabilities file. See <a 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 8103: information.</p>
8104: </li>
8105: <li>
8106: <p>If your package needs some executable to be able to run
8107: correctly and if there's no
8108: <code class="filename">buildlink3.mk</code> file, this is specified
8109: using the <code class="varname">DEPENDS</code> variable. The
8110: <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
8111: be able to execute the latex binary from the teTeX package
8112: when it runs, and that is specified:</p>
8113: <pre class="programlisting">
8114: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
8115: </pre>
8116: <p>The comment about wildcard dependencies from previous
8117: paragraph applies here, too.</p>
8118: </li>
8119: </ol></div>
8120: <p>If your package needs files from another package to build,
8121: add the relevant distribution files to
8122: <code class="varname">DISTFILES</code>, so they will be extracted
8123: 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.
8124: (It relies on the jpeg sources being present in source form
8125: during the build.)</p>
8126: </div>
8127: <div class="sect2" lang="en">
8128: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8129: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 8130: <p>Your package may conflict with other packages a user might
8131: already have installed on his system, e.g. if your package
8132: installs the same set of files as another package in the pkgsrc
8133: tree.</p>
8134: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8135: space-separated list of packages (including version string) your
8136: package conflicts with.</p>
8137: <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>
8138: 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>
8139: install the same shared library, thus you set in
8140: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8141: <pre class="programlisting">
8142: CONFLICTS= Xaw-Xpm-[0-9]*
8143: </pre>
8144: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8145: <pre class="programlisting">
8146: CONFLICTS= Xaw3d-[0-9]*
8147: </pre>
8148: <p>Packages will automatically conflict with other packages
8149: with the name prefix and a different version
8150: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8151: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
8152: </div>
8153: <div class="sect2" lang="en">
8154: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8155: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 8156: <p>There are several reasons why a package might be
8157: instructed to not build under certain circumstances. If the
8158: package builds and runs on most platforms, the exceptions
8159: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8160: the package builds and runs on a small handful of platforms,
8161: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8162: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8163: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8164: (OS-version-platform) that can use glob-style
8165: wildcards.</p>
8166: <p>Some packages are tightly bound to a specific version of an
8167: 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
8168: backwards compatible with other versions of the OS, and should be
8169: uploaded to a version specific directory on the FTP server. Mark
8170: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8171: “<span class="quote">yes</span>”. This variable is not currently used by any of
8172: the package system internals, but may be used in the
8173: future.</p>
8174: <p>If the package should be skipped (for example, because it
8175: provides functionality already provided by the system), set
8176: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8177: the package should fail because some preconditions are not met,
8178: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8179: message.</p>
8180: </div>
8181: <div class="sect2" lang="en">
8182: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8183: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 8184: <p>To ensure that a package may not be deleted, once it has been
8185: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8186: be set in the package Makefile. This will be carried into any
8187: binary package that is made from this pkgsrc entry. A
8188: “<span class="quote">preserved</span>” package will
8189: not be deleted using <a 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
8190: “<span class="quote">-f</span>” option is used.</p>
8191: </div>
8192: <div class="sect2" lang="en">
8193: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8194: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8195: <p>When a vulnerability is found, this should be noted in
8196: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8197: and after committing that file, use <span><strong class="command">make upload</strong></span>
8198: in the same directory to update the file on ftp.NetBSD.org.</p>
8199: <p>After fixing the vulnerability by a patch, its
8200: <code class="varname">PKGREVISION</code> should be increased (this
8201: is of course not necessary if the problem is fixed by using
8202: a newer release of the software).</p>
8203: <p>Also, if the fix should be applied to the stable pkgsrc
8204: branch, be sure to submit a pullup request!</p>
8205: <p>Binary packages already on ftp.NetBSD.org will be handled
8206: semi-automatically by a weekly cron job.</p>
8207: </div>
8208: <div class="sect2" lang="en">
8209: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8210: <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 8211: <p>When making fixes to an existing package it can be useful
8212: to change the version number in <code class="varname">PKGNAME</code>. To
8213: avoid conflicting with future versions by the original author, a
8214: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8215: on package versions by setting <code class="varname">PKGREVISION=1</code>
8216: (2, ...). The “<span class="quote">nb</span>” is treated like a
8217: “<span class="quote">.</span>” by the package tools. e.g.</p>
8218: <pre class="programlisting">
8219: DISTNAME= foo-17.42
8220: PKGREVISION= 9
8221: </pre>
8222: <p>will result in a <code class="varname">PKGNAME</code> of
8223: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8224: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8225: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8226: <code class="varname">PKGNAME_NOREV</code>.</p>
8227: <p>When a new release of the package is released, the
8228: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8229: minor release of the above package, things should be like:</p>
8230: <pre class="programlisting">
8231: DISTNAME= foo-17.43
8232: </pre>
8233: <p><code class="varname">PKGREVISION</code> should be incremented for any
8234: non-trivial change in the resulting binary package. Without a
8235: <code class="varname">PKGREVISION</code> bump, someone with the previous
8236: version installed has no way of knowing that their package is out
8237: of date. Thus, changes without increasing
8238: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8239: trivial that no reasonable person would want to upgrade", and this
8240: is the rough test for when increasing
8241: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8242: changes that do not merit increasing
8243: <code class="varname">PKGREVISION</code> are:</p>
8244: <div class="itemizedlist"><ul type="disc">
8245: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8246: or comments in Makefile.</p></li>
8247: <li><p>
8248: Changing build variables if the resulting binary package is the same.</p></li>
8249: <li><p>
8250: Changing <code class="filename">DESCR</code>.</p></li>
8251: <li><p>
8252: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8253: </ul></div>
8254: <p>Examples of changes that do merit an increase to
8255: <code class="varname">PKGREVISION</code> include:</p>
8256: <div class="itemizedlist"><ul type="disc">
8257: <li><p>
8258: Security fixes</p></li>
8259: <li><p>
8260: Changes or additions to a patch file</p></li>
8261: <li><p>
8262: Changes to the <code class="filename">PLIST</code></p></li>
8263: </ul></div>
8264: <p>PKGREVISION must also be incremented when dependencies have ABI
8265: changes.</p>
8266: </div>
8267: <div class="sect2" lang="en">
8268: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8269: <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 8270: <p>When you want to replace the same text in multiple files
8271: or when the replacement text varies, patches alone cannot help.
8272: This is where the SUBST framework comes in. It provides an
8273: easy-to-use interface for replacing text in files.
8274: Example:</p>
8275: <pre class="programlisting">
8276: SUBST_CLASSES+= fix-paths
8277: SUBST_STAGE.fix-paths= pre-configure
8278: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8279: SUBST_FILES.fix-paths= src/*.c
8280: SUBST_FILES.fix-paths+= scripts/*.sh
8281: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8282: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8283: </pre>
8284: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8285: that are used to identify the different SUBST blocks that are
8286: defined. The SUBST framework is heavily used by pkgsrc, so it is
8287: important to always use the <code class="literal">+=</code> operator with
8288: this variable. Otherwise some substitutions may be
8289: skipped.</p>
8290: <p>The remaining variables of each SUBST block are
8291: parameterized with the identifier from the first line
8292: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8293: parameters to a function call.</p>
8294: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8295: which the replacement will take place. All combinations of
8296: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8297: <code class="literal">post-</code> together with a phase name are
8298: possible, though only few are actually used. Most commonly used
8299: are <code class="literal">post-patch</code> and
8300: <code class="literal">pre-configure</code>. Of these two,
8301: <code class="literal">pre-configure</code> should be preferred because
8302: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8303: have the state after applying the patches but before making any
8304: other changes. This is especially useful when you are debugging
8305: a package in order to create new patches for it. Similarly,
8306: <code class="literal">post-build</code> is preferred over
8307: <code class="literal">pre-install</code>, because the install phase should
8308: generally be kept as simple as possible. When you use
8309: <code class="literal">post-build</code>, you have the same files in the
8310: working directory that will be installed later, so you can check
8311: if the substitution has succeeded.</p>
8312: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8313: that is printed just before the substitution is done.</p>
8314: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8315: globbing patterns that specifies the files in which the
8316: substitution will take place. The patterns are interpreted
8317: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8318: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
8319: <a 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
8320: command should be prefixed with <code class="literal">-e</code>, so that
8321: all SUBST blocks look uniform.</p>
8322: <p>There are some more variables, but they are so seldomly
8323: used that they are only documented in the
8324: <code class="filename">mk/subst.mk</code> file.</p>
8325: </div>
8326: </div>
8327: <div class="sect1" lang="en">
8328: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8329: <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 8330: <div class="sect2" lang="en">
8331: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8332: <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 8333: <p>If you need to download from a dynamic URL you can set
8334: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8335: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8336: with the name of each file to download as an argument, expecting
8337: it to output the URL of the directory from which to download
8338: 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
8339: example of this usage.</p>
8340: <p>If the download can't be automated, because the user must
8341: submit personal information to apply for a password, or must pay
8342: for the source, or whatever, you can set
8343: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8344: displayed to the user before aborting the build. Example:</p>
8345: <pre class="programlisting">
8346: FETCH_MESSAGE= "Please download the files"
8347: FETCH_MESSAGE+= " "${DISTFILES:Q}
8348: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8349: </pre>
8350: </div>
8351: <div class="sect2" lang="en">
8352: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8353: <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 8354: <p>Sometimes authors of a software package make some
8355: modifications after the software was released, and they put up a
8356: new distfile without changing the package's version number. If a
8357: package is already in pkgsrc at that time, the checksum will
8358: no longer match. The contents of the new distfile should be
8359: compared against the old one before changing anything, to make
8360: sure the distfile was really updated on purpose, and that
8361: no trojan horse or so crept in.
8362: Please mention that the distfiles were compared and what was found
8363: in your commit message.
8364: Then, the correct way to work around this is to
8365: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8366: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8367: <code class="varname">DISTFILES</code> and
8368: <code class="varname">PATCHFILES</code> for this package will be put in that
8369: subdirectory of the local distfiles directory.
1.6 rillig 8370: (See <a 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 8371: In case this
8372: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8373: including the <code class="filename">nbX</code> suffix) or a date stamp
8374: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8375: Do not forget regenerating the <code class="filename">distinfo</code> file
8376: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8377: path in the filenames.
8378: Also increase the PKGREVISION if the installed package is different.
8379: Furthermore, a mail to the package's authors seems appropriate
8380: telling them that changing distfiles after releases without
8381: changing the file names is not good practice.</p>
8382: </div>
8383: </div>
8384: <div class="sect1" lang="en">
8385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8386: <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 8387: <div class="sect2" lang="en">
8388: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8389: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8390: <p>pkgsrc supports many different machines, with different
8391: object formats like a.out and ELF, and varying abilities to do
8392: shared library and dynamic loading at all. To accompany this,
8393: varying commands and options have to be passed to the
8394: compiler, linker, etc. to get the Right Thing, which can be
8395: pretty annoying especially if you don't have all the machines
8396: at your hand to test things. The
8397: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
8398: can help here, as it just “<span class="quote">knows</span>” how to build
8399: both static and dynamic libraries from a set of source files,
8400: thus being platform-independent.</p>
8401: <p>Here's how to use libtool in a package in seven simple
8402: steps:</p>
8403: <div class="orderedlist"><ol type="1">
8404: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
8405: Makefile.</p></li>
8406: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
8407: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8408: add it to the definition of <code class="varname">CC</code>, if only
8409: libraries are being built in a given Makefile. This one command
8410: will build both PIC and non-PIC library objects, so you need not
8411: have separate shared and non-shared library rules.</p></li>
8412: <li>
8413: <p>For the linking of the library, remove any
8414: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8415: -Bshareable</span>” commands, and instead use:</p>
8416: <pre class="programlisting">
8417: ${LIBTOOL} --mode=link \
8418: ${CC} -o ${.TARGET:.a=.la} \
8419: ${OBJS:.o=.lo} \
8420: -rpath ${PREFIX}/lib \
8421: -version-info major:minor
8422: </pre>
8423: <p>Note that the library is changed to have a
8424: <code class="filename">.la</code> extension, and the objects are
8425: changed to have a <code class="filename">.lo</code>
8426: extension. Change <code class="varname">OBJS</code> as
8427: necessary. This automatically creates all of the
8428: <code class="filename">.a</code>,
8429: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8430: necessary) in the build directory. Be sure to include
8431: “<span class="quote">-version-info</span>”, especially when major and
8432: minor are zero, as libtool will otherwise strip off the
8433: shared library version.</p>
8434: <p>From the libtool manual:</p>
8435: <pre class="programlisting">
8436: So, libtool library versions are described by three integers:
8437:
8438: CURRENT
8439: The most recent interface number that this library implements.
8440:
8441: REVISION
8442: The implementation number of the CURRENT interface.
8443:
8444: AGE
8445: The difference between the newest and oldest interfaces that
8446: this library implements. In other words, the library implements
8447: all the interface numbers in the range from number `CURRENT -
8448: AGE' to `CURRENT'.
8449:
8450: If two libraries have identical CURRENT and AGE numbers, then the
8451: dynamic linker chooses the library with the greater REVISION number.
8452: </pre>
8453: <p>The “<span class="quote">-release</span>” option will produce
8454: different results for a.out and ELF (excluding symlinks)
8455: in only one case. An ELF library of the form
8456: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8457: will have a symlink of
8458: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8459: on an a.out platform. This is handled
8460: automatically.</p>
8461: <p>The “<span class="quote">-rpath argument</span>” is the install
8462: directory of the library being built.</p>
8463: <p>In the <code class="filename">PLIST</code>, include only the
8464: <code class="filename">.la</code> file, the other files will be
8465: added automatically.</p>
8466: </li>
8467: <li>
8468: <p>When linking shared object (<code class="filename">.so</code>)
8469: files, i.e. files that are loaded via <a 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
8470: shared libraries, use “<span class="quote">-module
8471: -avoid-version</span>” to prevent them getting version
8472: tacked on.</p>
8473: <p>The <code class="filename">PLIST</code> file gets the
8474: <code class="filename">foo.so</code> entry.</p>
8475: </li>
8476: <li>
8477: <p>When linking programs that depend on these libraries
8478: <span class="emphasis"><em>before</em></span> they are installed, preface
8479: the <a 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 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}
8480: --mode=link</span>”, and it will find the correct
8481: libraries (static or shared), but please be aware that
8482: libtool will not allow you to specify a relative path in
8483: -L (such as “<span class="quote">-L../somelib</span>”), because it
8484: expects you to change that argument to be the
8485: <code class="filename">.la</code> file. e.g.</p>
8486: <pre class="programlisting">
8487: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8488: </pre>
8489: <p>should be changed to:</p>
8490: <pre class="programlisting">
8491: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8492: </pre>
8493: <p>and it will do the right thing with the libraries.</p>
8494: </li>
8495: <li>
8496: <p>When installing libraries, preface the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8497: or <a 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}
8498: --mode=install</span>”, and change the library name to
8499: <code class="filename">.la</code>. e.g.</p>
8500: <pre class="programlisting">
8501: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8502: </pre>
8503: <p>This will install the static <code class="filename">.a</code>,
8504: shared library, any needed symlinks, and run
8505: <a 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>
8506: </li>
8507: <li><p>In your <code class="filename">PLIST</code>, include only
8508: the <code class="filename">.la</code>
8509: file (this is a change from previous behaviour).</p></li>
8510: </ol></div>
8511: </div>
8512: <div class="sect2" lang="en">
8513: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8514: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8515: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8516: package Makefile. This will override the package's own libtool
8517: in most cases. For older libtool using packages, libtool is
8518: made by ltconfig script during the do-configure step; you can
8519: check the libtool script location by doing <span><strong class="command">make
8520: configure; find work*/ -name libtool</strong></span>.</p>
8521: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8522: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8523: default, it is set to “<span class="quote">libtool */libtool
8524: */*/libtool</span>”. If this does not match the location of the
8525: package's libtool script(s), set it as appropriate.</p>
8526: <p>If you do not need <code class="filename">*.a</code> static
8527: libraries built and installed, then use
8528: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8529: <p>If your package makes use of the platform-independent library
8530: for loading dynamic shared objects, that comes with libtool
8531: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8532: <p>Some packages use libtool incorrectly so that the package
8533: may not work or build in some circumstances. Some of the more
8534: common errors are:</p>
8535: <div class="itemizedlist"><ul type="disc">
8536: <li>
8537: <p>The inclusion of a shared object (-module) as a dependent library in an
8538: executable or library. This in itself isn't a problem if one of two things
8539: has been done:</p>
8540: <div class="orderedlist"><ol type="1">
8541: <li><p>The shared object is named correctly, i.e.
8542: <code class="filename">libfoo.la</code>, not
8543: <code class="filename">foo.la</code></p></li>
8544: <li><p>The -dlopen option is used when linking an executable.</p></li>
8545: </ol></div>
8546: </li>
8547: <li><p>The use of libltdl without the correct calls to initialisation routines.
8548: The function lt_dlinit() should be called and the macro
8549: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8550: executables.</p></li>
8551: </ul></div>
8552: </div>
8553: <div class="sect2" lang="en">
8554: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8555: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8556: <p>If a package needs GNU autoconf or automake to be executed
8557: to regenerate the configure script and Makefile.in makefile
8558: templates, then they should be executed in a pre-configure
8559: target.</p>
8560: <p>For packages that need only autoconf:</p>
8561: <pre class="programlisting">
8562: AUTOCONF_REQD= 2.50 # if default version is not good enough
8563: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8564: ...
8565:
8566: pre-configure:
8567: cd ${WRKSRC} && autoconf
8568:
8569: ...
8570: </pre>
8571: <p>and for packages that need automake and autoconf:</p>
8572: <pre class="programlisting">
8573: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8574: USE_TOOLS+= automake # use "automake14" for automake-1.4
8575: ...
8576:
8577: pre-configure:
8578: set -e; cd ${WRKSRC}; \
8579: aclocal; autoheader; automake -a --foreign -i; autoconf
8580:
8581: ...
8582: </pre>
8583: <p>Packages which use GNU Automake will almost certainly
8584: require GNU Make.</p>
8585: <p>There are times when the configure process makes
8586: additional changes to the generated files, which then causes
8587: the build process to try to re-execute the automake sequence.
8588: This is prevented by touching various files in the configure
8589: stage. If this causes problems with your package you can set
8590: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8591: Makefile.</p>
8592: </div>
8593: </div>
8594: <div class="sect1" lang="en">
8595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8596: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.1 dsieger 8597: <div class="sect2" lang="en">
8598: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8599: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8600: <p>Compilers for the C, C++, and Fortran languages comes with
8601: the NetBSD base system. By default, pkgsrc assumes that a package
8602: is written in C and will hide all other compilers (via the wrapper
1.6 rillig 8603: framework, see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8604: <p>To declare which language's compiler a package needs, set
8605: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8606: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8607: “<span class="quote">fortran</span>” (and any combination). The default is
8608: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8609: written in C++, usually need a C compiler for the configure
8610: phase.</p>
8611: </div>
8612: <div class="sect2" lang="en">
8613: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8614: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8615: <p>If a program is written in Java, use the Java framework in
8616: pkgsrc. The package must include
8617: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8618: provides the following variables:</p>
8619: <div class="itemizedlist"><ul type="disc">
8620: <li><p><code class="varname">USE_JAVA</code> defines if a build
8621: dependency on the JDK is added. If
8622: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8623: there is only a runtime dependency on the JDK. The default is
8624: “<span class="quote">yes</span>”, which also adds a build dependency on the
8625: JDK.</p></li>
8626: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8627: a package needs a Java2 implementation. The supported values
8628: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8629: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8630: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8631: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8632: above. This variable is not set by default.</p></li>
8633: </ul></div>
8634: </div>
8635: <div class="sect2" lang="en">
8636: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8637: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8638: <p>If your package contains interpreted perl scripts, add
8639: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8640: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8641: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8642: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8643: that you want adjusted. Every occurrence of
8644: <code class="filename">*/bin/perl</code> will be replaced with the full
8645: path to the perl executable.</p>
8646: <p>If a particular version of perl is needed, set the
8647: <code class="varname">PERL5_REQD</code> variable to the version number. The
8648: default is “<span class="quote">5.0</span>”.</p>
1.6 rillig 8649: <p>See <a 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 8650: about handling perl modules.</p>
8651: </div>
8652: <div class="sect2" lang="en">
8653: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8654: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1 dsieger 8655: <p>Currently, there is no special handling for other languages
8656: in pkgsrc. If a compiler package provides a
8657: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8658: just add a (build) dependency on the appropriate compiler
8659: package.</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.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8665: <p>The most common failures when building a package are that
8666: some platforms do not provide certain header files, functions or
8667: libraries, or they provide the functions in a library that the
8668: original package author didn't know. To work around this, you
8669: can rewrite the source code in most cases so that it does not
8670: use the missing functions or provides a replacement function.</p>
8671: <div class="sect2" lang="en">
8672: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8673: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8674: <p>If a package already comes with a GNU configure script, the
8675: preferred way to fix the build failure is to change the
8676: configure script, not the code. In the other cases, you can
8677: utilize the C preprocessor, which defines certain macros
8678: depending on the operating system and hardware architecture it
8679: compiles for. These macros can be queried using for example
8680: <code class="varname">#if defined(__i386)</code>. Almost every operating
8681: system, hardware architecture and compiler has its own macro.
8682: For example, if the macros <code class="varname">__GNUC__</code>,
8683: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8684: are all defined, you know that you are using NetBSD on an i386
8685: compatible CPU, and your compiler is GCC.</p>
8686: <p>The list of the following macros for hardware and
8687: operating system depends on the compiler that is used. For
8688: example, if you want to conditionally compile code on Solaris,
8689: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8690: does not define it. Use <code class="varname">__sun</code> instead.</p>
8691: <div class="sect3" lang="en">
8692: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8693: <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 8694: <p>To distinguish between 4.4 BSD-derived systems and the
8695: rest of the world, you should use the following code.</p>
8696: <pre class="programlisting">
8697: #include <sys/param.h>
8698: #if (defined(BSD) && BSD >= 199306)
8699: /* BSD-specific code goes here */
8700: #else
8701: /* non-BSD-specific code goes here */
8702: #endif
8703: </pre>
8704: <p>If this distinction is not fine enough, you can also test
8705: for the following macros.</p>
8706: <pre class="programlisting">
8707: FreeBSD __FreeBSD__
8708: DragonFly __DragonFly__
8709: Interix __INTERIX
8710: IRIX __sgi (TODO: get a definite source for this)
8711: Linux linux, __linux, __linux__
8712: NetBSD __NetBSD__
8713: OpenBSD __OpenBSD__
8714: Solaris sun, __sun
8715: </pre>
8716: </div>
8717: <div class="sect3" lang="en">
8718: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8719: <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 8720: <pre class="programlisting">
8721: i386 i386, __i386, __i386__
8722: MIPS __mips
8723: SPARC sparc, __sparc
8724: </pre>
8725: </div>
8726: <div class="sect3" lang="en">
8727: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8728: <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 8729: <pre class="programlisting">
8730: GCC __GNUC__ (major version), __GNUC_MINOR__
8731: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8732: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8733: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8734: </pre>
8735: </div>
8736: </div>
8737: <div class="sect2" lang="en">
8738: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8739: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8740: <p>Some source files trigger bugs in the compiler, based on
8741: combinations of compiler version and architecture and almost
8742: always relation to optimisation being enabled. Common symptoms
8743: are gcc internal errors or never finishing compiling a
8744: file.</p>
8745: <p>Typically, a workaround involves testing the
8746: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8747: optimisation for that combination of file,
8748: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8749: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8750: number of examples.</p>
8751: </div>
8752: <div class="sect2" lang="en">
8753: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8754: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.1 dsieger 8755: <p>This error message often means that a package did not
8756: link to a shared library it needs. The following functions are
8757: known to cause this error message over and over.</p>
8758: <div class="informaltable">
8759: <a name="undefined-reference-functions"></a><table border="1">
8760: <colgroup>
8761: <col>
8762: <col>
8763: <col>
8764: </colgroup>
8765: <thead><tr>
8766: <th>Function</th>
8767: <th>Library</th>
8768: <th>Affected platforms</th>
8769: </tr></thead>
8770: <tbody>
8771: <tr>
8772: <td>accept, bind, connect</td>
8773: <td>-lsocket</td>
8774: <td>Solaris</td>
8775: </tr>
8776: <tr>
8777: <td>crypt</td>
8778: <td>-lcrypt</td>
8779: <td>DragonFly, NetBSD</td>
8780: </tr>
8781: <tr>
8782: <td>dlopen, dlsym</td>
8783: <td>-ldl</td>
8784: <td>Linux</td>
8785: </tr>
8786: <tr>
8787: <td>gethost*</td>
8788: <td>-lnsl</td>
8789: <td>Solaris</td>
8790: </tr>
8791: <tr>
8792: <td>inet_aton</td>
8793: <td>-lresolv</td>
8794: <td>Solaris</td>
8795: </tr>
8796: <tr>
8797: <td>nanosleep, sem_*, timer_*</td>
8798: <td>-lrt</td>
8799: <td>Solaris</td>
8800: </tr>
8801: <tr>
8802: <td>openpty</td>
8803: <td>-lutil</td>
8804: <td>Linux</td>
8805: </tr>
8806: </tbody>
8807: </table>
8808: </div>
8809: <p>To fix these linker errors, it is often sufficient to say
8810: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8811: -l<em class="replaceable"><code>foo</code></em></code> to the package
8812: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8813: bmake</strong></span>.</p>
8814: <div class="sect3" lang="en">
8815: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8816: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8817: <p>When you are using the SunPro compiler, there is another
8818: possibility. That compiler cannot handle the following code:</p>
8819: <pre class="programlisting">
8820: extern int extern_func(int);
8821:
8822: static inline int
8823: inline_func(int x)
8824: {
8825: return extern_func(x);
8826: }
8827:
8828: int main(void)
8829: {
8830: return 0;
8831: }
8832: </pre>
8833: <p>It generates the code for <code class="function">inline_func</code> even if
8834: that function is never used. This code then refers to
8835: <code class="function">extern_func</code>, which can usually not be resolved. To
8836: solve this problem you can try to tell the package to disable inlining
8837: of functions.</p>
8838: </div>
8839: </div>
8840: <div class="sect2" lang="en">
8841: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8842: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8843: <p>Sometimes packages fail to build because the compiler runs
8844: into an operating system specific soft limit. With the
8845: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8846: to unlimit the resources. Currently, the allowed values are
8847: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8848: Setting this variable is similar to running the shell builtin
8849: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8850: segment size or maximum stack size of a process, respectively, to
8851: their hard limits.</p>
8852: </div>
8853: </div>
8854: <div class="sect1" lang="en">
8855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8856: <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 8857: <div class="sect2" lang="en">
8858: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8859: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.1 dsieger 8860: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
8861: with some operating systems cannot create more than one
8862: directory at a time. As such, you should call
8863: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8864: <pre class="programlisting">
8865: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8866: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8867: </pre>
8868: <p>You can also just append “<span class="quote"><code class="literal">dir1
8869: dir2</code></span>” to the
8870: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8871: automatically do the right thing.</p>
8872: </div>
8873: <div class="sect2" lang="en">
8874: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8875: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8876: <p>In general, documentation should be installed into
8877: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8878: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8879: includes the version number of the package).</p>
8880: <p>Many modern packages using GNU autoconf allow to set the
8881: directory where HTML documentation is installed with the
8882: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8883: is needed because otherwise the documentation ends up in
8884: <code class="filename">${PREFIX}/share/doc/html</code> or other
8885: places.</p>
8886: <p>An exception to the above is that library API documentation
8887: 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
8888: browsers (devhelp) should be left at their default location, which
8889: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8890: documentation can be recognized from files ending in
8891: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8892: (It is also acceptable to install such files in
8893: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8894: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8895: <code class="filename">.devhelp*</code> file must be directly in that
8896: directory then, no additional subdirectory level is allowed in
8897: this case. This is usually achieved by using
8898: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8899: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8900: though.)</p>
8901: </div>
8902: <div class="sect2" lang="en">
8903: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8904: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8905: <p>Certain packages, most of them in the games category, install
8906: a score file that allows all users on the system to record their
8907: highscores. In order for this to work, the binaries need to be
8908: installed setgid and the score files owned by the appropriate
8909: group and/or owner (traditionally the "games" user/group). The
8910: following variables, documented in more detail in
8911: <code class="filename">mk/defaults/mk.conf</code>, control this
8912: behaviour: <code class="varname">SETGIDGAME</code>,
8913: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8914: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
8915: <p>Note that per default, setgid installation of games is
8916: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8917: the other variables accordingly.</p>
8918: <p>A package should therefor never hard code file ownership or
8919: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8920: <code class="varname">INSTALL_GAME_DATA</code> to set these
8921: correctly.</p>
8922: </div>
8923: <div class="sect2" lang="en">
8924: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8925: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.4 rillig 8926: <div class="itemizedlist"><ul type="disc">
8927: <li><p>All installation operations have to be prefixed with
8928: <code class="filename">${DESTDIR}</code>.</p></li>
8929: <li><p>automake gets this DESTDIR mostly right
8930: automatically. Many manual rules and pre/post-install often are
8931: incorrect; fix them.</p></li>
8932: <li><p>If files are installed with special owner/group
8933: either use @owner/@group in the <code class="filename">PLIST</code>
8934: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8935: (discouraged). Note that @owner/@group are sticky during
8936: install, keep this in mind.</p></li>
8937: <li><p>In general, packages should support
8938: <code class="varname">UNPRIVILEGED</code> to be able to use
8939: DESTDIR.</p></li>
8940: </ul></div>
8941: </div>
8942: <div class="sect2" lang="en">
8943: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8944: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8945: <p>Your package may also contain scripts with hardcoded paths to
8946: other interpreters besides (or as well as) perl. To correct the
8947: full pathname to the script interpreter, you need to set the
8948: following definitions in your <code class="filename">Makefile</code> (we
8949: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8950: <pre class="programlisting">
8951: REPLACE_INTERPRETER+= tcl
8952: REPLACE.tcl.old= .*/bin/tclsh
8953: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8954: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8955: # relative to ${WRKSRC}, just as in REPLACE_PERL
8956: </pre>
8957: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8958: <h3 class="title">Note</h3>
8959: <p>Before March 2006, these variables were called
8960: <code class="varname">_REPLACE.*</code> and
8961: <code class="varname">_REPLACE_FILES.*</code>.</p>
8962: </div>
8963: </div>
8964: <div class="sect2" lang="en">
8965: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8966: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8967: <p>Makefiles of packages providing perl5 modules should include
8968: the Makefile fragment
8969: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8970: <span><strong class="command">do-configure</strong></span> target for the standard perl
8971: configuration for such modules as well as various hooks to tune
8972: this configuration. See comments in this file for
8973: details.</p>
8974: <p>Perl5 modules will install into different places depending
8975: on the version of perl used during the build process. To
8976: address this, pkgsrc will append lines to the
8977: <code class="filename">PLIST</code> corresponding to the files listed in
8978: the installed <code class="filename">.packlist</code> file generated by
8979: most perl5 modules. This is invoked by defining
8980: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8981: paths to packlist files, e.g.:</p>
8982: <pre class="programlisting">
8983: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8984: </pre>
8985: <p>The variables <code class="varname">PERL5_SITELIB</code>,
8986: <code class="varname">PERL5_SITEARCH</code>, and
8987: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8988: in which perl5 modules may be installed, and may be used by
8989: perl5 packages that don't have a packlist. These three
8990: variables are also substituted for in the
8991: <code class="filename">PLIST</code>.</p>
8992: </div>
8993: <div class="sect2" lang="en">
8994: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8995: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8996: <p>Some packages install info files or use the
8997: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8998: commands. <code class="varname">INFO_FILES</code> should be defined in
8999: the package Makefile so that <code class="filename">INSTALL</code> and
9000: <code class="filename">DEINSTALL</code> scripts will be generated to
9001: handle registration of the info files in the Info directory
9002: file. The “<span class="quote">install-info</span>” command used for the info
9003: files registration is either provided by the system, or by a
9004: special purpose package automatically added as dependency if
9005: needed.</p>
9006: <p><code class="varname">PKGINFODIR</code> is the directory under
9007: <code class="filename">${PREFIX}</code> where info files are primarily
9008: located. <code class="varname">PKGINFODIR</code> defaults to
9009: “<span class="quote">info</span>” and can be overridden by the user.</p>
9010: <p>The info files for the package should be listed in the
9011: package <code class="filename">PLIST</code>; however any split info files
9012: need not be listed.</p>
9013: <p>A package which needs the “<span class="quote">makeinfo</span>” command
9014: at build time must add “<span class="quote">makeinfo</span>” to
9015: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
9016: version of the “<span class="quote">makeinfo</span>” command is needed it
9017: should be noted with the <code class="varname">TEXINFO_REQD</code>
9018: variable in the package <code class="filename">Makefile</code>. By
9019: default, a minimum version of 3.12 is required. If the system
9020: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
9021: does not match the required minimum, a build dependency on the
9022: <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
9023: be added automatically.</p>
9024: <p>The build and installation process of the software provided
9025: by the package should not use the
9026: <span><strong class="command">install-info</strong></span> command as the registration of
9027: info files is the task of the package
9028: <code class="filename">INSTALL</code> script, and it must use the
9029: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
9030: <p>To achieve this goal, the pkgsrc infrastructure creates
9031: overriding scripts for the <span><strong class="command">install-info</strong></span> and
9032: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
9033: in <code class="varname">PATH</code>.</p>
9034: <p>The script overriding <span><strong class="command">install-info</strong></span> has
9035: no effect except the logging of a message. The script overriding
9036: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
9037: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
9038: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
9039: </div>
9040: <div class="sect2" lang="en">
9041: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9042: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9043: <p>All packages that install manual pages should install them
9044: into the same directory, so that there is one common place to look
9045: for them. In pkgsrc, this place is
9046: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9047: should be used in packages. The default for
9048: <code class="varname">PKGMANDIR</code> is
9049: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
9050: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
9051: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9052: <h3 class="title">Note</h3>
9053: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9054: is far from complete.</p>
9055: </div>
9056: <p>The <code class="filename">PLIST</code> files can just use
9057: <code class="filename">man/</code> as the top level directory for the man
9058: page file entries, and the pkgsrc framework will convert as
9059: needed. In all other places, the correct
9060: <code class="varname">PKGMANDIR</code> must be used.</p>
9061: <p>Packages that are
9062: configured with <code class="varname">GNU_CONFIGURE</code> set as
9063: “<span class="quote">yes</span>”, by default will use the
9064: <code class="filename">./configure</code>
9065: --mandir switch to set where the man pages should be installed.
9066: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9067: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9068: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9069: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
9070: to “<span class="quote">no</span>”.
9071: Or if the <code class="filename">./configure</code> script uses
9072: a non-standard use of --mandir, you can set
9073: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.6 rillig 9074: <p>See <a href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 9075: information on installation of compressed manual pages.</p>
9076: </div>
9077: <div class="sect2" lang="en">
9078: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 9079: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 9080: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 9081: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 9082: you need to take some extra steps to make sure they get registered
9083: in the database:</p>
9084: <div class="orderedlist"><ol type="1">
1.7 rillig 9085: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 9086: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 9087: takes care of rebuilding the GConf database at installation and
1.1 dsieger 9088: deinstallation time, and tells the package where to install
1.7 rillig 9089: GConf data files using some standard configure arguments. It
1.1 dsieger 9090: also disallows any access to the database directly from the
9091: package.</p></li>
9092: <li><p>Ensure that the package installs its
9093: <code class="filename">.schemas</code> files under
9094: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9095: installed under <code class="filename">${PREFIX}/etc</code>, you will
9096: need to manually patch the package.</p></li>
9097: <li><p>Check the PLIST and remove any entries under the etc/gconf
9098: directory, as they will be handled automatically. See
1.6 rillig 9099: <a 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 9100: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 9101: your <code class="filename">Makefile</code> with a list of all
9102: <code class="filename">.schemas</code> files installed by the package, if
9103: any. Names must not contain any directories in them.</p></li>
1.7 rillig 9104: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 9105: your <code class="filename">Makefile</code> with a
9106: list of all <code class="filename">.entries</code> files installed by the
9107: package, if any. Names must not contain any directories in
9108: them.</p></li>
9109: </ol></div>
9110: </div>
9111: <div class="sect2" lang="en">
9112: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9113: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.1 dsieger 9114: <p>If a package installs <code class="filename">.omf</code> files, used by
9115: scrollkeeper, you need to take some extra steps to make sure they
9116: get registered in the database:</p>
9117: <div class="orderedlist"><ol type="1">
9118: <li><p>Include
9119: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
9120: instead of its <code class="filename">buildlink3.mk</code> file. This
9121: takes care of rebuilding the scrollkeeper database at
9122: installation and deinstallation time, and disallows any access
9123: to it directly from the package.</p></li>
9124: <li><p>Check the PLIST and remove any entries under the
9125: <code class="filename">libdata/scrollkeeper</code> directory, as they
9126: will be handled automatically.</p></li>
9127: <li><p>Remove the <code class="filename">share/omf</code> directory from
9128: the PLIST. It will be handled by scrollkeeper.</p></li>
9129: </ol></div>
9130: </div>
9131: <div class="sect2" lang="en">
9132: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9133: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9134: <p>If a package installs font files, you will need to rebuild
9135: the fonts database in the directory where they get installed at
9136: installation and deinstallation time. This can be automatically
9137: done by using the pkginstall framework.</p>
9138: <p>You can list the directories where fonts are installed in the
9139: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9140: variables, where <em class="replaceable"><code>type</code></em> can be one of
9141: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9142: Also make sure that the database file
9143: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9144: <p>Note that you should not create new directories for fonts;
9145: instead use the standard ones to avoid that the user needs to
9146: manually configure his X server to find them.</p>
9147: </div>
9148: <div class="sect2" lang="en">
9149: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9150: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9151: <p>If a package installs GTK2 immodules or loaders, you need to
9152: take some extra steps to get them registered in the GTK2 database
9153: properly:</p>
9154: <div class="orderedlist"><ol type="1">
9155: <li><p>Include
9156: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9157: <code class="filename">buildlink3.mk</code> file. This takes care of
9158: rebuilding the database at installation and deinstallation time.</p></li>
9159: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9160: your package installs GTK2 immodules.</p></li>
9161: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9162: GTK2 loaders.</p></li>
9163: <li>
9164: <p>Patch the package to not touch any of the GTK2
9165: databases directly. These are:</p>
9166: <div class="itemizedlist"><ul type="disc">
9167: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9168: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
9169: </ul></div>
9170: </li>
9171: <li><p>Check the <code class="filename">PLIST</code> and remove
9172: any entries under the <code class="filename">libdata/gtk-2.0</code>
9173: directory, as they will be handled automatically.</p></li>
9174: </ol></div>
9175: </div>
9176: <div class="sect2" lang="en">
9177: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9178: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9179: <p>If a package installs SGML or XML data files that need to be
9180: registered in system-wide catalogs (like DTDs, sub-catalogs,
9181: etc.), you need to take some extra steps:</p>
9182: <div class="orderedlist"><ol type="1">
9183: <li><p>Include
9184: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9185: your <code class="filename">Makefile</code>, which takes care of
9186: registering those files in system-wide catalogs at
9187: installation and deinstallation time.</p></li>
9188: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
9189: any SGML catalogs installed by the package.</p></li>
9190: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
9191: any XML catalogs installed by the package.</p></li>
9192: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
9193: to be added to the SGML catalog. These come in groups of
9194: three strings; see xmlcatmgr(1) for more information
9195: (specifically, arguments recognized by the 'add' action).
9196: Note that you will normally not use this variable.</p></li>
9197: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
9198: to be added to the XML catalog. These come in groups of three
9199: strings; see xmlcatmgr(1) for more information (specifically,
9200: arguments recognized by the 'add' action). Note that you will
9201: normally not use this variable.</p></li>
9202: </ol></div>
9203: </div>
9204: <div class="sect2" lang="en">
9205: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9206: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9207: <p>If a package provides extensions to the MIME database by
9208: installing <code class="filename">.xml</code> files inside
9209: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9210: need to take some extra steps to ensure that the database is kept
9211: consistent with respect to these new files:</p>
9212: <div class="orderedlist"><ol type="1">
9213: <li><p>Include
9214: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9215: (avoid using the <code class="filename">buildlink3.mk</code> file from
9216: this same directory, which is reserved for inclusion from
9217: other <code class="filename">buildlink3.mk</code> files). It takes
9218: care of rebuilding the MIME database at installation and
9219: deinstallation time, and disallows any access to it directly
9220: from the package.</p></li>
9221: <li><p>Check the PLIST and remove any entries under the
9222: <code class="filename">share/mime</code> directory,
9223: <span class="emphasis"><em>except</em></span> for files saved under
9224: <code class="filename">share/mime/packages</code>. The former are
9225: handled automatically by
9226: the update-mime-database program, but the latter are
9227: package-dependent and must be removed by the package that
9228: installed them in the first place.</p></li>
9229: <li><p>Remove any <code class="filename">share/mime/*</code> directories
9230: from the PLIST. They will be handled by the shared-mime-info
9231: package.</p></li>
9232: </ol></div>
9233: </div>
9234: <div class="sect2" lang="en">
9235: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9236: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9237: <p>If a package uses intltool during its build, add
9238: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9239: which forces it to use the intltool package provided by pkgsrc,
9240: instead of the one bundled with the distribution file.</p>
9241: <p>This tracks intltool's build-time dependencies and uses the
9242: latest available version; this way, the package benefits of any
9243: bug fixes that may have appeared since it was released.</p>
9244: </div>
9245: <div class="sect2" lang="en">
9246: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9247: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9248: <p>If a package contains a rc.d script, it won't be copied into
9249: the startup directory by default, but you can enable it, by adding
9250: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.4 rillig 9251: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9252: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9253: it will automatically remove the scripts when the package is
9254: deinstalled.</p>
9255: </div>
9256: <div class="sect2" lang="en">
9257: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9258: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9259: <p>If a package installs TeX packages into the texmf tree,
9260: the <code class="filename">ls-R</code> database of the tree needs to be
9261: updated.</p>
9262: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9263: <h3 class="title">Note</h3>
9264: <p>Except the main TeX packages such as teTeX-texmf,
9265: packages should install files
9266: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9267: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
9268: </div>
9269: <div class="orderedlist"><ol type="1">
9270: <li><p>Include
9271: <code class="filename">../../print/teTeX/module.mk</code> instead
9272: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9273: takes care of rebuilding the <code class="filename">ls-R</code>
9274: database at installation and deinstallation time.</p></li>
9275: <li>
9276: <p>If your package installs files into a texmf
9277: tree other than the one
9278: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9279: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9280: trees that need database update.</p>
9281: <p>If your package also installs font map files that need
9282: to be registered using <span><strong class="command">updmap</strong></span>,
9283: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9284: such font map files. Then <span><strong class="command">updmap</strong></span> will
9285: be run automatically at installation/deinstallation to
9286: enable/disable font map files for TeX output
9287: drivers.</p>
9288: </li>
9289: <li><p>Make sure that none of <code class="filename">ls-R</code>
9290: databases are included in <code class="filename">PLIST</code>, as
9291: they will be removed only by the teTeX-bin package.</p></li>
9292: </ol></div>
9293: </div>
9294: <div class="sect2" lang="en">
9295: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9296: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9297: emulation</h3></div></div></div>
9298: <p>There are some packages that provide libraries and
9299: executables for running binaries from a one operating system
9300: on a different one (if the latter supports it). One example
9301: is running Linux binaries on NetBSD.</p>
9302: <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>
9303: helps in extracting and packaging Linux rpm packages.</p>
9304: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9305: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9306: if all libraries for each installed executable can be found by
9307: the dynamic linker. Since the standard dynamic linker is run,
9308: this fails for emulation packages, because the libraries used
9309: by the emulation are not in the standard directories.</p>
9310: </div>
9311: <div class="sect2" lang="en">
9312: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9313: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9314: <p>If a package installs images under the
9315: <code class="filename">share/icons/hicolor</code> and/or updates the
9316: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9317: database, you need to take some extra steps to make sure that the
9318: shared theme directory is handled appropriately and that the cache
9319: database is rebuilt:</p>
9320: <div class="orderedlist"><ol type="1">
9321: <li><p>Include
9322: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9323: <li><p>Check the <code class="filename">PLIST</code> and remove the
9324: entry that refers to the theme cache.</p></li>
9325: <li><p>Ensure that the PLIST does not remove the shared icon
9326: directories from the <code class="filename">share/icons/hicolor</code>
9327: hierarchy because they will be handled automatically.</p></li>
9328: </ol></div>
9329: <p>The best way to verify that the PLIST is correct with
9330: respect to the last two points is to regenerate it using
9331: <span><strong class="command">make print-PLIST</strong></span>.</p>
9332: </div>
9333: <div class="sect2" lang="en">
9334: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9335: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9336: <p>If a package installs <code class="filename">.desktop</code> files
9337: under <code class="filename">share/applications</code> and these include
9338: MIME information, you need to take extra steps to ensure that they
9339: are registered into the MIME database:</p>
9340: <div class="orderedlist"><ol type="1">
9341: <li><p>Include
9342: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9343: <li><p>Check the PLIST and remove the entry that refers to the
9344: <code class="filename">share/applications/mimeinfo.cache</code> file.
9345: It will be handled automatically.</p></li>
9346: </ol></div>
9347: <p>The best way to verify that the PLIST is correct with
9348: respect to the last point is to regenerate it using <span><strong class="command">make
9349: print-PLIST</strong></span>.</p>
9350: </div>
9351: </div>
9352: <div class="sect1" lang="en">
9353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9354: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9355: <p>In some cases one does not have the time to solve a problem
9356: immediately. There are currently two ways to declare that one knows
9357: that a package has problems.</p>
9358: <div class="itemizedlist"><ul type="disc">
9359: <li><p>The first way is to plainly mark it as broken. For
9360: this, one just sets the variable <code class="varname">BROKEN</code> to the
9361: reason why the package is broken (similar to the
9362: <code class="varname">RESTRICTED</code> variable). A user trying to build
9363: the package will immediately be shown this message, and the build
9364: will not be even tried.</p></li>
9365: <li><p>After each pkgsrc freeze period (a time when the
9366: tree is stabilized and a new pkgsrc branch is cut), the packages
9367: that were not building in the official branch build on the latest
9368: NetBSD release will be marked as broken on that branch. This is
9369: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9370: branch name (or appending the branch name to it). If a user tries
9371: to build such a package and the build fails, the user gets a
9372: message that says that the package was broken on the respective
9373: branch(es).</p></li>
9374: </ul></div>
9375: <p>Both types of packages are removed from pkgsrc in irregular
9376: intervals.</p>
9377: </div>
9378: </div>
9379: <div class="chapter" lang="en">
9380: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9381: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9382: <p>To check out all the gotchas when building a package, here are
9383: the steps that I do in order to get a package working. Please note
9384: this is basically the same as what was explained in the previous
9385: sections, only with some debugging aids.</p>
9386: <div class="itemizedlist"><ul type="disc">
1.4 rillig 9387: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
1.1 dsieger 9388: <li>
9389: <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>,
9390: create a directory for a new package, change into it, then run
9391: <span><strong class="command">url2pkg</strong></span>:</p>
9392: <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>
9393: <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>
9394: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9395: </li>
9396: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9397: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9398: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
9399: <li><p>Add any dependencies glimpsed from documentation and the
9400: configure step to the package's
9401: <code class="filename">Makefile</code>.</p></li>
9402: <li>
9403: <p>Make the package compile, doing multiple rounds of</p>
9404: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9405: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9406: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9407: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9408: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9409: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9410: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9411: <p>Doing this step as non-root user will ensure that no files
9412: are modified that shouldn't be, especially during the build
9413: phase. <span><strong class="command">mkpatches</strong></span>,
9414: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
9415: 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>
9416: package.</p>
9417: </li>
9418: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.6 rillig 9419: necessary; see <a href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.1 dsieger 9420: <li>
9421: <p>Generate a <code class="filename">PLIST</code>:</p>
9422: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9423: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9424: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9425: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9426: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9427: <p>You usually need to be <code class="username">root</code> to do
9428: this. Look if there are any files left:</p>
9429: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9430: <p>If this reveals any files that are missing in
9431: <code class="filename">PLIST</code>, add them.</p>
9432: </li>
9433: <li>
9434: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9435: package again and make a binary package:</p>
9436: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9437: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9438: </li>
9439: <li>
9440: <p>Delete the installed package:</p>
9441: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9442: </li>
9443: <li>
9444: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9445: command, which shouldn't find anything now:</p>
9446: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9447: </li>
9448: <li>
9449: <p>Reinstall the binary package:</p>
9450: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9451: </li>
9452: <li><p>Play with it. Make sure everything works.</p></li>
9453: <li>
9454: <p>Run <span><strong class="command">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
9455: reports:</p>
9456: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9457: </li>
1.6 rillig 9458: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.1 dsieger 9459: </ul></div>
9460: </div>
9461: <div class="chapter" lang="en">
9462: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9463: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9464: <div class="toc">
9465: <p><b>Table of Contents</b></p>
9466: <dl>
1.6 rillig 9467: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9468: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9469: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9470: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9471: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9472: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9473: </dl>
9474: </div>
9475: <div class="sect1" lang="en">
9476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9477: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9478: <p>Our policy is that we accept binaries only from pkgsrc
9479: developers to guarantee that the packages don't contain any
9480: trojan horses etc. This is not to annoy anyone but rather to
9481: protect our users! You're still free to put up your home-made
9482: binary packages and tell the world where to get them. NetBSD
9483: developers doing bulk builds and wanting to upload them please
1.6 rillig 9484: see <a 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 9485: </div>
9486: <div class="sect1" lang="en">
9487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9488: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9489: <p>First, check that your package is complete, compiles and
1.6 rillig 9490: runs well; see <a href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.1 dsieger 9491: document. Next, generate an uuencoded gzipped <a href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
9492: archive that contains all files that make up the package.
9493: Finally, send this package to the pkgsrc bug tracking system,
9494: either with the <a 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
9495: that, go to the web page
1.4 rillig 9496: <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.1 dsieger 9497: which contains some instructions and a link to a form, where you
9498: can submit packages.</p>
9499: <p>In the form of the problem report, the category should be
9500: “<span class="quote">pkg</span>”, the synopsis should include the package name
9501: and version number, and the description field should contain a
9502: short description of your package (contents of the COMMENT
9503: variable or DESCR file are OK). The uuencoded package data should
9504: go into the “<span class="quote">fix</span>” field.</p>
9505: <p>If you want to submit several packages, please send a
9506: separate PR for each one, it's easier for us to track things
9507: that way.</p>
9508: <p>Alternatively, you can also import new packages into
9509: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9510: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9511: for details.</p>
9512: </div>
9513: <div class="sect1" lang="en">
9514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9515: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9516: <p>Please note all package additions, updates, moves, and
9517: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9518: important to keep this file up to date and conforming to the
9519: existing format, because it will be used by scripts to
9520: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9521: sites. Additionally, check the
9522: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9523: for the package you updated or removed, in case it was mentioned
9524: there.</p>
9525: <p>When the <code class="varname">PKGREVISION</code> of a package is
9526: bumped, the change should appear in
9527: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9528: related or otherwise relevant. Mass bumps that result from a
9529: dependency being updated should not be mentioned. In all other
9530: cases it's the developer's decision.</p>
9531: <p>There is a make target that helps in creating proper
9532: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
9533: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9534: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9535: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9536: file is up-to-date (to avoid having to resolve conflicts later-on)
9537: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9538: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9539: For new packages, or package moves or removals, set the
9540: <code class="varname">CTYPE</code> variable on the command line to "Added",
9541: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.4 rillig 9542: in <a href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1 dsieger 9543: not the same as your NetBSD login name. Don't forget to commit
9544: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
9545: </div>
9546: <div class="sect1" lang="en">
9547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9548: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1 dsieger 9549: <p>This section is only of interest for pkgsrc developers with write
9550: access to the pkgsrc repository. Please remember that cvs
9551: imports files relative to the current working directory, and that
9552: the pathname that you
9553: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9554: to place the files in the repository. Newly created packages should be
9555: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
9556: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
9557: <pre class="programlisting">
9558: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9559: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9560: </pre>
9561: <p>Remember to move the directory from which you imported out of
9562: the way, or cvs will complain the next time you “<span class="quote">cvs
9563: update</span>” your source tree. Also don't forget to add the new
9564: package to the category's <code class="filename">Makefile</code>.</p>
9565: <p>The commit message of the initial import should include part of the
9566: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9567: what the package is/does.</p>
9568: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
9569: add</span>” because the former gets everything with a single command,
9570: and provides a consistent tag.</p>
9571: </div>
9572: <div class="sect1" lang="en">
9573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9574: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9575: <p>Please always put a concise, appropriate and relevant summary of the
9576: changes between old and new versions into the commit log when updating
9577: a package. There are various reasons for this:</p>
9578: <div class="itemizedlist"><ul type="disc">
9579: <li><p>A URL is volatile, and can change over time. It may go away completely
9580: or its information may be overwritten by newer information.</p></li>
9581: <li><p>Having the change information between old and new versions in our CVS
9582: repository is very useful for people who use either cvs or anoncvs.</p></li>
9583: <li><p>Having the change information between old and new versions in our CVS
9584: repository is very useful for people who read the pkgsrc-changes mailing
9585: list, so that they can make tactical decisions about when to upgrade
9586: the package.</p></li>
9587: </ul></div>
9588: <p>Please also recognize that, just because a new version of a package
9589: has been released, it should not automatically be upgraded in the CVS
9590: repository. We prefer to be conservative in the packages that are
9591: included in pkgsrc - development or beta packages are not really the
9592: best thing for most places in which pkgsrc is used. Please use your
9593: judgement about what should go into pkgsrc, and bear in mind that
9594: stability is to be preferred above new and possibly untested features.</p>
9595: </div>
9596: <div class="sect1" lang="en">
9597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9598: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.1 dsieger 9599: <div class="orderedlist"><ol type="1">
9600: <li><p>Make a copy of the directory somewhere else.</p></li>
9601: <li>
9602: <p>Remove all CVS dirs.</p>
9603: <p>Alternatively to the first two steps you can also do:</p>
9604: <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>
9605: <p>and use that for further work.</p>
9606: </li>
9607: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9608: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9609: instead of “<span class="quote">../../category/package</span>”.</p></li>
9610: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9611: place.</p></li>
9612: <li>
9613: <p>Check if any package depends on it:
9614: </p>
9615: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9616: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9617: </li>
9618: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9619: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
9620: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9621: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9622: <li>
9623: <p>Commit the changed and removed files:</p>
9624: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9625: <p>(and any packages from step 5, of course).</p>
9626: </li>
9627: </ol></div>
9628: </div>
9629: </div>
9630: <div class="chapter" lang="en">
9631: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9632: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9633: <p>This section contains the answers to questions that may
9634: arise when you are writing a package. If you don't find your
9635: question answered here, first have a look in the other chapters,
9636: and if you still don't have the answer, ask on the
9637: <code class="literal">pkgsrc-users</code> mailing list.</p>
9638: <div class="qandaset">
9639: <dl>
1.6 rillig 9640: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9641: MAKEFLAGS, .MAKEFLAGS and
9642: MAKE_FLAGS?</a>
9643: </dt>
1.6 rillig 9644: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9645: MAKE, GMAKE and
9646: MAKE_PROGRAM?</a>
9647: </dt>
1.6 rillig 9648: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9649: CC, PKG_CC and
9650: PKGSRC_COMPILER?</a>
9651: </dt>
1.6 rillig 9652: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9653: BUILDLINK_LDFLAGS,
9654: BUILDLINK_LDADD and
9655: BUILDLINK_LIBS?</a>
9656: </dt>
1.6 rillig 9657: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9658: VARNAME=BUILDLINK_PREFIX.foo
9659: say it's empty?</a>
9660: </dt>
1.6 rillig 9661: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9662: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9663: don't understand the := inside
9664: it.</a>
9665: </dt>
1.6 rillig 9666: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9667: developers?</a>
9668: </dt>
1.6 rillig 9669: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9670: documentation?</a>
9671: </dt>
1.6 rillig 9672: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9673: do?</a>
9674: </dt>
9675: </dl>
9676: <table border="0" summary="Q and A Set">
9677: <col align="left" width="1%">
9678: <tbody>
9679: <tr class="question">
9680: <td align="left" valign="top">
1.7 rillig 9681: <a name="devfaq.makeflags"></a><a name="id2713947"></a><b>22.1.</b>
1.1 dsieger 9682: </td>
9683: <td align="left" valign="top"><p>What is the difference between
9684: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9685: <code class="varname">MAKE_FLAGS</code>?</p></td>
9686: </tr>
9687: <tr class="answer">
9688: <td align="left" valign="top"></td>
9689: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9690: to the pkgsrc-internal invocations of <a 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
9691: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9692: the <code class="varname">MAKE_PROGRAM</code> when building the
9693: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9694: </tr>
9695: <tr class="question">
9696: <td align="left" valign="top">
1.7 rillig 9697: <a name="devfaq.make"></a><a name="id2713986"></a><b>22.2.</b>
1.1 dsieger 9698: </td>
9699: <td align="left" valign="top"><p>What is the difference between
9700: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9701: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9702: </tr>
9703: <tr class="answer">
9704: <td align="left" valign="top"></td>
9705: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9706: <a 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
9707: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9708: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9709: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9710: Make program that is used for building the
9711: package.</p></td>
9712: </tr>
9713: <tr class="question">
9714: <td align="left" valign="top">
1.7 rillig 9715: <a name="devfaq.cc"></a><a name="id2714026"></a><b>22.3.</b>
1.1 dsieger 9716: </td>
9717: <td align="left" valign="top"><p>What is the difference between
9718: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9719: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9720: </tr>
9721: <tr class="answer">
9722: <td align="left" valign="top"></td>
9723: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9724: compiler, which can be configured by the pkgsrc user.
9725: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9726: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9727: path to a compiler, but the type of compiler that should be
9728: used. See <code class="filename">mk/compiler.mk</code> for more
9729: information about the latter variable.</p></td>
9730: </tr>
9731: <tr class="question">
9732: <td align="left" valign="top">
1.7 rillig 9733: <a name="devfaq.bl3flags"></a><a name="id2714066"></a><b>22.4.</b>
1.1 dsieger 9734: </td>
9735: <td align="left" valign="top"><p>What is the difference between
9736: <code class="varname">BUILDLINK_LDFLAGS</code>,
9737: <code class="varname">BUILDLINK_LDADD</code> and
9738: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9739: </tr>
9740: <tr class="answer">
9741: <td align="left" valign="top"></td>
9742: <td align="left" valign="top"><p>[FIXME]</p></td>
9743: </tr>
9744: <tr class="question">
9745: <td align="left" valign="top">
1.7 rillig 9746: <a name="devfaq.bl3prefix"></a><a name="id2714086"></a><b>22.5.</b>
1.1 dsieger 9747: </td>
9748: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9749: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9750: say it's empty?</p></td>
9751: </tr>
9752: <tr class="answer">
9753: <td align="left" valign="top"></td>
9754: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9755: available in the “<span class="quote">wrapper</span>” phase and later. To
9756: “<span class="quote">simulate</span>” the wrapper phase, append
9757: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9758: command.</p></td>
9759: </tr>
9760: <tr class="question">
9761: <td align="left" valign="top">
1.7 rillig 9762: <a name="devfaq.master_sites"></a><a name="id2714116"></a><b>22.6.</b>
1.1 dsieger 9763: </td>
9764: <td align="left" valign="top"><p>What does
9765: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9766: don't understand the <code class="literal">:=</code> inside
9767: it.</p></td>
9768: </tr>
9769: <tr class="answer">
9770: <td align="left" valign="top"></td>
9771: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9772: assignment operator, like you might expect at first sight.
9773: Instead, it is a degenerate form of
9774: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9775: which is documented in the <a 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
9776: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9777: case of <code class="varname">MASTER_SITE_*</code>,
9778: <em class="replaceable"><code>old_string</code></em> is the empty string and
9779: <em class="replaceable"><code>new_string</code></em> is
9780: <code class="literal">package/</code>. That's where the
9781: <code class="literal">:</code> and the <code class="literal">=</code> fall
9782: together.</p></td>
9783: </tr>
9784: <tr class="question">
9785: <td align="left" valign="top">
1.7 rillig 9786: <a name="devfaq.mailinglists"></a><a name="id2714261"></a><b>22.7.</b>
1.1 dsieger 9787: </td>
9788: <td align="left" valign="top"><p>Which mailing lists are there for package
9789: developers?</p></td>
9790: </tr>
9791: <tr class="answer">
9792: <td align="left" valign="top"></td>
9793: <td align="left" valign="top"><div class="variablelist"><dl>
1.4 rillig 9794: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1 dsieger 9795: <dd><p>This is a list for technical discussions related
9796: to pkgsrc development, e.g. soliciting feedback for changes to
9797: pkgsrc infrastructure, proposed new features, questions related
9798: to porting pkgsrc to a new platform, advice for maintaining a
9799: package, patches that affect many packages, help requests moved
9800: from pkgsrc-users when an infrastructure bug is found,
9801: etc.</p></dd>
1.4 rillig 9802: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1 dsieger 9803: <dd><p>All bug reports in category "pkg" sent with
9804: <a 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
9805: directly; use one of the other mailing
9806: lists.</p></dd>
9807: </dl></div></td>
9808: </tr>
9809: <tr class="question">
9810: <td align="left" valign="top">
1.7 rillig 9811: <a name="devfaq.documentation"></a><a name="id2714299"></a><b>22.8.</b>
1.1 dsieger 9812: </td>
9813: <td align="left" valign="top"><p>Where is the pkgsrc
9814: documentation?</p></td>
9815: </tr>
9816: <tr class="answer">
9817: <td align="left" valign="top"></td>
9818: <td align="left" valign="top">
9819: <p>There are many places where you can find
9820: documentation about pkgsrc:</p>
9821: <div class="itemizedlist"><ul type="disc">
9822: <li><p>The pkgsrc guide (this document) is a collection
9823: of chapters that explain large parts of pkgsrc, but some
9824: chapters tend to be outdated. Which ones they are is hard to
9825: say.</p></li>
9826: <li><p>On the mailing list archives (see <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
9827: about certain features, announcements of new parts of the pkgsrc
9828: infrastructure and sometimes even announcements that a certain
9829: feature has been marked as obsolete. The benefit here is that
9830: each message has a date appended to it.</p></li>
9831: <li><p>Many of the files in the
9832: <code class="filename">mk/</code> directory start with a comment that
9833: describes the purpose of the file and how it can be used by the
9834: pkgsrc user and package authors. An easy way to find this
9835: documentation is to run <span><strong class="command">bmake
9836: help</strong></span>.</p></li>
9837: <li><p>The CVS log messages are a rich source of
9838: information, but they tend to be highly abbreviated, especially
9839: for actions that occur often. Some contain a detailed
9840: description of what has changed, but they are geared towards the
9841: other pkgsrc developers, not towards an average pkgsrc user.
9842: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9843: don't know what has been before, these messages may not be worth
9844: too much to you.</p></li>
9845: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9846: documented</span>”, that is the documentation exists only in the
9847: mind of the developer who wrote the code. To get this
9848: information, use the <span><strong class="command">cvs annotate</strong></span> command
9849: to see who has written it and ask on the
9850: <code class="literal">tech-pkg</code> mailing list, so that others can
9851: find your questions later (see above). To be sure that the
9852: developer in charge reads the mail, you may CC him or
9853: her.</p></li>
9854: </ul></div>
9855: </td>
9856: </tr>
9857: <tr class="question">
9858: <td align="left" valign="top">
1.7 rillig 9859: <a name="devfaq.too-much-time"></a><a name="id2714361"></a><b>22.9.</b>
1.1 dsieger 9860: </td>
9861: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9862: do?</p></td>
9863: </tr>
9864: <tr class="answer">
9865: <td align="left" valign="top"></td>
9866: <td align="left" valign="top">
9867: <p>This is not really an FAQ yet, but here's the answer
9868: anyway.</p>
9869: <div class="itemizedlist"><ul type="disc">
9870: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9871: <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
9872: will tell you about newer versions of installed packages that are
9873: available, but not yet updated in pkgsrc.</p></li>
9874: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.6 rillig 9875: — it contains a list of suggested new packages and a list of
1.1 dsieger 9876: cleanups and enhancements for pkgsrc that would be nice to
9877: have.</p></li>
9878: <li><p>Review packages for which review was requested on
9879: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9880: mailing list.</p></li>
9881: </ul></div>
9882: </td>
9883: </tr>
9884: </tbody>
9885: </table>
9886: </div>
9887: </div>
9888: <div class="chapter" lang="en">
9889: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9890: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9891: <div class="toc">
9892: <p><b>Table of Contents</b></p>
9893: <dl>
1.6 rillig 9894: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9895: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9896: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9897: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9898: </dl>
9899: </div>
9900: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9901: site</a>:</p>
9902: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9903: environment, an intuitive and attractive desktop for users, and the
9904: GNOME development platform, an extensive framework for building
9905: applications that integrate into the rest of the desktop.</p></blockquote></div>
9906: <p>pkgsrc provides a seamless way to automatically build and install
9907: a complete GNOME environment <span class="emphasis"><em>under many different
9908: platforms</em></span>. We can say with confidence that pkgsrc is one of
9909: the most advanced build and packaging systems for GNOME due to its
9910: included technologies buildlink3, the wrappers and tools framework and
9911: automatic configuration file management. Lots of efforts are put into
9912: achieving a completely clean deinstallation of installed software
9913: components.</p>
9914: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9915: the above also means that great efforts are put into making GNOME work
9916: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9917: pkgsrc as its preferred packaging system, contributing lots of
9918: portability fixes to make GNOME build and install under it.</p>
9919: <p>This chapter is aimed at pkgsrc developers and other people
9920: interested in helping our GNOME porting and packaging efforts. It
9921: provides instructions on how to manage the existing packages and some
9922: important information regarding their internals.</p>
9923: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9924: <h3 class="title">We need your help!</h3>
9925: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9926: and GNOME and are willing to learn new exciting stuff, please jump
9927: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9928: work</a> list! There is still a long way to go to get a
9929: fully-functional GNOME desktop under NetBSD and we need your help to
9930: achieve it!</p>
9931: </div>
9932: <div class="sect1" lang="en">
9933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9934: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9935: <p>pkgsrc includes three GNOME-related meta packages:</p>
9936: <div class="itemizedlist"><ul type="disc">
9937: <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
9938: the core GNOME desktop environment. It only includes the necessary
9939: bits to get it to boot correctly, although it may lack important
9940: functionality for daily operation. The idea behind this package is
9941: to let end users build their own configurations on top of this one,
9942: first installing this meta package to achieve a functional setup and
9943: then adding individual applications.</p></li>
9944: <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
9945: complete installation of the GNOME platform and desktop as defined
9946: by the GNOME project; this is based on the components distributed in
9947: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9948: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9949: official FTP server. Developer-only tools found in those
9950: directories are not installed unless required by some other
9951: component to work properly. Similarly, packages from the bindings
9952: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9953: in unless required as a dependency for an end-user component. This
9954: 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>
9955: <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>:
9956: Installs all the tools required to build a GNOME component when
9957: fetched from the CVS repository. These are required to let the
9958: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9959: </ul></div>
9960: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9961: sorted in a way that eases updates: a package may depend on other
9962: packages listed before it but not on any listed after it. It is very
9963: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9964: change it to alphabetical sorting!</em></span></p>
9965: </div>
9966: <div class="sect1" lang="en">
9967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9968: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9969: <p>Almost all GNOME applications are written in C and use a common
9970: set of tools as their build system. Things get different with the new
9971: bindings to other languages (such as Python), but the following will
9972: give you a general idea on the minimum required tools:</p>
9973: <div class="itemizedlist"><ul type="disc">
9974: <li>
9975: <p>Almost all GNOME applications use the GNU Autotools as their
9976: build system. As a general rule you will need to tell this to your
9977: package:</p>
9978: <pre class="programlisting">
9979: GNU_CONFIGURE=yes
9980: USE_LIBTOOL=yes
9981: USE_TOOLS+=gmake
9982: </pre>
9983: </li>
9984: <li>
9985: <p>If the package uses pkg-config to detect dependencies, add this
9986: tool to the list of required utilities:</p>
9987: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9988: <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
9989: the end of the build process to ensure that you did not miss to
9990: specify any dependency in your package and that the version
9991: requirements are all correct.</p>
9992: </li>
9993: <li><p>If the package uses intltool, be sure to add
9994: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9995: to handle dependencies and to force the package to use the latest
9996: available version.</p></li>
9997: <li>
9998: <p>If the package uses gtk-doc (a documentation generation
9999: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
10000: tool is rather big and the distfile should come with pregenerated
10001: documentation anyway; if it does not, it is a bug that you ought to
10002: report. For such packages you should disable gtk-doc (unless it is
10003: the default):</p>
10004: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
10005: <p>The default location of installed HTML files
10006: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
10007: and should not be changed unless the package insists on installing
10008: them somewhere else. Otherwise programs as
10009: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
10010: do that with an entry similar to:</p>
10011: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
10012: </li>
10013: </ul></div>
10014: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
10015: files under the installation prefix to maintain databases. In this
10016: context, shared means that those exact same directories and files are
10017: used among several different packages, leading to conflicts in the
10018: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
10019: handle the most common cases, so you have to forget about using
10020: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
10021: omitting shared files from them. If you find yourself doing those,
10022: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
10023: <p>The following table lists the common situations that result in
10024: using shared directories or files. For each of them, the appropriate
10025: solution is given. After applying the solution be sure to
10026: <span class="emphasis"><em>regenerate the package's file list</em></span> with
10027: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
10028: <div class="table">
1.6 rillig 10029: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 10030: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
10031: <colgroup>
10032: <col>
10033: <col>
10034: </colgroup>
10035: <thead><tr>
10036: <th>If the package...</th>
10037: <th>Then...</th>
10038: </tr></thead>
10039: <tbody>
10040: <tr>
10041: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.6 rillig 10042: <td>See <a 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 10043: </tr>
10044: <tr>
10045: <td>Installs icons under the
10046: <code class="filename">share/icons/hicolor</code> hierarchy or updates
10047: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.6 rillig 10048: <td>See <a 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 10049: </tr>
10050: <tr>
10051: <td>Installs files under
10052: <code class="filename">share/mime/packages</code>.</td>
1.6 rillig 10053: <td>See <a 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 10054: </tr>
10055: <tr>
10056: <td>Installs <code class="filename">.desktop</code> files under
10057: <code class="filename">share/applications</code> and these include MIME
10058: information.</td>
1.6 rillig 10059: <td>See <a href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.1 dsieger 10060: </tr>
10061: </tbody>
10062: </table></div>
10063: </div>
10064: <br class="table-break">
10065: </div>
10066: <div class="sect1" lang="en">
10067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10068: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 10069: <p>When seeing GNOME as a whole, there are two kinds of
10070: updates:</p>
10071: <div class="variablelist"><dl>
10072: <dt><span class="term">Major update</span></dt>
10073: <dd>
10074: <p>Given that there is still a very long way for GNOME 3 (if it
10075: ever appears), we consider a major update one that goes from a
10076: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10077: where <code class="literal">Y</code> is even and greater than
10078: <code class="literal">X</code>. These are hard to achieve because they
10079: introduce lots of changes in the components' code and almost all
10080: GNOME distfiles are updated to newer versions. Some of them can
10081: even break API and ABI compatibility with the previous major
10082: version series. As a result, the update needs to be done all at
10083: once to minimize breakage.</p>
10084: <p>A major update typically consists of around 80 package
10085: updates and the addition of some new ones.</p>
10086: </dd>
10087: <dt><span class="term">Minor update</span></dt>
10088: <dd>
10089: <p>We consider a minor update one that goes from a
10090: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10091: one where <code class="literal">Y</code> is greater than
10092: <code class="literal">X</code>. These are easy to achieve because they do
10093: not update all GNOME components, can be done in an incremental way
10094: and do not break API nor ABI compatibility.</p>
10095: <p>A minor update typically consists of around 50 package
10096: updates, although the numbers here may vary a lot.</p>
10097: </dd>
10098: </dl></div>
10099: <p>In order to update the GNOME components in pkgsrc to a new stable
10100: release (either major or minor), the following steps should be
10101: followed:</p>
10102: <div class="orderedlist"><ol type="1">
10103: <li>
10104: <p>Get a list of all the tarballs that form the new release by
10105: using the following commands. These will leave the full list of the
10106: components's distfiles into the <code class="filename">list.txt</code>
10107: file:</p>
10108: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10109: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10110: awk '{ print $9 }' >list.txt</code></strong>
10111: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10112: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10113: awk '{ print $9 }' >>list.txt</code></strong></pre>
10114: </li>
10115: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10116: bump their version to the release you are updating them to. The
10117: three meta packages should be always consistent with versioning.
10118: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10119: in them.</p></li>
10120: <li>
10121: <p>For each meta package, update all its
10122: <code class="varname">DEPENDS</code> lines to match the latest versions as
10123: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10124: newer version (even if found in the FTP) because the meta packages
10125: are supposed to list the exact versions that form a specific GNOME
10126: release. Exceptions are permitted here if a newer version solves a
10127: serious issue in the overall desktop experience; these typically
10128: come in the form of a revision bump in pkgsrc, not in newer versions
10129: from the developers.</p>
10130: <p>Packages not listed in the <code class="filename">list.txt</code> file
10131: should be updated to the latest version available (if found in
10132: pkgsrc). This is the case, for example, of the dependencies on the
10133: 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>
10134: </li>
10135: <li>
10136: <p>Generate a patch from the modified meta packages and extract the
10137: list of "new" lines. This will provide you an outline on what
10138: packages need to be updated in pkgsrc and in what order:</p>
10139: <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>
10140: </li>
10141: <li><p>For major desktop updates it is recommended to zap all your
10142: installed packages and start over from scratch at this point.</p></li>
10143: <li><p>Now comes the longest step by far: iterate over the contents
10144: of <code class="filename">todo.txt</code> and update the packages listed in
10145: it in order. For major desktop updates none of these should be
10146: committed until the entire set is completed because there are chances
10147: of breaking not-yet-updated packages.</p></li>
10148: <li><p>Once the packages are up to date and working, commit them to
10149: the tree one by one with appropriate log messages. At the end,
10150: commit the three meta package updates and all the corresponding
10151: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10152: <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>
10153: </ol></div>
10154: </div>
10155: <div class="sect1" lang="en">
10156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10157: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10158: <p>GNOME is a very big component in pkgsrc which approaches 100
10159: packages. Please, it is very important that you always, always,
10160: <span class="strong"><strong>always</strong></span> feed back any portability
1.6 rillig 10161: fixes you do to a GNOME package to the mainstream developers (see <a 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 10162: their attention on portability issues and to ensure that future versions
10163: can be built out-of-the box on NetBSD. The less custom patches in
10164: pkgsrc, the easier further updates are. Those developers in charge of
10165: issuing major GNOME updates will be grateful if you do that.</p>
10166: <p>The most common places to report bugs are the <a href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
10167: Bugzilla</a>. Not all components use these to track bugs, but most
10168: of them do. Do not be short on your reports: always provide detailed
10169: explanations of the current failure, how it can be improved to achieve
10170: maximum portability and, if at all possible, provide a patch against CVS
10171: head. The more verbose you are, the higher chances of your patch being
10172: accepted.</p>
10173: <p>Also, please avoid using preprocessor magic to fix portability
10174: issues. While the FreeBSD GNOME people are doing a great job in porting
10175: GNOME to their operating system, the official GNOME sources are now
10176: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10177: and similar macros. This hurts portability. Please see our patching
1.6 rillig 10178: guidelines (<a href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10179: details.</p>
10180: </div>
10181: </div>
10182: </div>
10183: <div class="part" lang="en">
10184: <div class="titlepage"><div><div><h1 class="title">
10185: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10186: <div class="partintro" lang="en">
10187: <div></div>
10188: <p>This part of the guide deals with everything
10189: from the infrastructure that is behind the interfaces described
10190: in the developer's guide. A casual package maintainer should not
10191: need anything from this part.</p>
10192: <div class="toc">
10193: <p><b>Table of Contents</b></p>
10194: <dl>
1.6 rillig 10195: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10196: <dd><dl>
1.6 rillig 10197: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10198: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10199: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10200: <dd><dl>
1.6 rillig 10201: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10202: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10203: </dl></dd>
1.6 rillig 10204: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10205: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10206: <dd><dl>
1.6 rillig 10207: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10208: <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 10209: </dl></dd>
1.6 rillig 10210: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10211: <dd><dl>
1.6 rillig 10212: <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>
10213: <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 10214: </dl></dd>
10215: </dl></dd>
1.6 rillig 10216: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10217: <dd><dl>
1.6 rillig 10218: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10219: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10220: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10221: <dd><dl>
1.6 rillig 10222: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10223: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10224: </dl></dd>
10225: </dl></dd>
1.6 rillig 10226: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10227: <dd><dl>
1.6 rillig 10228: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10229: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10230: </dl></dd>
10231: </dl>
10232: </div>
10233: </div>
10234: <div class="chapter" lang="en">
10235: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10236: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10237: <div class="toc">
10238: <p><b>Table of Contents</b></p>
10239: <dl>
1.6 rillig 10240: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10241: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10242: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10243: <dd><dl>
1.6 rillig 10244: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10245: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10246: </dl></dd>
1.6 rillig 10247: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10248: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10249: <dd><dl>
1.6 rillig 10250: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10251: <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 10252: </dl></dd>
1.6 rillig 10253: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10254: <dd><dl>
1.6 rillig 10255: <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>
10256: <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 10257: </dl></dd>
10258: </dl>
10259: </div>
10260: <p>The pkgsrc infrastructure consists of many small Makefile
10261: fragments. Each such fragment needs a properly specified
10262: interface. This chapter explains how such an interface looks
10263: like.</p>
10264: <div class="sect1" lang="en">
10265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10266: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10267: <p>Whenever a variable is defined in the pkgsrc
10268: infrastructure, the location and the way of definition provide
10269: much information about the intended use of that variable.
10270: Additionally, more documentation may be found in a header
10271: comment or in this pkgsrc guide.</p>
10272: <p>A special file is
10273: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10274: variables that are intended to be user-defined. They are either
10275: defined using the <code class="literal">?=</code> operator or they are
10276: left undefined because defining them to anything would
10277: effectively mean “<span class="quote">yes</span>”. All these variables may be
10278: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10279: file.</p>
10280: <p>Outside this file, the following conventions apply:
10281: Variables that are defined using the <code class="literal">?=</code>
10282: operator may be overridden by a package.</p>
10283: <p>Variables that are defined using the <code class="literal">=</code>
10284: operator may be used read-only at run-time.</p>
10285: <p>Variables whose name starts with an underscore must not be
10286: accessed outside the pkgsrc infrastructure at all. They may
10287: change without further notice.</p>
10288: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10289: <h3 class="title">Note</h3>
10290: <p>These conventions are currently not applied
10291: consistently to the complete pkgsrc
10292: infrastructure.</p>
10293: </div>
10294: </div>
10295: <div class="sect1" lang="en">
10296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10297: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10298: <p>All variables that contain lists of things should default
10299: to being empty. Two examples that do not follow this rule are
10300: <code class="varname">USE_LANGUAGES</code> and
10301: <code class="varname">DISTFILES</code>. These variables cannot simply be
10302: modified using the <code class="literal">+=</code> operator in package
10303: <code class="filename">Makefile</code>s (or other files included by
10304: them), since there is no guarantee whether the variable is
10305: already set or not, and what its value is. In the case of
10306: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10307: the default value and just define it as in the following
10308: example.</p>
10309: <pre class="programlisting">
10310: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10311: </pre>
10312: <p>Because of the selection of this default value, the same
10313: value appears in many package Makefiles. Similarly for
10314: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10315: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10316: doesn't stand out. Nevertheless it is mentioned in many
10317: files.</p>
10318: </div>
10319: <div class="sect1" lang="en">
10320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10321: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.1 dsieger 10322: <div class="sect2" lang="en">
10323: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10324: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10325: <p>Variable evaluation takes place either at load time or at
10326: runtime, depending on the context in which they occur. The
10327: contexts where variables are evaluated at load time are:</p>
10328: <div class="itemizedlist"><ul type="disc">
10329: <li><p>The right hand side of the <code class="literal">:=</code>
10330: and <code class="literal">!=</code> operators,</p></li>
10331: <li><p>Make directives like <code class="literal">.if</code> or
10332: <code class="literal">.for</code>,</p></li>
10333: <li><p>Dependency lines.</p></li>
10334: </ul></div>
10335: <p>A special exception are references to the iteration
10336: variables of <code class="literal">.for</code> loops, which are expanded
10337: inline, no matter in which context they appear.</p>
10338: <p>As the values of variables may change during load time,
10339: care must be taken not to evaluate them by accident. Typical
10340: examples for variables that should not be evaluated at load time
10341: are <code class="varname">DEPENDS</code> and
10342: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10343: clear, here is an example:</p>
10344: <pre class="programlisting">
10345: CONFIGURE_ARGS= # none
10346: CFLAGS= -O
10347: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10348:
10349: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10350:
10351: CFLAGS+= -Wall
10352: </pre>
10353: <p>This code shows how the use of the <code class="literal">:=</code>
10354: operator can quickly lead to unexpected results. The first
10355: paragraph is fairly common code. The second paragraph evaluates
10356: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10357: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10358: <code class="literal">-Wall</code> is appended to the
10359: <code class="varname">CFLAGS</code>, but this addition will not appear in
10360: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10361: paragraphs from above typically occur in completely unrelated
10362: files.</p>
10363: </div>
10364: <div class="sect2" lang="en">
10365: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10366: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10367: <p>After all the files have been loaded, the values of the
10368: variables cannot be changed anymore. Variables that are used in
10369: the shell commands are expanded at this point.</p>
10370: </div>
10371: </div>
10372: <div class="sect1" lang="en">
10373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10374: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10375: <p>There are many ways in which the definition and use of a
10376: variable can be restricted in order to detect bugs and
10377: violations of the (mostly unwritten) policies. See the
10378: <code class="literal">pkglint</code> developer's documentation for further
10379: details.</p>
10380: </div>
10381: <div class="sect1" lang="en">
10382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10383: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10384: <p>Most of the <code class="filename">.mk</code> files fall into one
10385: of the following classes. Cases where a file falls into more
10386: than one class should be avoided as it often leads to subtle
10387: bugs.</p>
10388: <div class="sect2" lang="en">
10389: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10390: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10391: <p>In a traditional imperative programming language some of
10392: the <code class="filename">.mk</code> files could be described as
1.6 rillig 10393: procedures. They take some input parameters and—after
10394: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10395: variables in <code class="filename">Makefile</code>s have global scope
10396: care must be taken not to use parameter names that have already
10397: another meaning. For example, <code class="varname">PKGNAME</code> is a
10398: bad choice for a parameter name.</p>
10399: <p>Procedures are completely evaluated at preprocessing time.
10400: That is, when calling a procedure all input parameters must be
10401: completely resolvable. For example,
10402: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10403: parameter since it is very likely that further text will be
10404: added after calling the procedure, which would effectively apply
10405: the procedure to only a part of the variable. Also, references
10406: to other variables wit will be modified after calling the
10407: procedure.</p>
10408: <p>A procedure can declare its output parameters either as
10409: suitable for use in preprocessing directives or as only
10410: available at runtime. The latter alternative is for variables
10411: that contain references to other runtime variables.</p>
10412: <p>Procedures shall be written such that it is possible to
10413: call the procedure more than once. That is, the file must not
10414: contain multiple-inclusion guards.</p>
10415: <p>Examples for procedures are
10416: <code class="filename">mk/bsd.options.mk</code> and
10417: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10418: that the parameters are evaluated at load time, they should be
10419: assigned using the <code class="literal">:=</code> operator, which should
10420: be used only for this purpose.</p>
10421: </div>
10422: <div class="sect2" lang="en">
10423: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10424: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10425: <p>Action files take some input parameters and may define
10426: runtime variables. They shall not define loadtime variables.
10427: There are action files that are included implicitly by the
10428: pkgsrc infrastructure, while other must be included
10429: explicitly.</p>
10430: <p>An example for action files is
10431: <code class="filename">mk/subst.mk</code>.</p>
10432: </div>
10433: </div>
10434: <div class="sect1" lang="en">
10435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10436: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10437: <p>Package <code class="filename">Makefile</code>s usually consist of
10438: a set of variable definitions, and include the file
10439: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10440: Before that, they may also include various other
10441: <code class="filename">*.mk</code> files if they need to query the
10442: availability of certain features like the type of compiler or
10443: the X11 implementation. Due to the heavy use of preprocessor
10444: directives like <code class="literal">.if</code> and
10445: <code class="literal">.for</code>, the order in which the files are loaded
10446: matters.</p>
10447: <p>This section describes at which point the various files
10448: are loaded and gives reasons for that order.</p>
10449: <div class="sect2" lang="en">
10450: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10451: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10452: </h3></div></div></div>
10453: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10454: is to define some essential variables like
10455: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10456: <code class="varname">MACHINE_ARCH</code>.</p>
10457: <p>Then, the user settings are loaded from the file specified
1.4 rillig 10458: in <code class="varname">MAKECONF</code>, which is usually <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
10459: After that, those variables
1.1 dsieger 10460: that have not been overridden by the user are loaded from
10461: <code class="filename">mk/defaults/mk.conf</code>.</p>
10462: <p>After the user settings, the system settings and platform
10463: settings are loaded, which may override the user
10464: settings.</p>
10465: <p>Then, the tool definitions are loaded. The tool wrappers
10466: are not yet in effect. This only happens when building a
10467: package, so the proper variables must be used instead of the
10468: direct tool names.</p>
10469: <p>As the last steps, some essential variables from the
10470: wrapper and the package system flavor are loaded, as well as the
10471: variables that have been cached in earlier phases of a package
10472: build.</p>
10473: </div>
10474: <div class="sect2" lang="en">
10475: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10476: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10477: </h3></div></div></div>
10478: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10479: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10480: loaded, which fill default values for those variables that have
10481: not been defined by the package. These variables may later
10482: be used even in unrelated files.</p>
10483: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10484: provides the target <code class="literal">error-check</code> that is added
10485: as a special dependency to all other targets that use
10486: <code class="varname">DELAYED_ERROR_MSG</code> or
10487: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10488: <p>Then, the package-specific hacks from
10489: <code class="filename">hacks.mk</code> are included.</p>
10490: <p>Then, various other files follow. Most of them don't have
10491: any dependencies on what they need to have included before or
10492: after them, though some do.</p>
10493: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10494: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10495: restricts the use of these variables to all the files that have
10496: been included before. Appearances in later files will be
10497: silently ignored.</p>
10498: <p>Then, the files for the main targets are included, in the
10499: order of later execution, though the actual order should not
10500: matter.</p>
10501: <p>At last, some more files are included that don't set any
10502: interesting variables but rather just define make targets to be
10503: executed.</p>
10504: </div>
10505: </div>
10506: </div>
10507: <div class="chapter" lang="en">
10508: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10509: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10510: <div class="toc">
10511: <p><b>Table of Contents</b></p>
10512: <dl>
1.6 rillig 10513: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10514: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10515: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10516: <dd><dl>
1.6 rillig 10517: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10518: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10519: </dl></dd>
10520: </dl>
10521: </div>
10522: <p>The pkgsrc infrastructure consists of a large codebase,
10523: and there are many corners where every little bit of a file is
10524: well thought out, making pkgsrc likely to fail as soon as
10525: anything is changed near those parts. To prevent most changes
10526: from breaking anything, a suite of regression tests should go
10527: along with every important part of the pkgsrc infrastructure.
10528: This chapter describes how regression tests work in pkgsrc and
10529: how you can add new tests.</p>
10530: <div class="sect1" lang="en">
10531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10532: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10533: <p></p>
10534: </div>
10535: <div class="sect1" lang="en">
10536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10537: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10538: <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
10539: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10540: can simply run that command, which will run all tests in the
10541: <code class="filename">regress</code> category.</p>
10542: </div>
10543: <div class="sect1" lang="en">
10544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10545: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10546: <p>Every directory in the <code class="filename">regress</code>
10547: category that contains a file called <code class="filename">spec</code>
10548: is considered a regression test. This file is a shell program
10549: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10550: The following functions can be overridden to suit your
10551: needs.</p>
10552: <div class="sect2" lang="en">
10553: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10554: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10555: <p>These functions do not take any parameters. They are all
10556: called in “<span class="quote">set -e</span>” mode, so you should be careful
10557: to check the exitcodes of any commands you run in the
10558: test.</p>
10559: <div class="variablelist"><dl>
10560: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10561: <dd><p>This function prepares the environment for the
10562: test. By default it does nothing.</p></dd>
10563: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10564: <dd><p>This function runs the actual test. By default,
10565: it calls <code class="varname">TEST_MAKE</code> with the arguments
10566: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10567: error messages into the file
10568: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10569: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10570: <dd><p>This function is run after the test and is
10571: typically used to compare the actual output from the one that is
10572: expected. It can make use of the various helper functions from
10573: the next section.</p></dd>
10574: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10575: <dd><p>This function cleans everything up after the
10576: test has been run. By default it does nothing.</p></dd>
10577: </dl></div>
10578: </div>
10579: <div class="sect2" lang="en">
10580: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10581: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1 dsieger 10582: <div class="variablelist"><dl>
10583: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10584: <dd><p>This function compares the exitcode of the
10585: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10586: If they differ, the test will fail.</p></dd>
10587: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10588: <dd><p>This function checks for each of its parameters
10589: if the output from <span><strong class="command">do_test()</strong></span> matches the
10590: extended regular expression. If it does not, the test will
10591: fail.</p></dd>
10592: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10593: <dd><p>This function checks for each of its parameters
10594: if the output from <span><strong class="command">do_test()</strong></span> does
10595: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10596: If any of the regular expressions matches, the test will
10597: fail.</p></dd>
10598: </dl></div>
10599: </div>
10600: </div>
10601: </div>
10602: <div class="chapter" lang="en">
10603: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10604: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10605: <div class="toc">
10606: <p><b>Table of Contents</b></p>
10607: <dl>
1.6 rillig 10608: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10609: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10610: </dl>
10611: </div>
10612: <p>The pkgsrc system has already been ported to many
10613: operating systems, hardware architectures and compilers. This
10614: chapter explains the necessary steps to make pkgsrc even more
10615: portable.</p>
10616: <div class="sect1" lang="en">
10617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10618: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10619: <p>To port pkgsrc to a new operating system (called
10620: <code class="literal">MyOS</code> in this example), you need to touch the
10621: following files:</p>
10622: <div class="variablelist"><dl>
10623: <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>
10624: <dd><p>This file contains some basic definitions, for
10625: example the name of the C
10626: compiler.</p></dd>
10627: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10628: <dd><p>Insert code that defines the variables
10629: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10630: <code class="varname">LOWER_OS_VERSION</code>,
10631: <code class="varname">LOWER_VENDOR</code>,
10632: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10633: <code class="varname">APPEND_ELF</code>, and the other variables that
10634: appear in this file.</p></dd>
10635: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10636: <dd><p>This file contains the platform-specific
10637: definitions that are used by pkgsrc. Start by copying one of the
10638: other files and edit it to your
10639: needs.</p></dd>
10640: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10641: <dd><p>This file contains a list of directories,
10642: together with their permission bits and ownership. These
10643: directories will be created automatically with every package
10644: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10645: be removed.</p></dd>
10646: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10647: <dd><p>Just copy one of the pre-existing x11.dist files
10648: to your
10649: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10650: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10651: <dd><p>On some operating systems, the tools that are
10652: provided with the base system are not good enough for pkgsrc.
10653: For example, there are many versions of <a 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
10654: narrow limit on the line length they can process. Therefore
10655: pkgsrc brings its own tools, which can be enabled
10656: here.</p></dd>
10657: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10658: <dd><p>This file defines the paths to all the tools
10659: that are needed by one or the other package in pkgsrc, as well
10660: as by pkgsrc itself. Find out where these tools are on your
10661: platform and add them.</p></dd>
10662: </dl></div>
10663: <p>Now, you should be able to build some basic packages, like
10664: <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>
10665: </div>
10666: <div class="sect1" lang="en">
10667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10668: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10669: <p>TODO</p>
10670: </div>
10671: </div>
10672: </div>
10673: <div class="appendix" lang="en">
10674: <div class="titlepage"><div><div><h2 class="title">
10675: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10676: <div class="toc">
10677: <p><b>Table of Contents</b></p>
10678: <dl>
10679: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10680: <dd><dl>
10681: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10682: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10683: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10684: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span></a></span></dt>
10685: </dl></dd>
10686: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10687: </dl>
10688: </div>
10689: <p>We checked to find a piece of software that wasn't in the packages
10690: collection, and picked GNU bison. Quite why someone would want to have
10691: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10692: present in the tree is beyond us, but it's useful for the purposes of
10693: this exercise.</p>
10694: <div class="sect1" lang="en">
10695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10696: <a name="example-files"></a>A.1. files</h2></div></div></div>
10697: <div class="sect2" lang="en">
10698: <div class="titlepage"><div><div><h3 class="title">
10699: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10700: <pre class="programlisting">
10701: # $NetBSD$
10702: #
10703:
10704: DISTNAME= bison-1.25
10705: CATEGORIES= devel
10706: MASTER_SITES= ${MASTER_SITE_GNU}
10707:
10708: MAINTAINER= thorpej@NetBSD.org
10709: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10710: COMMENT= GNU yacc clone
10711:
10712: GNU_CONFIGURE= yes
10713: INFO_FILES= bison.info
10714:
10715: .include "../../mk/bsd.pkg.mk"
10716: </pre>
10717: </div>
10718: <div class="sect2" lang="en">
10719: <div class="titlepage"><div><div><h3 class="title">
10720: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10721: <pre class="programlisting">
10722: GNU version of yacc. Can make re-entrant parsers, and numerous other
10723: improvements. Why you would want this when Berkeley <a 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
10724: of the NetBSD source tree is beyond me.
10725: </pre>
10726: </div>
10727: <div class="sect2" lang="en">
10728: <div class="titlepage"><div><div><h3 class="title">
10729: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10730: <pre class="programlisting">
10731: @comment $NetBSD$
10732: bin/bison
10733: man/man1/bison.1.gz
10734: share/bison.simple
10735: share/bison.hairy
10736: </pre>
10737: </div>
10738: <div class="sect2" lang="en">
10739: <div class="titlepage"><div><div><h3 class="title">
10740: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10741: </h3></div></div></div>
10742: <p>The NetBSD package system comes with
10743: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10744: which helps to check the contents of these
10745: files. After installation it is quite easy to use, just change to the
10746: directory of the package you wish to examine and execute
10747: <span><strong class="command">pkglint</strong></span>:</p>
10748: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10749: looks fine.</pre>
10750: <p>Depending on the supplied command line arguments (see pkglint(1)),
10751: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10752: -Wall</strong></span> for a very thorough check.</p>
10753: </div>
10754: </div>
10755: <div class="sect1" lang="en">
10756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10757: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10758: <p>Create the directory where the package lives,
10759: plus any auxiliary directories:</p>
10760: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10761: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10762: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10763: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10764: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.6 rillig 10765: <code class="filename">PLIST</code> (see <a 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 10766: then continue with fetching the distfile:</p>
10767: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10768: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10769: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10770: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10771: ftp: Error retrieving file: 500 Internal error
10772:
10773: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10774: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10775: ftp: Error retrieving file: 500 Internal error
10776:
10777: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10778: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10779: Successfully retrieved file.</pre>
10780: <p>Generate the checksum of the distfile into
10781: <code class="filename">distinfo</code>:</p>
10782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10783: <p>Now compile:</p>
10784: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10785: >> Checksum OK for bison-1.25.tar.gz.
10786: ===> Extracting for bison-1.25
10787: ===> Patching for bison-1.25
10788: ===> Ignoring empty patch directory
10789: ===> Configuring for bison-1.25
10790: creating cache ./config.cache
10791: checking for gcc... cc
10792: checking whether we are using GNU C... yes
10793: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10794: checking how to run the C preprocessor... cc -E
10795: checking for minix/config.h... no
10796: checking for POSIXized ISC... no
10797: checking whether cross-compiling... no
10798: checking for ANSI C header files... yes
10799: checking for string.h... yes
10800: checking for stdlib.h... yes
10801: checking for memory.h... yes
10802: checking for working const... yes
10803: checking for working alloca.h... no
10804: checking for alloca... yes
10805: checking for strerror... yes
10806: updating cache ./config.cache
10807: creating ./config.status
10808: creating Makefile
10809: ===> Building for bison-1.25
10810: 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
10811: 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
10812: 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
10813: 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
10814: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
10815: 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
10816: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10817: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10818: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10819: 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
10820: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
10821: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
10822: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
10823: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
10824: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
10825: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
10826: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
10827: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
10828: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
10829: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
10830: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
10831: 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
10832: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10833: rm -f bison.s1
10834: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10835: <p>Everything seems OK, so install the files:</p>
10836: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10837: >> Checksum OK for bison-1.25.tar.gz.
10838: ===> Installing for bison-1.25
10839: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10840: rm -f /usr/pkg/bin/bison
10841: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10842: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10843: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10844: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10845: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10846: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10847: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10848: ===> Registering installation for bison-1.25</pre>
10849: <p>You can now use bison, and also - if you decide so - remove it with
10850: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10851: binary package, do this now:</p>
10852: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10853: >> Checksum OK for bison-1.25.tar.gz.
10854: ===> Building package for bison-1.25
10855: Creating package bison-1.25.tgz
10856: Registering depends:.
10857: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10858: <p>Now that you don't need the source and object files
10859: any more, clean up:</p>
10860: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10861: ===> Cleaning for bison-1.25</pre>
10862: </div>
10863: </div>
10864: <div class="appendix" lang="en">
10865: <div class="titlepage"><div><div><h2 class="title">
10866: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10867: <div class="toc">
10868: <p><b>Table of Contents</b></p>
10869: <dl>
10870: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10871: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10872: </dl>
10873: </div>
10874: <div class="sect1" lang="en">
10875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10876: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10877: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10878: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10879: => figlet221.tar.gz doesn't seem to exist on this system.
10880: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10881: => [172219 bytes]
10882: Connected to ftp.plig.net.
10883: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10884: 331 Guest login ok, send your complete e-mail address as password.
10885: 230-You are user #5 of 500 simultaneous users allowed.
10886: 230-
10887: 230- ___ _ _ _
10888: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10889: 230- | _| _| . |_| . | | | . |_| . | _| . |
10890: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10891: 230- |_| |_| |___| |___|
10892: 230-
10893: 230-** Welcome to ftp.plig.org **
10894: 230-
10895: 230-Please note that all transfers from this FTP site are logged. If you
10896: 230-do not like this, please disconnect now.
10897: 230-
10898: 230-This arhive is available via
10899: 230-
10900: 230-HTTP: http://ftp.plig.org/
10901: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10902: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10903: 230-
10904: 230-Please email comments, bug reports and requests for packages to be
10905: 230-mirrored to ftp-admin@plig.org.
10906: 230-
10907: 230-
10908: 230 Logged in anonymously.
10909: Remote system type is UNIX.
10910: Using binary mode to transfer files.
10911: 200 Type okay.
10912: 250 "/pub" is new cwd.
10913: 250-"/pub/figlet" is new cwd.
10914: 250-
10915: 250-Welcome to the figlet archive at ftp.figlet.org
10916: 250-
10917: 250- ftp://ftp.figlet.org/pub/figlet/
10918: 250-
10919: 250-The official FIGlet web page is:
10920: 250- http://www.figlet.org/
10921: 250-
10922: 250-If you have questions, please mailto:info@figlet.org. If you want to
10923: 250-contribute a font or something else, you can email us.
10924: 250
10925: 250 "/pub/figlet/program" is new cwd.
10926: 250 "/pub/figlet/program/unix" is new cwd.
10927: local: figlet221.tar.gz remote: figlet221.tar.gz
10928: 502 Unimplemented command.
10929: 227 Entering Passive Mode (195,40,6,41,246,104)
10930: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10931: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10932: 226 Transfer completed.
10933: 172219 bytes received in 00:02 (75.99 KB/s)
10934: 221 Goodbye.
10935: => Checksum OK for figlet221.tar.gz.
10936: ===> Extracting for figlet-2.2.1nb2
10937: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10938: ===> Patching for figlet-2.2.1nb2
10939: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10940: ===> Overriding tools for figlet-2.2.1nb2
10941: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10942: ===> Configuring for figlet-2.2.1nb2
10943: ===> Building for figlet-2.2.1nb2
10944: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10945: chmod a+x figlet
10946: gcc -O2 -o chkfont chkfont.c
10947: => Unwrapping files-to-be-installed.
10948: <code class="prompt">#</code>
10949: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10950: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10951: ===> Installing for figlet-2.2.1nb2
10952: install -d -o root -g wheel -m 755 /usr/pkg/bin
10953: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10954: mkdir -p /usr/pkg/share/figlet
10955: cp figlet /usr/pkg/bin
10956: cp chkfont /usr/pkg/bin
10957: chmod 555 figlist showfigfonts
10958: cp figlist /usr/pkg/bin
10959: cp showfigfonts /usr/pkg/bin
10960: cp fonts/*.flf /usr/pkg/share/figlet
10961: cp fonts/*.flc /usr/pkg/share/figlet
10962: cp figlet.6 /usr/pkg/man/man6
10963: ===> Registering installation for figlet-2.2.1nb2
10964: <code class="prompt">#</code></pre>
10965: </div>
10966: <div class="sect1" lang="en">
10967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10968: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10969: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10970: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10971: ===> Packaging figlet-2.2.1nb2
10972: ===> Building binary package for figlet-2.2.1nb2
10973: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10974: Using SrcDir value of /usr/pkg
10975: Registering depends:.
10976: <code class="prompt">#</code></pre>
10977: </div>
10978: </div>
10979: <div class="appendix" lang="en">
10980: <div class="titlepage"><div><div><h2 class="title">
10981: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10982: <div class="toc">
10983: <p><b>Table of Contents</b></p>
10984: <dl>
10985: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10986: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10987: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10988: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3 rillig 10989: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.8 ! rillig 10990: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
! 10991: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.1 dsieger 10992: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10993: source packages</a></span></dt>
10994: </dl>
10995: </div>
10996: <p>As in other big projects, the directory layout of pkgsrc
10997: is quite complex for newbies. This chapter explains where you
10998: find things on the FTP server. The base directory on
10999: <code class="filename">ftp.NetBSD.org</code> is <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
11000: On other servers it may be different, but inside this directory,
11001: everything should look the same, no matter on which server you
11002: are. This directory contains some subdirectories, which are
11003: explained below.</p>
11004: <div class="sect1" lang="en">
11005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11006: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
11007: <p>For those who only want to manage binary packages on
11008: systems other than NetBSD, we provide the package management
1.8 ! rillig 11009: tools in a separate, small tar file. Please note that most of
! 11010: these files are horribly outdated.</p>
1.1 dsieger 11011: </div>
11012: <div class="sect1" lang="en">
11013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11014: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11015: <p>The directory <code class="filename">distfiles</code> contains lots
11016: of archive files from all pkgsrc packages, which are mirrored
11017: here. The subdirectories are called after their package names
11018: and are used when the distributed files have names that don't
11019: explicitly contain a version number or are otherwise too generic
11020: (for example <code class="filename">release.tar.gz</code>).</p>
11021: </div>
11022: <div class="sect1" lang="en">
11023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11024: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
11025: <p>This directory is currently not in use.</p>
11026: </div>
11027: <div class="sect1" lang="en">
11028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11029: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11030: <p>This directory contains things that individual pkgsrc
11031: developers find worth publishing.</p>
11032: </div>
11033: <div class="sect1" lang="en">
11034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3 rillig 11035: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11036: <p>This directory contains binary packages for the various
11037: platforms that are supported by pkgsrc.
11038: 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>
11039: <div class="itemizedlist"><ul type="disc">
1.8 ! rillig 11040: <li><p><code class="varname">OPSYS</code> is the name of the
! 11041: operating system for which the packages have been
! 11042: built.</p></li>
! 11043: <li><p><code class="varname">ARCH</code> is the hardware
! 11044: architecture of the platform for which the packages have been
! 11045: built.</p></li>
! 11046: <li><p><code class="varname">OSVERSION</code> is the version of
! 11047: the operating system. For version numbers that change often (for
! 11048: example NetBSD-current), the often-changing part should be
! 11049: replaced with an <code class="literal">x</code>, for example
! 11050: <code class="literal">4.99.x</code>.</p></li>
! 11051: <li><p><code class="varname">TAG</code> is either
! 11052: <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
! 11053: for a stable branch, or <code class="literal">head</code> for packages
! 11054: built from the HEAD branch. The latter should only be used when
! 11055: the packages are updated on a regular basis. Otherwise the date
! 11056: from checking out pkgsrc should be appended, for example
! 11057: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 11058: </ul></div>
11059: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11060: can quickly click through the directories on the
11061: server and find the best binary packages for their machines. Since they
11062: usually know the operating system and the hardware architecture, OPSYS
11063: and ARCH are placed first. After these choices, they can select the
11064: best combination of OSVERSION and TAG together, since it is usually the
11065: case that packages stay compatible between different version of the
11066: operating system.</p>
11067: <p>In each of these directories, there is a
11068: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 11069: <code class="filename">All</code> which contains all binary packages.
11070: Besides that, there are various category directories that
11071: contain symbolic links to the real binary packages.</p>
11072: </div>
11073: <div class="sect1" lang="en">
11074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.8 ! rillig 11075: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
! 11076: <p>Here are the reports from bulk builds, for those who want
! 11077: to fix packages that didn't build on some of the platforms. The
! 11078: structure of subdirectories should look like the one in <a href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, “<code class="filename">packages</code>: Binary packages”</a>.</p>
! 11079: </div>
! 11080: <div class="sect1" lang="en">
! 11081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 11082: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.1 dsieger 11083: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11084: source packages</h2></div></div></div>
11085: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
11086: that is the files that define how to create binary packages from
11087: source archives.</p>
11088: <p>The directory <code class="filename">pkgsrc</code> contains a
11089: snapshot of the CVS repository, which is updated regularly. The
11090: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11091: directory, ready to be downloaded as a whole.</p>
11092: <p>In the directories for the quarterly branches, there is an
11093: additional file called
11094: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
11095: which contains the state of pkgsrc when it was branched.</p>
11096: </div>
11097: </div>
11098: <div class="appendix" lang="en">
11099: <div class="titlepage"><div><div><h2 class="title">
11100: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11101: <div class="toc">
11102: <p><b>Table of Contents</b></p>
11103: <dl>
11104: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11105: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11106: </dl>
11107: </div>
11108: <p>This section contains information on editing the pkgsrc
11109: guide itself.</p>
11110: <div class="sect1" lang="en">
11111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11112: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11113: <p>The pkgsrc guide's source code is stored in
11114: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11115: are created from it:</p>
11116: <div class="itemizedlist"><ul type="disc">
11117: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11118: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.2 rillig 11119: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11120: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1 dsieger 11121: The PDF version of the pkgsrc guide.</p></li>
1.2 rillig 11122: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1 dsieger 11123: PostScript version of the pkgsrc guide.</p></li>
11124: </ul></div>
11125: </div>
11126: <div class="sect1" lang="en">
11127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11128: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11129: <p>The procedure to edit the pkgsrc guide is:</p>
11130: <div class="procedure"><ol type="1">
11131: <li><p>Make sure you have the packages needed to
11132: regenerate the pkgsrc guide (and other XML-based NetBSD
11133: 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
11134: 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
11135: PostScript and PDF versions. You will need both packages
11136: installed, to make sure documentation is consistent across all
11137: formats.</p></li>
11138: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
11139: right directory. All further steps will take place
11140: here.</p></li>
11141: <li><p>Edit the XML file(s) in
11142: <code class="filename">files/</code>.</p></li>
11143: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
11144: guide for valid XML and to build the final output files. If you
11145: get any errors at this stage, you can just edit the files, as
11146: there are only symbolic links in the working directory, pointing
11147: to the files in <code class="filename">files/</code>.</p></li>
11148: <li><p><span><strong class="command">(cd files && cvs
11149: commit)</strong></span></p></li>
11150: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
11151: regenerate the output files with the proper RCS
11152: Ids.</p></li>
11153: <li>
11154: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
11155: commit the files in both <code class="filename">pkgsrc/doc</code> and
11156: <code class="filename">htdocs</code>.</p>
11157: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11158: <h3 class="title">Note</h3>
11159: <p>If you have added, removed or renamed some chapters,
11160: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
11161: <span><strong class="command">cvs delete</strong></span> in the htdocs
11162: directory.</p>
11163: </div>
11164: </li>
11165: </ol></div>
11166: </div>
11167: </div>
11168: </div></body>
11169: </html>
CVSweb <webmaster@jp.NetBSD.org>