Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.7
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.1 dsieger 461: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
462: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
463: source packages</a></span></dt>
464: </dl></dd>
465: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
466: <dd><dl>
467: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
468: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
469: </dl></dd>
470: </dl>
471: </div>
472: <div class="list-of-tables">
473: <p><b>List of Tables</b></p>
474: <dl>
475: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
476: </dt>
477: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
478: </dt>
1.6 rillig 479: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 480: </dt>
1.6 rillig 481: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 482: </dt>
483: </dl>
484: </div>
485: <div class="chapter" lang="en">
486: <div class="titlepage"><div><div><h2 class="title">
487: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
488: <div class="toc">
489: <p><b>Table of Contents</b></p>
490: <dl>
491: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
492: <dd><dl>
493: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
494: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
495: </dl></dd>
496: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
497: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
498: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
499: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
500: </dl>
501: </div>
502: <div class="sect1" lang="en">
503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
504: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
505: <p>There is a lot of software freely available for Unix-based
506: systems, which is usually available in form of the source code. Before
507: such software can be used, it needs to be configured to the local
508: system, compiled and installed, and this is exactly what The NetBSD
509: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
510: to handle binary packages, so that not every user has to build the
511: packages for himself, which is a time-costly task.</p>
512: <p>pkgsrc currently contains several thousand packages,
513: including:</p>
514: <div class="itemizedlist"><ul type="disc">
515: <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
516: web server</p></li>
517: <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
518: web browser</p></li>
519: <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
520: Desktop Environment</p></li>
521: <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
522: Desktop Environment</p></li>
523: </ul></div>
524: <p>...just to name a few.</p>
525: <p>pkgsrc has built-in support for handling varying dependencies,
526: such as pthreads and X11, and extended features such as IPv6 support on
527: a range of platforms.</p>
528: <div class="sect2" lang="en">
529: <div class="titlepage"><div><div><h3 class="title">
530: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
531: <p>
532: pkgsrc provides the following key features:
533: </p>
534: <div class="itemizedlist"><ul type="disc">
535: <li><p>Easy building of software from source as well as the creation
536: and installation of binary packages. The source and latest
537: patches are retrieved from a master or mirror download site, checksum
538: verified, then built on your system. Support for binary-only
539: distributions is available for both native platforms and NetBSD
540: emulated platforms.</p></li>
541: <li><p>All packages are installed in a consistent directory tree,
542: including binaries, libraries, man pages and other
543: documentation.</p></li>
544: <li><p>Package dependencies, including when performing package updates,
545: are handled automatically. The configuration files of various
546: packages are handled automatically during updates, so local changes
547: are preserved.</p></li>
548: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
549: consists of highly portable code. This allows the greatest speed of
550: development when porting to new a platform. This portability also
551: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
552: platforms</em></span>.</p></li>
553: <li><p>The installation prefix, acceptable software licenses,
554: international encryption requirements and build-time options for a
555: large number of packages are all set in a simple, central
556: configuration file.</p></li>
557: <li><p>The entire source (not including the distribution files) is
558: freely available under a BSD license, so you may extend and adapt
559: pkgsrc to your needs. Support for local packages and patches is
560: available right out of the box, so you can configure it specifically
561: for your environment.</p></li>
562: </ul></div>
563: <p>The following principles are basic to pkgsrc:</p>
564: <div class="itemizedlist"><ul type="disc">
565: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.6 rillig 566: — That means, if a package contains bugs, it's better to find
1.1 dsieger 567: them and to complain about them rather than to just install the package
568: and hope that it works. There are numerous checks in pkgsrc that try to
569: 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
570: of shell scripts), and post-installation checks (installed files,
571: references to shared libraries, script interpreters).</p></li>
572: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.6 rillig 573: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 574: pkgsrc has been ported to many operating systems. Care is taken that
575: packages behave the same on all platforms.</p></li>
576: </ul></div>
577: </div>
578: <div class="sect2" lang="en">
579: <div class="titlepage"><div><div><h3 class="title">
580: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
581: <p>pkgsrc consists of both a source distribution and a binary
582: distribution for these operating systems. After retrieving the required
583: source or binaries, you can be up and running with pkgsrc in just
584: minutes!</p>
585: <p>pkgsrc was derived from FreeBSD's ports system, and
586: initially developed for NetBSD only. Since then, pkgsrc has
587: grown a lot, and now supports the following platforms:</p>
588: <div class="table">
589: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
590: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
591: <colgroup>
592: <col>
593: <col>
594: </colgroup>
595: <thead><tr>
596: <th>Platform</th>
597: <th>Date Support Added</th>
598: </tr></thead>
599: <tbody>
600: <tr>
601: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
602: <td align="center">Aug 1997</td>
603: </tr>
604: <tr>
605: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
606: <td align="center">Mar 1999</td>
607: </tr>
608: <tr>
609: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
610: <td align="center">Jun 1999</td>
611: </tr>
612: <tr>
613: <td>
614: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
615: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
616: </td>
617: <td align="center">Oct 2001</td>
618: </tr>
619: <tr>
620: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
621: <td align="center">Nov 2002</td>
622: </tr>
623: <tr>
624: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
625: <td align="center">Nov 2002</td>
626: </tr>
627: <tr>
628: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
629: <td align="center">Dec 2002</td>
630: </tr>
631: <tr>
632: <td>BSD/OS</td>
633: <td align="center">Dec 2003</td>
634: </tr>
635: <tr>
636: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
637: <td align="center">Dec 2003</td>
638: </tr>
639: <tr>
640: <td>
641: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
642: (Microsoft Windows Services for Unix)
643: </td>
644: <td align="center">Mar 2004</td>
645: </tr>
646: <tr>
647: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
648: <td align="center">Oct 2004</td>
649: </tr>
650: <tr>
651: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
652: <td align="center">Nov 2004</td>
653: </tr>
654: <tr>
655: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
656: <td align="center">Apr 2007</td>
657: </tr>
658: </tbody>
659: </table></div>
660: </div>
661: <br class="table-break">
662: </div>
663: </div>
664: <div class="sect1" lang="en">
665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
666: <a name="overview"></a>1.2. Overview</h2></div></div></div>
667: <p>This document is divided into three parts. The first,
668: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
669: describes how one can use one of the packages in the Package
670: Collection, either by installing a precompiled binary package,
671: or by building one's own copy using the NetBSD package system.
672: 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
673: package so it can be easily built by other NetBSD users without
674: knowing about the package's building details. The third part,
675: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
676: is intended for those who want to understand how pkgsrc is
677: implemented.</p>
678: <p>This document is available in various formats:
679: <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>
680: </div>
681: <div class="sect1" lang="en">
682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
683: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
684: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
685: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
686: terminology used within this document.</p>
687: <div class="variablelist"><dl>
688: <dt><span class="term">Package</span></dt>
689: <dd><p>A set of files and building instructions
690: that describe what's necessary
691: to build a certain piece of software using
692: pkgsrc. Packages are traditionally stored under
693: <code class="filename">/usr/pkgsrc</code>.</p></dd>
694: <dt><span class="term">The NetBSD package system</span></dt>
695: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
696: is part of the NetBSD operating system and can be bootstrapped
697: to run on non-NetBSD operating systems as well. It handles
698: building (compiling), installing, and removing of
699: packages.</p></dd>
700: <dt><span class="term">Distfile</span></dt>
701: <dd><p>This term describes the file or files that are
702: provided by the author of the piece of software to
703: distribute his work. All the changes necessary to build on
704: NetBSD are reflected in the corresponding package. Usually
705: the distfile is in the form of a compressed tar-archive,
706: but other types are possible, too. Distfiles are usually
707: stored below
708: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
709: <dt><span class="term">Port</span></dt>
710: <dd><p>This is the term used by FreeBSD and OpenBSD people
711: for what we call a package.
712: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
713: architecture.</p></dd>
714: <dt><span class="term">Precompiled/binary package</span></dt>
715: <dd>
716: <p>A set of binaries built with pkgsrc from a distfile
717: and stuffed together in a single <code class="filename">.tgz</code>
718: file so it can be installed on machines of the same
719: machine architecture without the need to
720: recompile. Packages are usually generated in
721: <code class="filename">/usr/pkgsrc/packages</code>; there is also
722: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
723: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
724: especially in the context of precompiled packages.</p>
725: </dd>
726: <dt><span class="term">Program</span></dt>
727: <dd><p>The piece of software to be installed which will be
728: constructed from all the files in the distfile by the
729: actions defined in the corresponding package.</p></dd>
730: </dl></div>
731: <div class="sect2" lang="en">
732: <div class="titlepage"><div><div><h3 class="title">
733: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
734: <div class="variablelist"><dl>
735: <dt><span class="term">pkgsrc users</span></dt>
736: <dd>
737: <p>The
738: pkgsrc users are people who use the packages provided by pkgsrc.
739: Typically they are system administrators. The people using the
740: software that is inside the packages (maybe called “<span class="quote">end
741: users</span>”) are not covered by the pkgsrc guide.</p>
742: <p>There are two kinds of pkgsrc users: Some only want to
743: install pre-built binary packages. Others build the pkgsrc
744: packages from source, either for installing them directly or for
745: 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
746: documentation.</p>
747: </dd>
748: <dt><span class="term">package maintainers</span></dt>
749: <dd><p>A
750: 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>
751: <dt><span class="term">infrastructure developers</span></dt>
752: <dd><p>These people are involved in all those files
753: that live in the <code class="filename">mk/</code> directory and below.
754: 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,
755: too.</p></dd>
756: </dl></div>
757: </div>
758: </div>
759: <div class="sect1" lang="en">
760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
761: <a name="typography"></a>1.4. Typography</h2></div></div></div>
762: <p>When giving examples for commands, shell prompts are used to
763: show if the command should/can be issued as root, or if
764: “<span class="quote">normal</span>” user privileges are sufficient. We use a
765: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
766: shell prompt, assuming they use the C-shell or tcsh.</p>
767: </div>
768: </div>
769: <div class="part" lang="en">
770: <div class="titlepage"><div><div><h1 class="title">
771: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
772: <div class="toc">
773: <p><b>Table of Contents</b></p>
774: <dl>
775: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
776: <dd><dl>
777: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
778: <dd><dl>
779: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
780: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
781: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
782: </dl></dd>
783: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
784: <dd><dl>
785: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
786: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
787: </dl></dd>
788: </dl></dd>
789: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
790: <dd><dl>
791: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
792: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
793: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
794: <dd><dl>
795: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
796: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
797: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
798: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
799: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
800: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
801: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
802: </dl></dd>
803: </dl></dd>
804: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
805: <dd><dl>
806: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
807: <dd><dl>
808: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
809: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
810: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
811: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
812: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
813: <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>
814: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
815: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
816: </dl></dd>
817: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
818: <dd><dl>
819: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
820: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
821: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
822: </dl></dd>
823: </dl></dd>
824: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
825: <dd><dl>
826: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
827: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.4 rillig 828: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
829: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 830: <dd><dl>
1.4 rillig 831: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
832: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
833: <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 834: </dl></dd>
1.4 rillig 835: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
836: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 837: </dl></dd>
838: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
839: <dd><dl>
840: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
841: <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 842: </dl></dd>
843: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
844: builds)</a></span></dt>
1.1 dsieger 845: <dd><dl>
1.6 rillig 846: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
847: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
848: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
849: <dd><dl>
850: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
851: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
852: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
853: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
854: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
855: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
856: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
857: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
858: </dl></dd>
859: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
860: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
861: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
862: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
863: </dl></dd>
864: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
865: <dd><dl>
866: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
867: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
868: </dl></dd>
869: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
870: <dd><dl>
871: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
872: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
873: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
874: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
875: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
876: <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>
877: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
878: <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>
879: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
880: <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 881: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 882: <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>
883: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
884: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
885: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
886: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
887: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
888: <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 889: </dl></dd>
890: </dl>
891: </div>
892: <div class="chapter" lang="en">
893: <div class="titlepage"><div><div><h2 class="title">
894: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
895: <div class="toc">
896: <p><b>Table of Contents</b></p>
897: <dl>
898: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
899: <dd><dl>
900: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
901: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
902: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
903: </dl></dd>
904: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
905: <dd><dl>
906: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
907: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
908: </dl></dd>
909: </dl>
910: </div>
911: <p>Before you download and extract the files, you need to decide
912: where you want to extract them. When using pkgsrc as root user, pkgsrc
913: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
914: free to install the sources and binary packages wherever you want in
915: your filesystem, provided that the pathname does not contain white-space
916: or other characters that are interpreted specially by the shell and some
917: other programs. A safe bet is to use only letters, digits, underscores
918: and dashes.</p>
919: <div class="sect1" lang="en">
920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
921: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
922: <p>Before you download any pkgsrc files, you should decide
923: whether you want the <span class="emphasis"><em>current</em></span> branch or the
924: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
925: quarterly basis from the current branch and only gets modified
926: for security updates. The names of the stable branches are built
927: from the year and the quarter, for example
928: <code class="literal">2007Q1</code>.</p>
929: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
930: want to download pkgsrc. You can get it as a tar file, via SUP,
931: or via CVS. All three ways are described here.</p>
932: <div class="sect2" lang="en">
933: <div class="titlepage"><div><div><h3 class="title">
934: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
935: <p>The primary download location for all pkgsrc files is
936: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
937: number of subdirectories for different purposes, which are
938: 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>
939: <p>The tar file for the current branch is in the directory
940: <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>.
941: It is autogenerated daily.</p>
942: <p>The tar file for the stable branch 2007Q1 is in the
943: 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>
944: <p>After downloading the tar file, change to the directory
945: where you want to have pkgsrc. This is usually
946: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
947: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
948: </div>
949: <div class="sect2" lang="en">
950: <div class="titlepage"><div><div><h3 class="title">
951: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
952: <p>As an alternative to the tar file, you can get pkgsrc via
953: the Software Update Protocol, SUP. To do so, make sure your
954: supfile has a line
955:
956: </p>
957: <pre class="programlisting">
958: release=pkgsrc
959: </pre>
960: <p>
961:
962: in it, see the examples in
963: <code class="filename">/usr/share/examples/supfiles</code>, and that the
964: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
965: run <span><strong class="command">sup -v
966: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
967: </div>
968: <div class="sect2" lang="en">
969: <div class="titlepage"><div><div><h3 class="title">
970: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
971: <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>
972: installed. To do an initial (full) checkout of pkgsrc, you first
973: have to set some environment variables. For the C-Shell,
974: type:</p>
975: <pre class="screen">
976: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
977: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
978: </pre>
979: <p>Or, the same for the bourne shell:</p>
980: <pre class="screen">
981: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
982: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
983: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
984: </pre>
1.2 rillig 985: <p>By default, cvs doesn't do things like most people would
986: expect it to do, and this is unlikely to change. But there is a
987: way to convince cvs, by creating a file called
988: <code class="filename">.cvsrc</code> in your home directory and saving
989: the following lines to it. This file will save you lots of
990: headache and some bug reports, so we strongly recommend it. You
991: can find an explanation of this file in the CVS
992: documentation.</p>
993: <pre class="programlisting">
994: # recommended CVS configuration file from the pkgsrc guide
995: checkout -P
1.4 rillig 996: update -dP
1.2 rillig 997: release -d
1.4 rillig 998: diff -upN
1.2 rillig 999: cvs -q -z3
1000: rdiff -u
1001: </pre>
1.1 dsieger 1002: <p>Then, you change to the directory where you want to have
1003: your copy of pkgsrc. In most cases this is
1004: <code class="filename">/usr</code>. In that directory you run the
1005: checkout command, which is <span><strong class="command">cvs -q checkout -P
1006: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1007: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1008: branch. This command will create a directory called
1009: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1010: it.</p>
1011: </div>
1012: </div>
1013: <div class="sect1" lang="en">
1014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1015: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1016: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1017: (which also works if you have first installed it via a tar
1018: file). It saves bandwidth and hard disk activity, compared to
1019: downloading the tar file again.</p>
1020: <div class="sect2" lang="en">
1021: <div class="titlepage"><div><div><h3 class="title">
1022: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1023: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1024: <h3 class="title">Warning</h3>
1025: <p>When updating from a tar file, you first need to
1026: completely remove the old pkgsrc directory. Otherwise those
1027: files that have been removed from pkgsrc in the mean time will
1028: not be removed on your local disk, resulting in inconsistencies.
1029: When removing the old files, any changes that you have done to
1030: the pkgsrc files will be lost after updating. Therefore updating
1031: via CVS is strongly recommended.</p>
1032: </div>
1033: <p>Note that by default the distfiles and the binary packages
1034: are saved in the pkgsrc tree, so don't forget to rescue them
1035: before updating. You can also configure pkgsrc to use other than
1036: the default directories by setting the
1037: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1038: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1039: <p>To update pkgsrc from a tar file, download the tar file as
1040: explained above. Then, make sure that you have not made any
1041: changes to the files in the pkgsrc directory. Remove the pkgsrc
1042: directory and extract the new tar file. Done.</p>
1043: </div>
1044: <div class="sect2" lang="en">
1045: <div class="titlepage"><div><div><h3 class="title">
1046: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1047: <p>To update pkgsrc via CVS, make sure the environment
1048: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1049: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1050: -dP</strong></span>.</p>
1051: <div class="sect3" lang="en">
1052: <div class="titlepage"><div><div><h4 class="title">
1053: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1054: <p>When updating pkgsrc, the CVS program keeps track of the
1055: branch you selected. But if you, for whatever reason, want to
1056: switch from the stable branch to the current one, you can do it
1057: by adding the option “<span class="quote">-A</span>” after the
1058: “<span class="quote">update</span>” keyword. To switch from the current branch
1059: back to the stable branch, add the
1060: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1061: </div>
1062: <div class="sect3" lang="en">
1063: <div class="titlepage"><div><div><h4 class="title">
1064: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1065: <p>When you update pkgsrc, the CVS program will only touch
1066: those files that are registered in the CVS repository. That
1067: means that any packages that you created on your own will stay
1068: unmodified. If you change files that are managed by CVS, later
1069: updates will try to merge your changes with those that have been
1070: done by others. See the CVS manual, chapter
1071: “<span class="quote">update</span>” for details.</p>
1072: </div>
1073: </div>
1074: </div>
1075: </div>
1076: <div class="chapter" lang="en">
1077: <div class="titlepage"><div><div><h2 class="title">
1078: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1079: <div class="toc">
1080: <p><b>Table of Contents</b></p>
1081: <dl>
1082: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1083: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1084: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1085: <dd><dl>
1086: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1087: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1088: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1089: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1090: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1091: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1092: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1093: </dl></dd>
1094: </dl>
1095: </div>
1096: <div class="sect1" lang="en">
1097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1098: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1099: <p>
1100: We provide a bootstrap kit in both source and binary form for other
1101: platforms than NetBSD, consisting of the pkg administration tools and other
1102: tools required to use pkgsrc and build packages.
1103: </p>
1104: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1105: <h3 class="title">Note</h3>
1106: <p>
1107: Older binary snapshots are available in the
1108: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1109: directory on ftp.NetBSD.org.</p>
1110: </div>
1111: <div class="table">
1112: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1113: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1114: <colgroup>
1115: <col>
1116: <col>
1117: <col>
1118: <col>
1119: </colgroup>
1120: <thead><tr>
1121: <th>Platform</th>
1122: <th>Latest snapshot</th>
1123: <th>Binary kit</th>
1124: <th>Binary packages</th>
1125: </tr></thead>
1126: <tbody>
1127: <tr>
1128: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1129: <td class="date">20021209</td>
1130: <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>
1131: <td class="binary-pkgs-url"> </td>
1132: </tr>
1133: <tr>
1134: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1135: <td class="date">20030623</td>
1136: <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>
1137: <td class="binary-pkgs-url"> </td>
1138: </tr>
1139: <tr>
1140: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1141: <td class="date">20041219</td>
1142: <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>
1143: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1144: </tr>
1145: <tr>
1146: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1147: <td class="date">20050320</td>
1148: <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>
1149: <td class="binary-pkgs-url"> </td>
1150: </tr>
1151: <tr>
1152: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1153: <td class="date">20050625</td>
1154: <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>
1155: <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>
1156: </tr>
1157: <tr>
1158: <td class="osname">Debian GNU Linux/i386</td>
1159: <td class="date">20031023</td>
1160: <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>
1161: <td class="binary-pkgs-url"> </td>
1162: </tr>
1163: <tr>
1164: <td class="osname">Fedora Core 2 Linux/i386</td>
1165: <td class="date">20050618</td>
1166: <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>
1167: <td class="binary-pkgs-url"> </td>
1168: </tr>
1169: <tr>
1170: <td class="osname">Fedora Core 4 Linux/i386</td>
1171: <td class="date">20060105</td>
1172: <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>
1173: <td class="binary-pkgs-url"> </td>
1174: </tr>
1175: <tr>
1176: <td class="osname">FreeBSD 3.5/i386</td>
1177: <td class="date">20030411</td>
1178: <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>
1179: <td class="binary-pkgs-url"> </td>
1180: </tr>
1181: <tr>
1182: <td class="osname">FreeBSD 4.7/i386</td>
1183: <td class="date">20021211</td>
1184: <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>
1185: <td class="binary-pkgs-url"> </td>
1186: </tr>
1187: <tr>
1188: <td class="osname">FreeBSD 5.0/i386</td>
1189: <td class="date">20030411</td>
1190: <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>
1191: <td class="binary-pkgs-url"> </td>
1192: </tr>
1193: <tr>
1194: <td class="osname">FreeBSD 5.1/i386</td>
1195: <td class="date">20030630</td>
1196: <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>
1197: <td class="binary-pkgs-url"> </td>
1198: </tr>
1199: <tr>
1200: <td class="osname">FreeBSD 5.2.1/i386</td>
1201: <td class="date">20040227</td>
1202: <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>
1203: <td class="binary-pkgs-url"> </td>
1204: </tr>
1205: <tr>
1206: <td class="osname">FreeBSD 5.3/i386</td>
1207: <td class="date">20050119</td>
1208: <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>
1209: <td class="binary-pkgs-url"> </td>
1210: </tr>
1211: <tr>
1212: <td class="osname">HP-UX 11.11/hppa</td>
1213: <td class="date">20070421</td>
1214: <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>
1215: <td class="binary-pkgs-url"> </td>
1216: </tr>
1217: <tr>
1218: <td class="osname">Interix 3.5</td>
1219: <td class="date">20061106</td>
1220: <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>
1221: <td class="binary-pkgs-url"> </td>
1222: </tr>
1223: <tr>
1224: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1225: <td class="date">20040911</td>
1226: <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>
1227: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1228: </tr>
1229: <tr>
1230: <td class="osname">IRIX 6.5 64-bit ABI</td>
1231: <td class="date">20040912</td>
1232: <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>
1233: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1234: </tr>
1235: <tr>
1236: <td class="osname">OpenBSD 3.2/i386</td>
1237: <td class="date">20030420</td>
1238: <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>
1239: <td class="binary-pkgs-url"> </td>
1240: </tr>
1241: <tr>
1242: <td class="osname">OpenBSD 3.3/i386</td>
1243: <td class="date">20030503</td>
1244: <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>
1245: <td class="binary-pkgs-url"> </td>
1246: </tr>
1247: <tr>
1248: <td class="osname">OpenBSD 3.5/i386</td>
1249: <td class="date">20040703</td>
1250: <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>
1251: <td class="binary-pkgs-url"> </td>
1252: </tr>
1253: <tr>
1254: <td class="osname">OSF1 5.1/alpha</td>
1255: <td class="date">20070420</td>
1256: <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>
1257: <td class="binary-pkgs-url"> </td>
1258: </tr>
1259: <tr>
1260: <td class="osname">Slackware Linux 8.1/i386</td>
1261: <td class="date">20030417</td>
1262: <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>
1263: <td class="binary-pkgs-url"> </td>
1264: </tr>
1265: <tr>
1266: <td class="osname">Slackware Linux 9/i386</td>
1267: <td class="date">20040703</td>
1268: <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>
1269: <td class="binary-pkgs-url"> </td>
1270: </tr>
1271: <tr>
1272: <td class="osname">Solaris 8/sparc</td>
1273: <td class="date">20050220</td>
1274: <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>
1275: <td class="binary-pkgs-url"> </td>
1276: </tr>
1277: <tr>
1278: <td class="osname">Solaris 8/i386</td>
1279: <td class="date">20050220</td>
1280: <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>
1281: <td class="binary-pkgs-url"> </td>
1282: </tr>
1283: <tr>
1284: <td class="osname">Solaris 9/sparc</td>
1285: <td class="date">20060713</td>
1286: <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>
1287: <td class="binary-pkgs-url"> </td>
1288: </tr>
1289: <tr>
1290: <td class="osname">Solaris 9/i386</td>
1291: <td class="date">20030411</td>
1292: <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>
1293: <td class="binary-pkgs-url"> </td>
1294: </tr>
1295: </tbody>
1296: </table></div>
1297: </div>
1298: <br class="table-break"><p>
1299: Simply download the binary kit for your platform, and extract it into
1300: <code class="filename">/</code> e.g.
1301: </p>
1302: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1303: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1304: | tar -xpf -</code></strong></pre>
1305: <p>
1306: Of course, as with any binary distributions, you should verify the
1307: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1308: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1309: file and inspect the contents before extracting it.
1310: </p>
1311: </div>
1312: <div class="sect1" lang="en">
1313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1314: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1315: <p>Installing the bootstrap kit from source should be as simple as:</p>
1316: <pre class="screen">
1317: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1318: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1319: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1320: </pre>
1321: <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
1322: pkgsrc before bootstrapping. The given
1323: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1324: <code class="filename">/usr/pkg</code> for the
1325: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1326: and <code class="filename">/var/db/pkg</code> for the package database
1327: directory where pkgsrc will do its internal bookkeeping.
1328: However, these can also be set using command-line
1329: arguments.</p>
1330: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1331: available for supported platforms. An up-to-date list of these can be
1332: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1333: Note that this only works for privileged builds that install
1334: into <code class="filename">/usr/pkg</code>.</p>
1335: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1336: <h3 class="title">Note</h3>
1337: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1338: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1339: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1340: instead of “<span class="quote">make</span>”.</p>
1341: </div>
1342: </div>
1343: <div class="sect1" lang="en">
1344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1345: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1346: <p>Here are some platform-specific notes you should be aware of.</p>
1347: <div class="sect2" lang="en">
1348: <div class="titlepage"><div><div><h3 class="title">
1349: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1350: <p>Darwin 5.x and up are supported. There are two methods of using
1351: pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1352: image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1353: partition</a>.</p>
1354: <p>Before you start, you will need to download and install the Mac OS X Developer
1355: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1356: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1357: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1358: if you intend to build packages that use the X11 Window System.</p>
1359: <p>If you already have a UFS or HFSX partition, or have a spare partition
1360: that you can format as UFS or HFSX, it is recommended to use that instead of
1361: the disk image. It'll be somewhat faster and will mount automatically
1362: at boot time, where you must manually mount a disk image.</p>
1363: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1364: <h3 class="title">Note</h3>
1365: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1366: 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>
1367: </div>
1368: <div class="sect3" lang="en">
1369: <div class="titlepage"><div><div><h4 class="title">
1370: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1371: <p>Create the disk image:</p>
1372: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1373: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1374: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1375: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1376: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1377: <h3 class="title">Note</h3>
1378: <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>
1379: </div>
1380: <p>Allow suid:</p>
1381: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.5 weinem 1382: <p>Changing the build directory:</p>
1383: <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>
1384: <pre class="programlisting">
1385: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1386: </pre>
1.1 dsieger 1387: </div>
1388: <div class="sect3" lang="en">
1389: <div class="titlepage"><div><div><h4 class="title">
1390: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1391: <p>By default, <code class="filename">/usr</code> will be on your root file
1392: system, normally HFS+. It is possible to use the default
1393: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1394: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1395: or HFSX file system. Obviously, another symlink is required if you want to
1396: place the package database directory outside the
1397: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1398: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1399: <p>If you created your partitions at the time of installing Mac OS X
1400: and formatted the target partition as UFS or HFSX, it should automatically
1401: mount on <code class="filename">/Volumes/<volume name></code> when the
1402: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1403: to ensure that the partition map correctly reflects
1404: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1405: <p>The problem is that none of the disk tools will let you touch a
1406: disk that is booted from. You can unmount the partition, but even if
1407: you newfs it, the partition type will be incorrect and the
1408: automounter won't mount it. It can be mounted manually, but it won't
1409: appear in Finder.</p>
1410: <p>You'll need to boot off of the OS X Installation (User) CD. When
1411: the Installation program starts, go up to the menu and select Disk
1412: Utility. Now, you will be able to select the partition you want
1413: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1414: installer which will reboot your machine. The new UFS or HFSX file system
1415: will appear in Finder.</p>
1416: <p>Be aware that the permissions on the new file system will be writable
1417: by root only.</p>
1418: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1419: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1420: </div>
1421: </div>
1422: <div class="sect2" lang="en">
1423: <div class="titlepage"><div><div><h3 class="title">
1424: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1425: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1426: other versions may work.</p>
1427: <p>Care should be taken so that the tools that this kit installs do not conflict
1428: with the FreeBSD userland tools. There are several steps:</p>
1429: <div class="orderedlist"><ol type="1">
1430: <li><p>FreeBSD stores its ports pkg database in
1431: <code class="filename">/var/db/pkg</code>. It is therefore
1432: recommended that you choose a different location (e.g.
1433: <code class="filename">/usr/pkgdb</code>) by
1434: using the --pkgdbdir option to the bootstrap script.</p></li>
1435: <li>
1436: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1437: good idea to move them out of the way to avoid confusion, e.g.</p>
1438: <pre class="screen">
1439: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1440: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1441: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1442: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1443: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1444: </pre>
1445: </li>
1.4 rillig 1446: <li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1447: <code class="filename">/etc/mk.conf.example</code> file
1448: when you use the bootstrap script.</p></li>
1449: </ol></div>
1450: </div>
1451: <div class="sect2" lang="en">
1452: <div class="titlepage"><div><div><h3 class="title">
1453: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1454: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1455: providing a Unix-like environment with a tighter kernel integration than
1456: available with Cygwin. It is part of the Windows Services for Unix
1457: package, available for free for any licensed copy of Windows 2000, XP
1458: (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>
1459: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1460: are not officially supported. (The main difference in 3.0/3.1 is lack
1461: of pthreads, but other parts of libc may also be lacking.)</p>
1462: <p>Services for Unix Applications (aka SUA) is an integrated component
1463: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1464: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1465: <div class="sect3" lang="en">
1466: <div class="titlepage"><div><div><h4 class="title">
1467: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1468: <p>At an absolute minimum, the following packages must be installed from
1469: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1470: <div class="itemizedlist"><ul type="disc">
1471: <li><p>Utilities -> Base Utilities</p></li>
1472: <li><p>Interix GNU Components -> (all)</p></li>
1473: <li><p>Remote Connectivity</p></li>
1474: <li><p>Interix SDK</p></li>
1475: </ul></div>
1476: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1477: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1478: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1479: pkgsrc (or from a binary package).</p>
1480: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1481: not need to be installed, but Remote Connectivity itself should be
1482: installed in order to have a working inetd.</p>
1483: <p>During installation you may be asked whether to enable setuid
1484: behavior for Interix programs, and whether to make pathnames default to
1485: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1486: enabled. (Without case-sensitivity, a large number of packages including
1487: perl will not build.)</p>
1488: <p>NOTE: Newer Windows service packs change the way binary execution
1489: works (via the Data Execution Prevention feature). In order to use
1490: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1491: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1492: must be installed. Hotfixes are available from Microsoft through a
1493: support contract; however, a NetBSD developer has made most Interix
1494: 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>
1495: <p>In addition to the hotfix noted above, it may be necessary to
1496: disable Data Execution Prevention entirely to make Interix functional.
1497: This may happen only with certain types of CPUs; the cause is not fully
1498: understood at this time. If gcc or other applications still segfault
1499: repeatedly after installing one of the hotfixes note above, the
1500: following option can be added to the appropriate "boot.ini" line on the
1501: Windows boot drive: /NoExecute=AlwaysOff
1502: (WARNING, this will disable DEP completely, which may be a security
1503: risk if applications are often run as a user in the Administrators
1504: group!)</p>
1505: </div>
1506: <div class="sect3" lang="en">
1507: <div class="titlepage"><div><div><h4 class="title">
1508: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1509: <p>If SFU is already installed and you wish to alter these settings to work
1510: with pkgsrc, note the following things.</p>
1511: <div class="itemizedlist"><ul type="disc">
1512: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1513: Windows Services for UNIX, then click Change. In the installer, choose
1514: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1515: <li>
1516: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1517: change the following registry key:</p>
1518: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1519: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1520: </li>
1521: <li>
1522: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1523: following registry key:</p>
1524: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1525: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1526: </li>
1527: </ul></div>
1528: </div>
1529: <div class="sect3" lang="en">
1530: <div class="titlepage"><div><div><h4 class="title">
1531: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1532: <p>The package manager (either the pkgsrc "su" user, or the user
1533: running "pkg_add") must be a member of the local Administrators
1534: group. Such a user must also be used to run the bootstrap. This is
1535: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1536: <p>The package manager should use a umask of 002. "make install" will
1537: automatically complain if this is not the case. This ensures that
1538: directories written in /var/db/pkg are Administrators-group writeable.</p>
1539: <p>The popular Interix binary packages from http://www.interopsystems.com/
1540: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1541: NOT be used in conjunction with pkgsrc. If you choose to use them at
1542: the same time as the pkgsrc packages, ensure that you use the proper
1543: pkg_* tools for each type of binary package.</p>
1544: <p>The TERM setting used for DOS-type console windows (including those
1545: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1546: don't have a termcap/terminfo entry for it, but the following .termcap
1547: entry provides adequate emulation in most cases:</p>
1548: <pre class="programlisting">
1549: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1550: </pre>
1551: </div>
1552: <div class="sect3" lang="en">
1553: <div class="titlepage"><div><div><h4 class="title">
1554: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1555: <p>Though Interix suffices as a familiar and flexible substitute
1556: for a full Unix-like platform, it has some drawbacks that should
1557: be noted for those desiring to make the most of Interix.</p>
1558: <div class="itemizedlist"><ul type="disc">
1559: <li>
1560: <p><span class="strong"><strong>X11:</strong></span></p>
1561: <p>Interix comes with the standard set of X11R6 client libraries,
1562: and can run X11 based applications, but it does
1563: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1564: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1565: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1566: (available in a trimmed version for Interix from Interop Systems as the
1567: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1568: and the free X11 server included with
1569: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1570: </li>
1571: <li>
1572: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1573: <p>Because Interix runs in a completely different NT subsystem from
1574: Win32 applications, it does not currently support various X11
1575: protocol extensions for acceleration (such as MIT-SHM or DGA).
1576: Most interactive applications to a local X server will run
1577: reasonably fast, but full motion video and other graphics
1578: intensive applications may require a faster-than-expected CPU.</p>
1579: </li>
1580: <li>
1581: <p><span class="strong"><strong>Audio:</strong></span></p>
1582: <p>Interix has no native support for audio output. For audio
1583: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1584: audio system on Interix. Unlike on most platforms, the
1585: <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
1586: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1587: server component. To output audio via an Interix host, the
1588: <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
1589: must also be installed.</p>
1590: </li>
1591: <li>
1592: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1593: <p>Direct device access is not currently supported in Interix, so it
1594: is not currently possible to access CD/DVD drives, USB devices,
1595: or SCSI devices through non-filesystem means. Among other things,
1596: this makes it impossible to use Interix directly for CD/DVD
1597: burning.</p>
1598: </li>
1599: <li>
1600: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1601: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1602: drives are also not directly accessible in Interix. However,
1603: support is in work to make tape drive access possible by using
1604: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1605: esound server).</p>
1606: </li>
1607: </ul></div>
1608: </div>
1609: <div class="sect3" lang="en">
1610: <div class="titlepage"><div><div><h4 class="title">
1611: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1612: <p>It is not necessary, in general, to have a "root" user on the
1613: Windows system; any member of the local Administrators group will
1614: suffice. However, some packages currently assume that the user
1615: named "root" is the privileged user. To accommodate these, you
1616: may create such a user; make sure it is in the local group
1617: Administrators (or your language equivalent).</p>
1618: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1619: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1620: time being, install packages as the local Administrator (or
1621: your language equivalent), or run the following command after
1622: installing a package to work around the issue:</p>
1623: <pre class="screen">
1624: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1625: </pre>
1626: </div>
1627: </div>
1628: <div class="sect2" lang="en">
1629: <div class="titlepage"><div><div><h3 class="title">
1630: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1631: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1632: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1633: according to your preference. If you do not have a license for the MIPSpro
1634: compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1635: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1636: 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>,
1637: etc.</p>
1638: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1639: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1640: you start out using "abi=n32", that's what all your packages will be built
1641: with.</p>
1642: <p>Therefore, please make sure that you have no conflicting
1643: <code class="varname">CFLAGS</code> in your environment or the
1.4 rillig 1644: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1645: try to link n32 object files with lib64 or vice versa. Check your
1646: <code class="filename">/etc/compiler.defaults</code>!</p>
1647: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1648: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1649: as it appears that IRIX linker occasionally runs into issues when trying to
1650: link over a network-mounted file system.</p>
1651: <p>The bootstrapping process should set all the right options for programs such
1652: as imake(1), but you may want to set some options depending on your local
1653: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1654: course, your compiler's man pages for details.</p>
1655: <p>If you are using SGI's MIPSPro compiler, please set
1656:
1657: </p>
1658: <pre class="programlisting">
1659: PKGSRC_COMPILER= mipspro
1660: </pre>
1661: <p>
1662:
1.4 rillig 1663: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1664: are using gcc and may end up passing invalid flags to the compiler. Note that
1665: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1666: default.</p>
1667: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1668: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1669: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1670: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1671: '--preserve-path' flag.</p>
1672: </div>
1673: <div class="sect2" lang="en">
1674: <div class="titlepage"><div><div><h3 class="title">
1675: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1676: <p>Some versions of Linux (for example Debian GNU/Linux) need
1677: either libtermcap or libcurses (libncurses). Installing the
1678: distributions libncurses-dev package (or equivalent) should fix
1679: the problem.</p>
1680: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1681: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1682: i386 have been tested.</p>
1683: <p>To bootstrap using icc, assuming the default icc installation
1684: directory:</p>
1685: <pre class="programlisting">
1686: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1687: ac_cv___attribute__=yes ./bootstrap
1688: </pre>
1689: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1690: <h3 class="title">Note</h3>
1691: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1692: </div>
1693: <p>icc supports __attribute__, but the GNU configure test uses a nested
1694: function, which icc does not support. #undef'ing __attribute__ has the
1695: unfortunate side-effect of breaking many of the Linux header files, which
1696: cannot be compiled properly without __attribute__. The test must be
1697: overridden so that __attribute__ is assumed supported by the
1698: compiler.</p>
1699: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.4 rillig 1700: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1701: <pre class="programlisting">
1702: PKGSRC_COMPILER= icc
1703: </pre>
1704: <p>The default installation directory for icc is
1705: <code class="filename">/opt/intel_cc_80</code>, which
1706: is also the pkgsrc default. If you have installed it into a different
1707: directory, set <code class="varname">ICCBASE</code> in
1.4 rillig 1708: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1709: <pre class="programlisting">
1710: ICCBASE= /opt/icc
1711: </pre>
1712: <p>pkgsrc uses the static linking method of the runtime libraries
1713: provided by icc, so binaries can be run on other systems which do not
1714: have the shared libraries installed.</p>
1715: <p>Libtool, however, extracts a list of libraries from the
1716: <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
1717: records it, throwing away the -Bstatic and -Bdynamic options
1718: interspersed between the libraries. This means that
1719: libtool-linked C++ shared libraries will have a runtime
1720: dependency on the icc libraries until this is fixed in
1721: libtool.</p>
1722: </div>
1723: <div class="sect2" lang="en">
1724: <div class="titlepage"><div><div><h3 class="title">
1725: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1726: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1727: <p>Care should be taken so that the tools that this kit installs do not conflict
1728: with the OpenBSD userland tools. There are several steps:</p>
1729: <div class="orderedlist"><ol type="1">
1730: <li><p>OpenBSD stores its ports pkg database in
1731: <code class="filename">/var/db/pkg</code>. It is therefore
1732: recommended that you choose a different location (e.g.
1733: <code class="filename">/usr/pkgdb</code>) by
1734: using the --pkgdbdir option to the bootstrap script.</p></li>
1735: <li>
1736: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1737: good idea to move them out of the way to avoid confusion, e.g.</p>
1738: <pre class="screen">
1739: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1740: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1741: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1742: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1743: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1744: </pre>
1745: </li>
1746: <li>
1.4 rillig 1747: <p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1748: <code class="filename">/etc/mk.conf.example</code> file
1749: when you use the bootstrap script. OpenBSD's make program uses
1.4 rillig 1750: <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1751: as well. You can work around this by enclosing all the pkgsrc-specific parts
1752: of the file with:</p>
1753: <pre class="programlisting">
1754: .ifdef BSD_PKG_MK
1755: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1756: .else
1757: # OpenBSD stuff
1758: .endif
1759: </pre>
1760: </li>
1761: </ol></div>
1762: </div>
1763: <div class="sect2" lang="en">
1764: <div class="titlepage"><div><div><h3 class="title">
1765: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1766: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1767: You will need a working C compiler. Both gcc 2.95.3 and
1768: Sun WorkShop 5 have been tested.</p>
1769: <p>The following packages are required on Solaris 8 for the bootstrap
1770: process and to build packages.</p>
1771: <div class="itemizedlist"><ul type="disc">
1772: <li><p>SUNWsprot</p></li>
1773: <li><p>SUNWarc</p></li>
1774: <li><p>SUNWbtool</p></li>
1775: <li><p>SUNWtoo</p></li>
1776: <li><p>SUNWlibm</p></li>
1777: </ul></div>
1778: <p>Please note that the use of GNU binutils on Solaris is
1779: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1780: <p>Whichever compiler you use, please ensure the compiler tools and
1781: your $prefix are in your <code class="varname">PATH</code>. This includes
1782: <code class="filename">/usr/ccs/{bin,lib}</code>
1783: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1784: <div class="sect3" lang="en">
1785: <div class="titlepage"><div><div><h4 class="title">
1786: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1787: <p>It makes life much simpler if you only use the same gcc consistently
1788: for building all packages.</p>
1789: <p>It is recommended that an external gcc be used only for bootstrapping,
1790: then either build gcc from
1791: <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
1792: package, then remove gcc used during bootstrapping.</p>
1793: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1794: </div>
1795: <div class="sect3" lang="en">
1796: <div class="titlepage"><div><div><h4 class="title">
1797: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1798: <p>You will need at least the following packages installed (from WorkShop
1799: 5.0)</p>
1800: <div class="itemizedlist"><ul type="disc">
1801: <li><p>SPROcc
1802: - Sun WorkShop Compiler C 5.0</p></li>
1803: <li><p>SPROcpl
1804: - Sun WorkShop Compiler C++ 5.0</p></li>
1805: <li><p>SPROild
1806: - Sun WorkShop Incremental Linker</p></li>
1807: <li><p>SPROlang
1808: - Sun WorkShop Compilers common components</p></li>
1809: </ul></div>
1810: <p>You should set the following variables in your
1.4 rillig 1811: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1812: <pre class="programlisting">
1813: CC= cc
1814: CXX= CC
1815: CPP= cc -E
1816: CXXCPP= CC -E
1817: </pre>
1818: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1819: <h3 class="title">Note</h3>
1820: <p>The <code class="varname">CPP</code> setting might break some
1821: packages that use the C preprocessor for processing things other
1822: than C source code.</p>
1823: </div>
1824: </div>
1825: <div class="sect3" lang="en">
1826: <div class="titlepage"><div><div><h4 class="title">
1827: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1828: <p>To build 64-bit packages, you just need to have the
1.4 rillig 1829: following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1830: <pre class="programlisting">
1831: PKGSRC_COMPILER= sunpro
1832: ABI= 64
1833: </pre>
1834: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1835: <h3 class="title">Note</h3>
1836: <p>This setting has been tested for the SPARC
1837: architecture. Intel and AMD machines need some more
1838: work.</p>
1839: </div>
1840: </div>
1841: <div class="sect3" lang="en">
1842: <div class="titlepage"><div><div><h4 class="title">
1843: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1844: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1845: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1846: The workaround is to use another shell for the configure
1847: 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 1848: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1849: <pre class="programlisting">
1850: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1851: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1852: </pre>
1853: <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>
1854: </div>
1855: </div>
1856: </div>
1857: </div>
1858: <div class="chapter" lang="en">
1859: <div class="titlepage"><div><div><h2 class="title">
1860: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1861: <div class="toc">
1862: <p><b>Table of Contents</b></p>
1863: <dl>
1864: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1865: <dd><dl>
1866: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1867: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1868: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1869: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1870: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1871: <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>
1872: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1873: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1874: </dl></dd>
1875: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1876: <dd><dl>
1877: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1878: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1879: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1880: </dl></dd>
1881: </dl>
1882: </div>
1883: <p>Basically, there are two ways of using pkgsrc. The first
1884: is to only install the package tools and to use binary packages
1885: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1886: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1887: of pkgsrc, too. Then you are able to build your own packages,
1888: and you can still use binary packages from someone else.</p>
1889: <div class="sect1" lang="en">
1890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1891: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.5 weinem 1892: <p>To use binary packages, you need some tools to manage them. On
1893: NetBSD, these tools are already installed. On all other operating
1894: systems, you need to install them first. For some platforms, these
1895: tools are already packages in an archive, ready to be extracted in the
1896: <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>
1897: directory of the FTP server.</p>
1.1 dsieger 1898: <p>These pre-built package tools use
1899: <code class="filename">/usr/pkg</code> for the base directory, and
1900: <code class="filename">/var/db/pkg</code> for the database of installed
1901: packages. If you cannot use these directories for whatever
1902: reasons (maybe because you're not root), you have to build the
1903: package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1904: <div class="sect2" lang="en">
1905: <div class="titlepage"><div><div><h3 class="title">
1906: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1907: <p>To install binary packages, you first need to know from where
1908: to get them. The first place where you should look is on the main
1909: 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>
1910: <p>This directory contains binary packages for multiple
1911: platforms. First, select your operating system. (Ignore the
1912: directories with version numbers attached to it, they just exist for
1913: legacy reasons.) Then, select your hardware architecture, and in the
1914: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.
1915: This directory contains a subdirectory called
1916: <code class="filename">All</code>, where (almost) all binary packages are
1917: stored. Almost, because vulnerable packages are moved to the
1918: <code class="filename">vulnerable</code> directory so they don't get
1919: installed accidentally.</p>
1.1 dsieger 1920: </div>
1921: <div class="sect2" lang="en">
1922: <div class="titlepage"><div><div><h3 class="title">
1923: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1924: <p>If you have the files on a CD-ROM or downloaded them to
1925: your hard disk, you can install them with the following command
1926: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1927: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1928: <p>If you have FTP access and you don't want to download the
1929: packages via FTP prior to installation, you can do this
1930: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.5 weinem 1931: <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 1932: <p>Note that any prerequisite packages needed to run the
1933: package in question will be installed, too, assuming they are
1934: present where you install from.</p>
1935: <p>To save some typing, you can set the
1936: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1937: list of paths (including remote URLs); trailing slashes are not allowed.
1938: </p>
1939: <p>Additionally to the <code class="filename">All</code> directory
1940: there exists a <code class="filename">vulnerable</code> directory to
1941: which binary packages with known vulnerabilities are
1942: moved, since removing them could cause missing dependencies. To
1943: use these packages, add the <code class="filename">vulnerable</code>
1944: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1945: <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,
1946: especially after installing new packages, and verify that the
1947: vulnerabilities are acceptable for your configuration. An example
1948: <code class="varname">PKG_PATH</code> would be:
1949: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1950: Please note that semicolon (';') is a shell meta-character, so
1951: you'll probably have to quote it.</p>
1952: <p>After you've installed packages, be sure to have
1953: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1954: <code class="varname">PATH</code> so you can actually start the just
1955: installed program.</p>
1956: </div>
1957: <div class="sect2" lang="en">
1958: <div class="titlepage"><div><div><h3 class="title">
1959: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1960: <p>To deinstall a package, it does not matter whether it was
1961: installed from source code or from a binary package. The
1962: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1963: To delete a package, you can just run <span><strong class="command">pkg_delete
1964: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1965: name can be given with or without version number. Wildcards can
1966: also be used to deinstall a set of packages, for example
1967: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1968: so that the shell does not expand them before
1969: <code class="literal">pkg_delete</code> sees them.</p>
1970: <p>The <code class="option">-r</code> option is very powerful: it
1971: removes all the packages that require the package in question
1972: and then removes the package itself. For example:
1973:
1974: </p>
1975: <pre class="screen">
1976: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1977: </pre>
1978: <p>
1979:
1980: will remove jpeg and all the packages that used it; this allows
1981: upgrading the jpeg package.</p>
1982: </div>
1983: <div class="sect2" lang="en">
1984: <div class="titlepage"><div><div><h3 class="title">
1985: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1986: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1987: installed packages or binary package files.</p>
1988: </div>
1989: <div class="sect2" lang="en">
1990: <div class="titlepage"><div><div><h3 class="title">
1991: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1992: <p>
1993: The NetBSD Security-Officer and Packages Groups maintain a list of
1994: known security vulnerabilities to packages which are (or have been)
1995: included in pkgsrc. The list is available from the NetBSD
1996: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1997: </p>
1998: <p>
1999: 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>,
2000: this list can be downloaded
2001: automatically, and a security audit of all packages installed on a system
2002: can take place.
2003: </p>
2004: <p>
2005: There are two components to
2006: <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
2007: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2008: the list of vulnerabilities from the NetBSD FTP site. The second
2009: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2010: installed packages are vulnerable. If a package is vulnerable, you
2011: will see output similar to the following:
2012: </p>
2013: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
2014: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
2015: <p>
2016: 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
2017: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2018: file daily, and include a package audit in the daily security script.
2019: 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>
2020: 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>.
2021: </p>
2022: </div>
2023: <div class="sect2" lang="en">
2024: <div class="titlepage"><div><div><h3 class="title">
2025: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2026: <p>
2027: 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
2028: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2029: argument to check if your packages are up-to-date, e.g.
2030: </p>
2031: <pre class="screen">
2032: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
2033: ...
2034: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2035: </pre>
2036: <p>You can then use <span><strong class="command">make update</strong></span> to update the
2037: package on your system and rebuild any dependencies.
2038: </p>
2039: </div>
2040: <div class="sect2" lang="en">
2041: <div class="titlepage"><div><div><h3 class="title">
2042: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2043: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
2044: administrative functions on the package system.</p>
2045: </div>
2046: <div class="sect2" lang="en">
2047: <div class="titlepage"><div><div><h3 class="title">
2048: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
2049: <p>Please pay very careful attention to the warnings
2050: 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
2051: inherent dangers of installing binary packages which you did
2052: not create yourself, and the security holes that can be
2053: introduced onto your system by indiscriminate adding of such
2054: files.</p>
2055: <p>The same warning of course applies to every package you
2056: install from source when you haven't completely read and
2057: understood the source code of the package, the compiler that
2058: is used to build the package and all the other tools that are
2059: involved.</p>
2060: </div>
2061: </div>
2062: <div class="sect1" lang="en">
2063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2064: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
2065: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2066: directory now contains a set of packages, organized into
2067: categories. You can browse the online index of packages, or run
2068: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2069: directory to build local <code class="filename">README.html</code> files for
2070: 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>
2071: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2072: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2073: should do so by setting <code class="varname">LOCALBASE</code> in
1.4 rillig 2074: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 2075: different <code class="varname">LOCALBASE</code> definitions on the same
2076: system (inside a chroot is an exception). </p>
2077: <p>The rest of this chapter assumes that the package is already
2078: 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
2079: instructions how to create your own packages.</p>
2080: <div class="sect2" lang="en">
2081: <div class="titlepage"><div><div><h3 class="title">
2082: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
2083: <p>To build packages from source, you need a working C
2084: compiler. On NetBSD, you need to install the
2085: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2086: sets. If you want to build X11-related packages, the
2087: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2088: sets are required, too.</p>
2089: </div>
2090: <div class="sect2" lang="en">
2091: <div class="titlepage"><div><div><h3 class="title">
2092: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2093: <p>The first step for building a package is downloading the
2094: distfiles (i.e. the unmodified source). If they have not yet been
2095: downloaded, pkgsrc will fetch them automatically.</p>
2096: <p>If you have all files that you need in the
2097: <code class="filename">distfiles</code> directory,
2098: you don't need to connect. If the distfiles are on CD-ROM, you can
2099: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2100: </p>
2101: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2102: <p>
1.4 rillig 2103: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 2104: <p>By default a list of distribution sites will be randomly
2105: intermixed to prevent huge load on servers which holding popular
2106: packages (for example, SourceForge.net mirrors). Thus, every
2107: time when you need to fetch yet another distfile all the mirrors
2108: will be tried in new (random) order. You can turn this feature
2109: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2110: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
2111: <p>You can overwrite some of the major distribution sites to
2112: fit to sites that are close to your own. By setting one or two
2113: variables you can modify the order in which the master sites are
2114: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2115: delimited list of domain suffixes.
2116: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2117: contains a whitespace delimited list of regular expressions. It
2118: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2119: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2120: some examples. This may save some of your bandwidth and
2121: time.</p>
2122: <p>You can change these settings either in your shell's environment, or,
2123: if you want to keep the settings, by editing the
1.4 rillig 2124: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 2125: and adding the definitions there.</p>
2126: <p>
2127: If a package depends on many other packages (such as
2128: <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
2129: alternate between periods of
2130: downloading source, and compiling. To ensure you have all the source
2131: downloaded initially you can run the command:
2132: </p>
2133: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2134: <p>
2135: which will output and run a set of shell commands to fetch the
2136: necessary files into the <code class="filename">distfiles</code> directory. You can
2137: also choose to download the files manually.
2138: </p>
2139: </div>
2140: <div class="sect2" lang="en">
2141: <div class="titlepage"><div><div><h3 class="title">
2142: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
2143: <p>
2144: Once the software has downloaded, any patches will be applied, then it
2145: will be compiled for you. This may take some time depending on your
2146: computer, and how many other packages the software depends on and their
2147: compile time.
2148: </p>
2149: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2150: <h3 class="title">Note</h3>
2151: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
2152: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2153: “<span class="quote">make</span>” in the examples in this guide.</p>
2154: </div>
2155: <p>For example, type</p>
2156: <pre class="screen">
2157: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2158: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2159: </pre>
2160: <p>at the shell prompt to build the various components of the
2161: package.</p>
2162: <p>The next stage is to actually install the newly compiled
2163: program onto your system. Do this by entering:
2164:
2165: </p>
2166: <pre class="screen">
2167: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2168: </pre>
2169: <p>
2170:
2171: while you are still in the directory for whatever package you
2172: are installing.</p>
2173: <p>Installing the package on your system may require you to
2174: be root. However, pkgsrc has a
2175: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2176: to only become root for the actual installation step.</p>
2177: <p>That's it, the software should now be installed and setup for use.
2178: You can now enter:
2179:
2180: </p>
2181: <pre class="screen">
2182: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2183: </pre>
2184: <p>
2185:
2186: to remove the compiled files in the work directory, as you shouldn't need
2187: them any more. If other packages were also added to your system
2188: (dependencies) to allow your program to compile, you can tidy these up
2189: also with the command:</p>
2190: <pre class="screen">
2191: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2192: </pre>
2193: <p>Taking the figlet utility as an example, we can install it on our
2194: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2195: <p>The program is installed under the default root of the
2196: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2197: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2198: variable in your environment, and it will use that value as the
2199: root of your packages tree. So, to use
2200: <code class="filename">/usr/local</code>, set
2201: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2202: Please note that you should use a directory which is dedicated to
2203: packages and not shared with other programs (i.e., do not try and
2204: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2205: to add any of your own files or directories (such as
2206: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2207: <code class="filename">pkgsrc/</code>) below the
2208: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2209: conflicts between programs and other files installed by the
2210: package system and whatever else may have been installed
2211: there.</p>
1.4 rillig 2212: <p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2213: alter some configuration options at build time. Have a look at
2214: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2215: of what will be set there by default. Environment variables such
2216: as <code class="varname">LOCALBASE</code> can be set in
1.4 rillig 2217: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2218: set them each time you want to use pkgsrc.</p>
2219: <p>Occasionally, people want to “<span class="quote">look under the
2220: covers</span>” to see what is going on when a package is building
2221: or being installed. This may be for debugging purposes, or out of
2222: simple curiosity. A number of utility values have been added to
2223: help with this.</p>
2224: <div class="orderedlist"><ol type="1">
2225: <li>
2226: <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
2227: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2228: information will be displayed. For example,</p>
2229: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2230: <p>will show all the commands that are invoked, up to and
2231: including the “<span class="quote">patch</span>” stage.</p>
2232: </li>
2233: <li>
2234: <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>
2235: definition, then the <code class="varname">VARNAME</code> definition
2236: should be used, in conjunction with the show-var
2237: 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>
2238: variable <code class="varname">LOCALBASE</code>:</p>
2239: <pre class="screen">
2240: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2241: /usr/pkg
2242: <code class="prompt">%</code>
2243: </pre>
2244: </li>
2245: </ol></div>
2246: <p>If you want to install a binary package that you've either
2247: created yourself (see next section), that you put into
2248: pkgsrc/packages manually or that is located on a remote FTP
2249: server, you can use the "bin-install" target. This target will
2250: 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>,
2251: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2252: sites searched is kept in the variable
2253: <code class="varname">BINPKG_SITES</code>, which defaults to
2254: 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>
2255: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2256: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2257: details.</p>
2258: <p>A final word of warning: If you set up a system that has a
2259: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2260: set that before any packages are installed, as you cannot use
2261: several directories for the same purpose. Doing so will result in
2262: pkgsrc not being able to properly detect your installed packages,
2263: and fail miserably. Note also that precompiled binary packages are
2264: usually built with the default <code class="varname">LOCALBASE</code> of
2265: <code class="filename">/usr/pkg</code>, and that you should
2266: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2267: <code class="varname">LOCALBASE</code>.</p>
2268: </div>
2269: </div>
2270: </div>
2271: <div class="chapter" lang="en">
2272: <div class="titlepage"><div><div><h2 class="title">
2273: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2274: <div class="toc">
2275: <p><b>Table of Contents</b></p>
2276: <dl>
2277: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2278: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.4 rillig 2279: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
2280: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2281: <dd><dl>
1.4 rillig 2282: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2283: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2284: <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 2285: </dl></dd>
1.4 rillig 2286: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2287: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2288: </dl>
2289: </div>
1.4 rillig 2290: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2291: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2292: that file depends on the installation. On NetBSD, when you use
2293: <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
2294: <code class="filename">/etc/</code>. In all other cases the default location is
2295: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2296: bootstrap program to install the binary packages.</p>
2297: <p>During the bootstrap, an example configuration file is created. To
2298: use that, you have to create the directory
2299: <code class="filename">${PREFIX}/etc</code> and copy the example file
2300: there.</p>
2301: <p>The format of the configuration file is that of the usual
2302: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2303: is done by setting variables in this file. Note that you can define all
2304: kinds of variables, and no special error checking (for example for
2305: spelling mistakes) takes place, so you have to try it out to see if it
2306: works.</p>
2307: <div class="sect1" lang="en">
2308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2309: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2310: <p>In this section, you can find some variables that apply to all
2311: pkgsrc packages. A complete list of the variables that can be
2312: configured by the user is available in
2313: <code class="filename">mk/defaults/mk.conf</code>, together with some
2314: comments that describe each variable's intent.</p>
2315: <div class="itemizedlist"><ul type="disc">
2316: <li><p><code class="varname">LOCALBASE</code>: Where
2317: packages will be installed. The default is
2318: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2319: with different <code class="varname">LOCALBASE</code>s!</p></li>
2320: <li><p><code class="varname">CROSSBASE</code>: Where
2321: “<span class="quote">cross</span>” category packages will be
2322: installed. The default is
2323: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
2324: <li><p><code class="varname">X11BASE</code>: Where
2325: X11 is installed on the system. The default is
2326: <code class="filename">/usr/X11R6</code>.</p></li>
2327: <li><p><code class="varname">DISTDIR</code>: Where to store the
2328: downloaded copies of the original source distributions used
2329: for building pkgsrc packages. The default is
2330: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
2331: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2332: database about installed packages is stored. The default is
2333: <code class="filename">/var/db/pkg</code>.</p></li>
2334: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2335: If set, override the packages'
2336: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2337: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2338: Backup location(s) for distribution files and patch files
2339: if not found locally or in
2340: <code class="filename">${MASTER_SITES}</code> or
2341: <code class="filename">${PATCH_SITES}</code> respectively.
2342: The defaults are
2343: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
2344: and
2345: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
2346: <li><p><code class="varname">BINPKG_SITES</code>:
2347: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2348: <em class="replaceable"><code>arch</code></em> are replaced with OS
2349: release (“<span class="quote">2.0</span>”, etc.) and architecture
2350: (“<span class="quote">mipsel</span>”, etc.).</p></li>
2351: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2352: List of acceptable licenses. Whenever you try to build a package
2353: whose license is not in this list, you will get an error message
2354: that includes instructions on how to change this variable.</p></li>
2355: </ul></div>
2356: </div>
2357: <div class="sect1" lang="en">
2358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2359: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2360: <p>XXX
2361: </p>
2362: <div class="itemizedlist"><ul type="disc">
2363: <li><p><code class="varname">PACKAGES</code>: The top level
2364: directory for the binary packages. The default is
2365: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
2366: <li><p><code class="varname">WRKOBJDIR</code>:
2367: The top level directory where, if defined, the separate
2368: working directories will get created, and symbolically
2369: linked to from <code class="filename">${WRKDIR}</code> (see below).
2370: This is useful for building packages on several
2371: architectures, then <code class="filename">${PKGSRCDIR}</code>
2372: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2373: is local to every architecture. (It should be noted that
2374: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.6 rillig 2375: — it is an internal definition which refers to the
1.1 dsieger 2376: root of the pkgsrc tree. It is possible to have many
2377: pkgsrc tree instances.)</p></li>
2378: <li><p><code class="varname">LOCALPATCHES</code>:
2379: Directory for local patches that aren't part of pkgsrc.
1.6 rillig 2380: See <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2381: information.</p></li>
2382: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.4 rillig 2383: the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2384: BSD-style Makefile. If this is not set,
2385: <code class="varname">MAKECONF</code> is set to
2386: <code class="filename">/dev/null</code> to avoid picking up
2387: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
2388: <li><p><code class="varname">DEPENDS_TARGET</code>:
2389: By default, dependencies are only installed, and no binary
2390: package is created for them. You can set this variable to
2391: <code class="literal">package</code> to automatically create binary
2392: packages after installing dependencies.</p></li>
2393: </ul></div>
2394: </div>
2395: <div class="sect1" lang="en">
2396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2397: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installion process</h2></div></div></div>
2398: <p>A growing number of packages support installation into a
2399: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2400: to be built, before the actual filesystem is touched. DESTDIR
2401: support exists in two variations:</p>
2402: <div class="itemizedlist"><ul type="disc">
2403: <li><p>Basic DESTDIR support means that the package
2404: installation and packaging is still run as
2405: root.</p></li>
2406: <li><p>Full DESTDIR support can run the complete build,
2407: installation and packaging as normal user. Root privileges are
2408: only needed to add packages.</p></li>
2409: </ul></div>
2410: <p>To use the DESTDIR support, set either
2411: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2412: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2413: get the full support with fallback to basic
2414: 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
2415: newer). It might become the default DESTDIR support later.</p>
2416: <p>DESTDIR support changes the behaviour of various targets
2417: slightly. To install a package after building it, use
2418: <code class="literal">package-install</code>. <code class="literal">package</code> and
2419: <code class="literal">install</code> don't do that any
2420: longer. <code class="literal">package-install</code> can be used as
2421: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2422: will ask for the root password to install the package and fail,
2423: <code class="literal">package-install</code> will ask again.</p>
2424: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2425: clean</code></strong> needs to be run as root.</p>
2426: </div>
2427: <div class="sect1" lang="en">
2428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2429: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.1 dsieger 2430: <div class="sect2" lang="en">
2431: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2432: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2433: <p>By default, pkgsrc will use GCC to build packages. This may be
2434: overridden by setting the following variables in /etc/mk.conf:</p>
2435: <div class="variablelist"><dl>
2436: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2437: <dd>
2438: <p>This is a list of values specifying the chain of
2439: compilers to invoke when building packages. Valid values
2440: are:</p>
2441: <div class="itemizedlist"><ul type="disc">
2442: <li><p><code class="varname">distcc</code>:
2443: distributed C/C++ (chainable)</p></li>
2444: <li><p><code class="varname">ccache</code>:
2445: compiler cache (chainable)</p></li>
2446: <li><p><code class="varname">gcc</code>:
2447: GNU C/C++ Compiler</p></li>
2448: <li><p><code class="varname">mipspro</code>:
2449: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2450: <li><p><code class="varname">mipspro</code>:
2451: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2452: <li><p><code class="varname">sunpro</code>:
2453: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2454: </ul></div>
2455: <p>The default is
2456: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2457: <code class="varname">ccache</code> and/or
2458: <code class="varname">distcc</code> with an appropriate
2459: <code class="varname">PKGSRC_COMPILER</code> setting,
2460: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
2461: variable should always be terminated with a value for
2462: a real compiler. Note that only one real compiler
2463: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2464: is not allowed).</p>
2465: </dd>
2466: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2467: <dd><p>This specifies the minimum version of GCC to use
2468: when building packages. If the system GCC doesn't
2469: satisfy this requirement, then pkgsrc will build and
2470: install one of the GCC packages to use instead.</p></dd>
2471: </dl></div>
2472: </div>
2473: <div class="sect2" lang="en">
2474: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2475: <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 2476: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2477: please make sure to use the <code class="literal">+=</code> operator
2478: instead of the <code class="literal">=</code> operator:</p>
2479: <pre class="programlisting">
2480: CFLAGS+= -your -flags
2481: </pre>
2482: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2483: “<span class="quote">+</span>”) may lead to problems with packages that need
2484: to add their own flags. Also, you may want to take a look at
2485: 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
2486: you're interested in optimization for the current CPU.</p>
2487: </div>
2488: <div class="sect2" lang="en">
2489: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2490: <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 2491: <p>If you want to pass flags to the linker, both in the configure
2492: step and the build step, you can do this in two ways. Either set
2493: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2494: between the two is that <code class="varname">LIBS</code> will be appended to
2495: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2496: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2497: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2498: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2499: <code class="varname">CFLAGS</code>, if you do not wish to override these
2500: settings, use the <code class="literal">+=</code> operator:</p>
2501: <pre class="programlisting">
2502: LDFLAGS+= -your -linkerflags
2503: </pre>
2504: </div>
2505: </div>
2506: <div class="sect1" lang="en">
2507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2508: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2509: <p>XXX
2510: </p>
2511: <div class="itemizedlist"><ul type="disc">
2512: <li>
2513: <p><code class="varname">PKG_DEVELOPER</code>:
2514: Run some sanity checks that package developers want:
2515: </p>
2516: <div class="itemizedlist"><ul type="circle">
2517: <li><p>make sure patches apply with zero
2518: fuzz</p></li>
2519: <li><p>run check-shlibs to see that all
2520: binaries will find their shared libs.</p></li>
2521: </ul></div>
2522: <p>
2523: </p>
2524: </li>
2525: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2526: of debugging output which is displayed whilst making and
2527: installing the package. The default value for this is 0,
2528: which will not display the commands as they are executed
2529: (normal, default, quiet operation); the value 1 will display
2530: all shell commands before their invocation, and the value 2
2531: will display both the shell commands before their invocation,
2532: and their actual execution progress with <span><strong class="command">set
2533: -x</strong></span> will be displayed.</p></li>
2534: </ul></div>
2535: <p>
2536: </p>
2537: </div>
2538: <div class="sect1" lang="en">
2539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2540: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2541: <p>Some packages have build time options, usually to select
2542: between different dependencies, enable optional support for big
2543: dependencies or enable experimental features.</p>
2544: <p>To see which options, if any, a package supports, and which
2545: options are mutually exclusive, run <span><strong class="command">make
2546: show-options</strong></span>, for example:</p>
2547: <pre class="programlisting">
2548: The following options are supported by this package:
2549: ssl Enable SSL support.
2550: Exactly one of the following gecko options is required:
2551: firefox Use firefox as gecko rendering engine.
2552: mozilla Use mozilla as gecko rendering engine.
2553: At most one of the following database options may be selected:
2554: mysql Enable support for MySQL database.
2555: pgsql Enable support for PostgreSQL database.
2556:
2557: These options are enabled by default: firefox
2558: These options are currently enabled: mozilla ssl
2559: </pre>
2560: <p>The following variables can be defined in
1.4 rillig 2561: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2562: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2563: which can be used to select or disable options for all packages
2564: that support them, and
2565: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2566: which can be used to select or disable options specifically for
2567: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2568: these variables are selected, options preceded by “<span class="quote">-</span>”
2569: are disabled. A few examples:</p>
2570: <pre class="screen">
1.4 rillig 2571: <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 2572: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2573: PKG_OPTIONS.kdebase= debug -sasl
2574: PKG_OPTIONS.apache= suexec </pre>
2575: <p>The following settings are consulted in the order given, and
2576: the last setting that selects or disables an option is
2577: used:</p>
2578: <div class="orderedlist"><ol type="1">
2579: <li><p>the default options as suggested by the package
2580: maintainer</p></li>
2581: <li><p>the options implied by the settings of legacy
2582: variables (see below)</p></li>
2583: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2584: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2585: </ol></div>
2586: <p>For groups of mutually exclusive options, the last option
2587: selected is used, all others are automatically disabled. If an
2588: option of the group is explicitly disabled, the previously
2589: selected option, if any, is used. It is an error if no option
2590: from a required group of options is selected, and building the
2591: package will fail.</p>
2592: <p>Before the options framework was introduced, build options
2593: were selected by setting a variable (often named
2594: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.4 rillig 2595: <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2596: transition to the options framework for the user, these legacy
2597: variables are converted to the appropriate options setting
2598: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2599: automatically. A warning is issued to prompt the user to update
1.4 rillig 2600: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2601: directly. Support for the legacy variables will be removed
2602: eventually.</p>
2603: </div>
2604: </div>
2605: <div class="chapter" lang="en">
2606: <div class="titlepage"><div><div><h2 class="title">
2607: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2608: <div class="toc">
2609: <p><b>Table of Contents</b></p>
2610: <dl>
2611: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2612: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2613: </dl>
2614: </div>
2615: <div class="sect1" lang="en">
2616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2617: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2618: <p>Once you have built and installed a package, you can create
2619: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2620: 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
2621: the same package on a group of hosts and wasting CPU time. It also
2622: provides a simple means for others to install your package, should
2623: you distribute it.</p>
2624: <p>To create a binary package, change into the appropriate
2625: directory in pkgsrc, and run <span><strong class="command">make
2626: package</strong></span>:</p>
2627: <pre class="screen">
2628: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2629: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2630: </pre>
2631: <p>This will build and install your package (if not already done),
2632: and then build a binary package from what was installed. You can
2633: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2634: it. Binary packages are created by default in
2635: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2636: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
2637: 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 2638: <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 2639: such a binary package.</p>
2640: </div>
2641: <div class="sect1" lang="en">
2642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2643: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.6 rillig 2644: <p>See <a href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
2645: </div>
2646: </div>
2647: <div class="chapter" lang="en">
2648: <div class="titlepage"><div><div><h2 class="title">
2649: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2650: builds)</h2></div></div></div>
2651: <div class="toc">
2652: <p><b>Table of Contents</b></p>
2653: <dl>
2654: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2655: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2656: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2657: <dd><dl>
2658: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2659: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2660: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2661: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2662: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2663: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2664: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2665: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2666: </dl></dd>
2667: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
2668: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
2669: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2670: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2671: </dl>
2672: </div>
2673: <p>When you have multiple machines that should run the same packages,
2674: it is wasted time if they all build their packages themselves from
2675: source. There are two ways of getting a set of binary packages: The old
2676: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2677: system. This chapter describes how to set them up so that the packages
2678: are most likely to be usable later.</p>
2679: <div class="sect1" lang="en">
2680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2681: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2682: <p>Since a bulk build takes several days or even weeks to finish, you
2683: should think about the setup before you start everything. Pay attention
2684: to at least the following points:</p>
2685: <div class="itemizedlist"><ul type="disc">
2686: <li>
2687: <p>If you want to upload the binary packages to
2688: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2689: packages:</p>
2690: <div class="itemizedlist"><ul type="circle">
2691: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2692: by a NetBSD developer on a trusted machine (that is, where you and only
2693: you have root access).</p></li>
2694: <li><p>Packages on ftp.NetBSD.org should only be created from
2695: the stable branches (like 2007Q1), so that users browsing the available
2696: collections can see at a glance how old the packages
2697: are.</p></li>
2698: <li><p>The packages must be built as root, since some packages
2699: require set-uid binaries at runtime, and creating those packages as
2700: unprivileged user doesn't work well at the moment.</p></li>
2701: </ul></div>
2702: </li>
2703: <li><p>Make sure that the bulk build cannot break anything in
2704: your system. Most bulk builds run as root, so they should be run at least
2705: in a chroot environment or something even more restrictive, depending on
2706: what the operating system provides. There have been numerous cases where
2707: certain packages tried to install files outside the
2708: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2709: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2710: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2711: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2712: that you don't need any package during the build.</p></li>
2713: </ul></div>
2714: </div>
2715: <div class="sect1" lang="en">
2716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2717: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2718: <p>A complete bulk build requires lots of disk space. Some of the
2719: disk space can be read-only, some other must be writable. Some can be on
2720: remote filesystems (such as NFS) and some should be local. Some can be
2721: temporary filesystems, others must survive a sudden reboot.</p>
2722: <div class="itemizedlist"><ul type="disc">
2723: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2724: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2725: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2726: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2727: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2728: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2729: </ul></div>
1.1 dsieger 2730: </div>
2731: <div class="sect1" lang="en">
2732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2733: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
2734: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2735: <h3 class="title">Warning</h3>
2736: <p>The rest of this section is rather old. Don't rely on it
2737: too much.</p>
2738: </div>
1.1 dsieger 2739: <div class="sect2" lang="en">
2740: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2741: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.1 dsieger 2742: <div class="sect3" lang="en">
2743: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2744: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1 dsieger 2745: </h4></div></div></div>
2746: <p>The <code class="filename">build.conf</code> file is the main
2747: configuration file for bulk builds. You can configure how your
2748: copy of pkgsrc is kept up to date, how the distfiles are
2749: downloaded, how the packages are built and how the report is
2750: generated. You can find an annotated example file in
2751: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2752: it, copy <code class="filename">build.conf-example</code> to
2753: <code class="filename">build.conf</code> and edit it, following the
2754: comments in that file.</p>
2755: </div>
2756: <div class="sect3" lang="en">
2757: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2758: <a name="binary.mk.conf"></a>7.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4 rillig 2759: </h4></div></div></div>
2760: <p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1 dsieger 2761: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2762: details of the default settings. You will want to ensure that
2763: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2764: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.4 rillig 2765: completely bypasses the license check.</p>
1.1 dsieger 2766: <pre class="programlisting">
2767: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2768: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2769: BSDSRCDIR= /usr/src
2770: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2771: OBJHOSTNAME?= yes # use work.`hostname`
2772: FAILOVER_FETCH= yes # insist on the correct checksum
2773: PKG_DEVELOPER?= yes
2774: _ACCEPTABLE= yes
2775: </pre>
2776: <p>Some options that are especially useful for bulk builds
2777: can be found at the top lines of the file
2778: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2779: options of these are briefly described here.</p>
2780: <div class="itemizedlist"><ul type="disc">
2781: <li><p>If you are on a slow machine, you may want to
2782: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2783: “<span class="quote">no</span>”.</p></li>
2784: <li><p>If you are doing bulk builds from a read-only
2785: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2786: to the directory where all log files are created. Otherwise the
2787: log files are created in the pkgsrc directory.</p></li>
2788: <li><p>Another important variable is
2789: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2790: should be always available while building other
2791: packages.</p></li>
2792: </ul></div>
2793: <p>Some other options are scattered in the pkgsrc
2794: infrastructure:</p>
2795: <div class="itemizedlist"><ul type="disc">
2796: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2797: should be set to <code class="literal">yes</code>. The purpose of the bulk
2798: builds is creating binary packages, no matter if they are
2799: vulnerable or not. When uploading the packages to a public
2800: server, the vulnerable packages will be put into a directory of
2801: their own. Leaving this variable unset would prevent the bulk
2802: build system from even trying to build them, so possible
2803: building errors would not show up.</p></li>
2804: <li><p><code class="varname">CHECK_FILES</code>
2805: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
2806: “<span class="quote">yes</span>” to check that the installed set of files
2807: matches the <code class="filename">PLIST</code>.</p></li>
2808: <li><p><code class="varname">CHECK_INTERPRETER</code>
2809: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
2810: “<span class="quote">yes</span>” to check that the installed
2811: “<span class="quote">#!</span>”-scripts will find their
2812: interpreter.</p></li>
2813: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2814: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2815: package's self-test before installing it. Note that some
2816: packages make heavy use of “<span class="quote">good</span>” random
2817: numbers, so you need to assure that the machine on which you
2818: are doing the bulk builds is not completely idle. Otherwise
2819: some test programs will seem to hang, while they are just
2820: waiting for new random data to be
2821: available.</p></li>
2822: </ul></div>
2823: </div>
2824: <div class="sect3" lang="en">
2825: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2826: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1 dsieger 2827: </h4></div></div></div>
2828: <p>It is possible to configure the bulk build to perform
2829: certain site-specific tasks at the end of the pre-build
2830: stage. If the file
2831: <code class="filename">pre-build.local</code> exists in
2832: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2833: (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
2834: stage. An example use of
2835: <code class="filename">pre-build.local</code> is to have the line:</p>
2836: <pre class="screen">echo "I do not have enough disk space to build this pig." \
2837: > misc/openoffice/$BROKENF</pre>
2838: <p>to prevent the system from trying to build a particular package
2839: which requires nearly 3 GB of disk space.</p>
2840: </div>
2841: </div>
2842: <div class="sect2" lang="en">
2843: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2844: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1 dsieger 2845: <p>As <code class="filename">/usr/pkg</code> will be completely
2846: deleted at the start of bulk builds, make sure your login
2847: shell is placed somewhere else. Either drop it into
2848: <code class="filename">/usr/local/bin</code> (and adjust your login
2849: shell in the passwd file), or (re-)install it via
2850: <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
2851: you can login after a reboot (remember that your current
2852: process won't die if the package is removed, you just can't
2853: start any new instances of the shell any more). Also, if you
2854: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2855: version of ssh for some reason, be sure to install ssh before
2856: starting it from <code class="filename">rc.local</code>:</p>
2857: <pre class="programlisting">
2858: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2859: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2860: /usr/pkg/etc/rc.d/sshd
2861: fi
2862: </pre>
2863: <p>Not doing so will result in you being not able to log in
2864: via ssh after the bulk build is finished or if the machine
2865: gets rebooted or crashes. You have been warned! :)</p>
2866: </div>
2867: <div class="sect2" lang="en">
2868: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2869: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1 dsieger 2870: <p>Make sure you don't need any of the packages still
2871: installed.</p>
2872: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2873: <h3 class="title">Warning</h3>
2874: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2875: configuration files and some more files from
2876: <code class="filename">/var</code>, <code class="filename">/home</code> and
2877: possibly other locations will be removed! So don't run a bulk
2878: build with privileges that might harm your
2879: system.</em></span></p>
2880: </div>
2881: <p>Be sure to remove all other things that might
2882: interfere with builds, like some libs installed in
2883: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2884: <pre class="screen">
2885: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2886: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2887: </pre>
2888: <p>If for some reason your last build didn't complete (power
2889: failure, system panic, ...), you can continue it by
2890: running:</p>
2891: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2892: <p>At the end of the bulk build, you will get a summary via mail,
2893: and find build logs in the directory specified by
2894: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2895: file.</p>
2896: </div>
2897: <div class="sect2" lang="en">
2898: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2899: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1 dsieger 2900: <p>The bulk builds consist of three steps:</p>
2901: <div class="variablelist"><dl>
2902: <dt><span class="term">1. pre-build</span></dt>
2903: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2904: cleans out any broken distfiles, and removes all
2905: packages installed.</p></dd>
2906: <dt><span class="term">2. the bulk build</span></dt>
2907: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2908: an optimised order in which packages will be
2909: built. Packages that don't require other packages will
2910: be built first, and packages with many dependencies will
2911: be built later.</p></dd>
2912: <dt><span class="term">3. post-build</span></dt>
2913: <dd><p>Generates a report that's placed in the directory
2914: specified in the <code class="filename">build.conf</code> file
2915: named <code class="filename">broken.html</code>, a short version
2916: of that report will also be mailed to the build's
2917: admin.</p></dd>
2918: </dl></div>
2919: <p>During the build, a list of broken packages will be compiled
2920: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2921: <code class="filename">.../.broken.${MACHINE}</code> if
2922: <code class="varname">OBJMACHINE</code> is set), individual build logs
2923: of broken builds can be found in the package's
2924: directory. These files are used by the bulk-targets to mark
2925: broken builds to not waste time trying to rebuild them, and
2926: they can be used to debug these broken package builds
2927: later.</p>
2928: </div>
2929: <div class="sect2" lang="en">
2930: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2931: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1 dsieger 2932: <p>Currently, roughly the following requirements are valid for
2933: NetBSD 2.0/i386:</p>
2934: <div class="itemizedlist"><ul type="disc">
2935: <li><p>10 GB - distfiles (NFS ok)</p></li>
2936: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2937: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2938: </ul></div>
2939: <p>Note that all pkgs will be de-installed as soon as they are
2940: turned into a binary package, and that sources are removed,
2941: so there is no excessively huge demand to disk
2942: space. Afterwards, if the package is needed again, it will
2943: 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
2944: there are no cycles wasted by recompiling.</p>
2945: </div>
2946: <div class="sect2" lang="en">
2947: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2948: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1 dsieger 2949: <p>If you don't want all the packages nuked from a machine
2950: (rendering it useless for anything but pkg compiling), there
2951: is the possibility of doing the package bulk build inside a
2952: chroot environment.</p>
2953: <p>The first step is to set up a chroot sandbox,
2954: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2955: using null mounts, or manually.</p>
2956: <p>There is a shell script called
2957: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2958: up the sandbox environment using null mounts. It will also
2959: create a script called <code class="filename">sandbox</code> in the
2960: root of the sandbox environment, which will allow the null
2961: mounts to be activated using the <span><strong class="command">sandbox
2962: mount</strong></span> command and deactivated using the
2963: <span><strong class="command">sandbox umount</strong></span> command.</p>
2964: <p>To set up a sandbox environment by hand, after extracting all
2965: the sets from a NetBSD installation or doing a <span><strong class="command">make
2966: distribution DESTDIR=/usr/sandbox</strong></span> in
2967: <code class="filename">/usr/src/etc</code>, be sure the following items
2968: are present and properly configured:</p>
2969: <div class="procedure"><ol type="1">
2970: <li>
2971: <p>Kernel</p>
2972: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2973: </li>
2974: <li>
2975: <p><code class="filename">/dev/*</code></p>
2976: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2977: </li>
2978: <li>
2979: <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>
2980: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2981: </li>
2982: <li>
2983: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2984: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2985: </li>
2986: <li>
2987: <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>
2988: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2989: </li>
2990: <li>
2991: <p><code class="filename">/usr/src</code> (system sources,
1.6 rillig 2992: 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 2993: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2994: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2995: </li>
2996: <li>
2997: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2998: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2999: </li>
3000: <li>
3001: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
3002: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
3003: </li>
3004: <li>
3005: <p>Checkout pkgsrc via cvs into
3006: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
3007: <pre class="screen">
3008: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
3009: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
3010: </pre>
3011: <p>Do not mount/link this to the copy of your pkgsrc tree
3012: you do development in, as this will likely cause problems!</p>
3013: </li>
3014: <li><p>Make
3015: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
3016: <code class="filename">.../distfiles</code> point somewhere
3017: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.6 rillig 3018: <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 3019: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
3020: </ol></div>
3021: <p>When the chroot sandbox is set up, you can start
3022: the build with the following steps:</p>
3023: <pre class="screen">
3024: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3025: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
3026: </pre>
3027: <p>This will just jump inside the sandbox and start building. At
3028: the end of the build, mail will be sent with the results of
3029: the build. Created binary pkgs will be in
3030: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
3031: (wherever that points/mounts to/from).</p>
3032: </div>
3033: <div class="sect2" lang="en">
3034: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3035: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1 dsieger 3036: <p>In addition to building a complete set of all packages in
3037: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
3038: may be used to build a subset of the packages contained in
3039: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.4 rillig 3040: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.1 dsieger 3041: <div class="itemizedlist"><ul type="disc">
3042: <li><p>SITE_SPECIFIC_PKGS</p></li>
3043: <li><p>HOST_SPECIFIC_PKGS</p></li>
3044: <li><p>GROUP_SPECIFIC_PKGS</p></li>
3045: <li><p>USER_SPECIFIC_PKGS</p></li>
3046: </ul></div>
3047: <p>will define the set of packages which should be built.
3048: The bulk build code will also include any packages which are
3049: needed as dependencies for the explicitly listed packages.</p>
3050: <p>One use of this is to do a bulk build with
3051: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
3052: periodically to have a complete set of the binary packages
3053: needed for your site available without the overhead of
3054: building extra packages that are not needed.</p>
3055: </div>
3056: <div class="sect2" lang="en">
3057: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3058: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1 dsieger 3059: <p>This section describes how pkgsrc developers can upload binary
3060: pkgs built by bulk builds to ftp.NetBSD.org.</p>
3061: <p>If you would like to automatically create checksum files for the
3062: binary packages you intend to upload, remember to set
3063: <code class="varname">MKSUMS=yes</code> in your
3064: <code class="filename">mk/bulk/build.conf</code>.</p>
3065: <p>If you would like to PGP sign the checksum files (highly
3066: recommended!), remember to set
3067: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
3068: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
3069: your GPG password to sign the files before uploading everything.</p>
3070: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
3071: set properly in your <code class="filename">mk/bulk/build.conf</code>
3072: file, i.e. adjust it to something like one of the following:</p>
3073: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
3074: <p>Please use appropriate values for "packages-200xQy",
3075: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
3076: is different from your local login, write your login directly
3077: into the variable, e.g. my local account is "feyrer", but for my
3078: login "hubertf", I use:</p>
3079: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
3080: <p>A separate <code class="filename">upload</code> directory is used
3081: here to allow "closing" the directory during upload. To do
3082: so, run the following command on ftp.NetBSD.org next:</p>
3083: <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>
3084: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3085: only appropriate for packages for the NetBSD operating
3086: system. Binary packages for other operating systems should go
3087: into <code class="filename">/pub/pkgsrc</code>.</p>
3088: <p>Before uploading the binary pkgs, ssh authentication needs
3089: to be set up. This example shows how to set up temporary keys
3090: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3091: (assuming that no keys should be present there usually):</p>
3092: <pre class="screen">
3093: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
3094: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3095: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
3096: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3097: </pre>
3098: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3099: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3100: file on ftp.NetBSD.org. You can remove the key after the
3101: upload is done!</p>
3102: <p>Next, test if your ssh connection really works:</p>
3103: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
3104: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3105: <p>Now after all this works, you can exit the sandbox and start
3106: the upload:</p>
3107: <pre class="screen">
3108: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
3109: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3110: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3111: </pre>
3112: <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
3113: <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
3114: upload. The upload script will take care of not uploading
3115: restricted packages and putting vulnerable packages into the
3116: <code class="filename">vulnerable</code> subdirectory.</p>
3117: <p>After the upload has ended, first thing is to revoke ssh access:</p>
3118: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
3119: Gdd:x! </pre>
3120: <p>Use whatever is needed to remove the key you've entered
3121: before! Last, move the uploaded packages out of the
3122: <code class="filename">upload</code> directory to have them accessible
3123: to everyone:</p>
3124: <pre class="screen">
3125: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
3126: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3127: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
3128: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3129: </pre>
3130: </div>
3131: </div>
3132: <div class="sect1" lang="en">
3133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3134: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
3135: <div class="sect2" lang="en">
3136: <div class="titlepage"><div><div><h3 class="title">
3137: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
3138: <p>TODO; see <a href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
3139: more information.</p>
3140: </div>
3141: </div>
3142: <div class="sect1" lang="en">
3143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3144: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 3145: <p>After your pkgsrc bulk-build has completed, you may wish to
3146: create a CD-ROM set of the resulting binary packages to assist
3147: in installing packages on other machines. The
3148: <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
3149: a simple tool for creating the ISO 9660 images.
3150: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3151: way that keeps all the dependencies for a given package on the same
3152: CD as that package.</p>
3153: <div class="sect2" lang="en">
3154: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3155: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 3156: <p>Complete documentation for cdpack is found in the cdpack(1)
3157: man page. The following short example assumes that the binary
3158: packages are left in
3159: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3160: sufficient disk space exists in <code class="filename">/u2</code> to
3161: hold the ISO 9660 images.</p>
3162: <pre class="screen">
3163: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
3164: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
3165: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3166: </pre>
3167: <p>If you wish to include a common set of files
3168: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3169: etc.) on each CD in the collection, then you need to create a
3170: directory which contains these files. e.g.</p>
3171: <pre class="screen">
3172: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
3173: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3174: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3175: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3176: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3177: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
3178: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3179: </pre>
3180: <p>Now create the images:</p>
3181: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3182: <p>Each image will contain <code class="filename">README</code>,
3183: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3184: in their root directories.</p>
3185: </div>
3186: </div>
3187: </div>
3188: <div class="chapter" lang="en">
3189: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3190: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 3191: <div class="toc">
3192: <p><b>Table of Contents</b></p>
3193: <dl>
1.6 rillig 3194: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3195: <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 3196: </dl>
3197: </div>
3198: <p>The files that are installed by pkgsrc are organized in a way that
3199: is similar to what you find in the <code class="filename">/usr</code> directory
3200: of the base system. But some details are different. This is because
3201: pkgsrc initially came from FreeBSD and had adopted its file system
3202: hierarchy. Later it was largely influenced by NetBSD. But no matter
3203: which operating system you are using pkgsrc with, you can expect the
3204: same layout for pkgsrc.</p>
3205: <p>There are mainly four root directories for pkgsrc, which are all
3206: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3207: When pkgsrc has been installed as root, the default locations
3208: are:</p>
3209: <pre class="programlisting">
3210: LOCALBASE= /usr/pkg
3211: PKG_SYSCONFBASE= /usr/pkg/etc
3212: VARBASE= /var
3213: PKG_DBDIR= /var/db/pkg
3214: </pre>
3215: <p>In unprivileged mode (when pkgsrc has been installed as any other
3216: user), the default locations are:</p>
3217: <pre class="programlisting">
3218: LOCALBASE= ${HOME}/pkg
3219: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3220: VARBASE= ${HOME}/pkg/var
3221: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
3222: </pre>
3223: <p>What these four directories are for, and what they look like is
3224: explained below.</p>
3225: <div class="itemizedlist"><ul type="disc">
3226: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3227: <code class="filename">/usr</code> directory in the base system. It is the
3228: “<span class="quote">main</span>” directory where the files are installed and contains
3229: the well-known subdirectories like <code class="filename">bin</code>,
3230: <code class="filename">include</code>, <code class="filename">lib</code>,
3231: <code class="filename">share</code> and
3232: <code class="filename">sbin</code>.</p></li>
3233: <li><p><code class="varname">VARBASE</code> corresponds to
3234: <code class="filename">/var</code> in the base system. Some programs (especially
3235: games, network daemons) need write access to it during normal
3236: operation.</p></li>
3237: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3238: <code class="filename">/etc</code> in the base system. It contains configuration
1.4 rillig 3239: files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 3240: itself.</p></li>
3241: </ul></div>
3242: <div class="sect1" lang="en">
3243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3244: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 3245: </h2></div></div></div>
3246: <p>The following directories exist in a typical pkgsrc installation
3247: in <code class="filename">${LOCALBASE}</code>.</p>
3248: <div class="variablelist"><dl>
3249: <dt><span class="term"><code class="filename">bin</code></span></dt>
3250: <dd><p>Contains executable programs that are intended to be
3251: directly used by the end user.</p></dd>
3252: <dt><span class="term"><code class="filename">emul</code></span></dt>
3253: <dd><p>Contains files for the emulation layers of various other
3254: operating systems, especially for
3255: NetBSD.</p></dd>
3256: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3257: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3258: <dd><p>Contains
3259: the configuration files.</p></dd>
3260: <dt><span class="term"><code class="filename">include</code></span></dt>
3261: <dd><p>Contains headers for the C and C++ programming
3262: languages.</p></dd>
3263: <dt><span class="term"><code class="filename">info</code></span></dt>
3264: <dd><p>Contains GNU info files of various
3265: packages.</p></dd>
3266: <dt><span class="term"><code class="filename">lib</code></span></dt>
3267: <dd><p>Contains shared and static
3268: libraries.</p></dd>
3269: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3270: <dd><p>Contains data files that don't change after
3271: installation. Other data files belong into
3272: <code class="filename">${VARBASE}</code>.</p></dd>
3273: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3274: <dd><p>Contains programs that are not intended to be used by
3275: end users, such as helper programs or network
3276: daemons.</p></dd>
3277: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3278: <dd><p>Contains programs that are intended to be executed as
3279: CGI scripts by a web server.</p></dd>
3280: <dt><span class="term"><code class="filename">man</code> (the usual value of
3281: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3282: <dd><p>Contains brief
3283: documentation in form of manual pages.</p></dd>
3284: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3285: <dd><p>Contains programs that are intended to be used only by
3286: the super-user.</p></dd>
3287: <dt><span class="term"><code class="filename">share</code></span></dt>
3288: <dd><p>Contains platform-independent data files that don't
3289: change after installation.</p></dd>
3290: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3291: <dd><p>Contains documentation files provided by the
3292: packages.</p></dd>
3293: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3294: <dd><p>Contains example files provided by the packages. Among
3295: others, the original configuration files are saved here and copied to
3296: <code class="filename">${PKG_SYSCONFDIR}</code> during
3297: installation.</p></dd>
3298: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3299: <dd><p>Contains the original files for rc.d
3300: scripts.</p></dd>
3301: <dt><span class="term"><code class="filename">var</code> (the usual location of
3302: <code class="filename">${VARBASE}</code>)</span></dt>
3303: <dd><p>Contains files
3304: that may be modified after
3305: installation.</p></dd>
3306: </dl></div>
3307: </div>
3308: <div class="sect1" lang="en">
3309: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3310: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 3311: </h2></div></div></div>
3312: <div class="variablelist"><dl>
3313: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3314: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3315: <dd><p>Contains
3316: information about the currently installed
3317: packages.</p></dd>
3318: <dt><span class="term"><code class="filename">games</code></span></dt>
3319: <dd><p>Contains highscore
3320: files.</p></dd>
3321: <dt><span class="term"><code class="filename">log</code></span></dt>
3322: <dd><p>Contains log files.</p></dd>
3323: <dt><span class="term"><code class="filename">run</code></span></dt>
3324: <dd><p>Contains informational files about daemons that are
3325: currently running.</p></dd>
3326: </dl></div>
3327: </div>
3328: </div>
3329: <div class="chapter" lang="en">
3330: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3331: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 3332: <div class="toc">
3333: <p><b>Table of Contents</b></p>
3334: <dl>
1.6 rillig 3335: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3336: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3337: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3338: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3339: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3340: <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>
3341: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
3342: <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>
3343: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
3344: <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 3345: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.6 rillig 3346: <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>
3347: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3348: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3349: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
3350: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3351: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
3352: <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 3353: </dl>
3354: </div>
3355: <p>This section contains hints, tips & tricks on special things in
3356: pkgsrc that we didn't find a better place for in the previous chapters, and
3357: it contains items for both pkgsrc users and developers.</p>
3358: <div class="sect1" lang="en">
3359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3360: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 3361: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3362: <div class="itemizedlist"><ul type="disc">
1.4 rillig 3363: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 3364: This is a general purpose list for most issues regarding
3365: pkgsrc, regardless of platform, e.g. soliciting user help
3366: for pkgsrc configuration, unexpected build failures, using
3367: particular packages, upgrading pkgsrc installations,
3368: questions regarding the pkgsrc release branches, etc. General announcements or
3369: proposals for changes that impact the pkgsrc user community,
3370: e.g. major infrastructure changes, new features, package
3371: removals, etc., may also be posted.</p></li>
1.4 rillig 3372: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 3373: A list where the results of pkgsrc bulk builds are sent and
3374: discussed.</p></li>
1.4 rillig 3375: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 3376: This list is for those who are interested in getting a
3377: commit message for every change committed to pkgsrc. It is
3378: also available in digest form, meaning one daily message
3379: containing all commit messages for changes to the package
3380: source tree in that 24 hour period.</p></li>
3381: </ul></div>
3382: <p>To subscribe, do:</p>
3383: <pre class="programlisting">
3384: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3385: </pre>
3386: <p>Archives for all these mailing lists are available from
3387: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3388: </div>
3389: <div class="sect1" lang="en">
3390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3391: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 3392: <p>Pkgviews is tightly integrated with buildlink. You can find a
3393: pkgviews User's guide in
3394: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3395: </div>
3396: <div class="sect1" lang="en">
3397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3398: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 3399: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3400: a number of useful utilities for both users and developers of pkgsrc. This
3401: section attempts only to make the reader aware of the utilities and when
3402: they might be useful, and not to duplicate the documentation that comes
3403: with each package.</p>
3404: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
3405: <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>:
3406: Symlinks for use by buildlink.</p></li></ul></div>
3407: <p>OS tool augmentation (automatically installed when needed):</p>
3408: <div class="itemizedlist"><ul type="disc">
3409: <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>:
3410: Calculates various kinds of checksums (including SHA1).</p></li>
3411: <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>:
3412: Compatibility library for pkgsrc tools.</p></li>
3413: <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
3414: non-BSD systems due to lack of native mtree.</p></li>
3415: <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>:
3416: Up-to-date replacement for
3417: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3418: systems where pkg_install is not present.</p></li>
3419: </ul></div>
3420: <p>Utilities used by pkgsrc (not automatically installed):</p>
3421: <div class="itemizedlist"><ul type="disc">
3422: <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>:
3423: Create a binary package from an
3424: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3425: save the old package.</p></li>
3426: <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>:
3427: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3428: from multiple locations. It currently supports the following
3429: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
3430: <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
3431: packages someplace else (enabled by default).</p></li>
3432: <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
3433: best compiler flags to optimise code for your current CPU and
3434: compiler.</p></li>
3435: </ul></div>
3436: <p>Utilities for keeping track of installed packages, being up to date,
3437: etc:</p>
3438: <div class="itemizedlist"><ul type="disc">
3439: <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
3440: packages whose installed versions do not match the latest pkgsrc
3441: entries.</p></li>
3442: <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
3443: dependency graphs of packages, to aid in choosing a strategy for
3444: updating.</p></li>
3445: <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
3446: 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>
3447: <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
3448: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3449: does various checks on the complete pkgsrc system.</p></li>
3450: <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
3451: packages you have installed.</p></li>
3452: </ul></div>
3453: <p>Utilities for people maintaining or creating individual packages:</p>
3454: <div class="itemizedlist"><ul type="disc">
3455: <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
3456: making and maintaining patches for a package (includes pkgdiff,
3457: pkgvi, mkpatches, etc.).</p></li>
3458: <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>,
3459: <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
3460: converting to pkgsrc.</p></li>
3461: <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
3462: pkgsrc to a Solaris package.</p></li>
3463: </ul></div>
3464: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3465: utilities)</p>
3466: <div class="itemizedlist"><ul type="disc">
3467: <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
3468: packages in a chrooted area.</p></li>
3469: <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
3470: kernel version for chrooted cross builds.</p></li>
3471: </ul></div>
3472: </div>
3473: <div class="sect1" lang="en">
3474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3475: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3476: <p>If you want to use pkgsrc as non-root user, you can set some
3477: variables to make pkgsrc work under these conditions. At the very least,
3478: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3479: will turn on unprivileged mode and set multiple related variables to allow
3480: installation of packages as non-root.</p>
3481: <p>In case the defaults are not enough, you may want to tune some other
3482: variables used. For example, if the automatic user/group detection leads
3483: to incorrect values (or not the ones you would like to use), you can change
3484: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3485: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3486: <p>As regards bootstrapping, please note that the
3487: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3488: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
3489: use multiple default directories under <code class="filename">~/pkg</code> as the
3490: installation targets. These directories can be overridden by the
3491: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3492: that allow finer tuning of the tree layout.</p>
3493: </div>
3494: <div class="sect1" lang="en">
3495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3496: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3497: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3498: enable this feature by adding the option
3499: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.4 rillig 3500: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3501: distfile is found, pkgsrc will try to resume it.</p>
3502: <p>You can also
3503: 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
3504: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3505: <code class="varname">FETCH_RESUME_ARGS</code> and
3506: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3507: values.</p>
3508: <p>For example, if you want to use
3509: <code class="filename">wget</code> to resume downloads, you'll have to use something
3510: like:</p>
3511: <pre class="programlisting">
3512: FETCH_CMD= wget
3513: FETCH_BEFORE_ARGS= --passive-ftp
3514: FETCH_RESUME_ARGS= -c
3515: FETCH_OUTPUT_ARGS= -O
3516: </pre>
3517: </div>
3518: <div class="sect1" lang="en">
3519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3520: <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 3521: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3522: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3523: you will have to add the following line into
1.4 rillig 3524: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3525: <pre class="programlisting">
1.4 rillig 3526: X11_TYPE=modular
1.1 dsieger 3527: </pre>
3528: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3529: <h3 class="title">Note</h3>
1.4 rillig 3530: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3531: </p>
1.1 dsieger 3532: </div>
3533: </div>
3534: <div class="sect1" lang="en">
3535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3536: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3537: <p>If you are sitting behind a firewall which does not allow direct
3538: connections to Internet hosts (i.e. non-NAT), you may specify the
3539: relevant proxy hosts. This is done using an environment variable in the
3540: form of a URL, e.g. in Amdahl, the machine
3541: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3542: port 80 as the proxy port number. So the proxy environment variables
3543: are:</p>
3544: <pre class="programlisting">
3545: ftp_proxy=ftp://orpheus.amdahl.com:80/
3546: http_proxy=http://orpheus.amdahl.com:80/
3547: </pre>
3548: </div>
3549: <div class="sect1" lang="en">
3550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3551: <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 3552: <p>This depends on which utility is used to retrieve distfiles. From
3553: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3554: the first available command from the following list:</p>
3555: <div class="itemizedlist"><ul type="disc">
3556: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3557: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
3558: </ul></div>
3559: <p>On a default NetBSD installation, this will be
3560: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3561: connections first, and falls back to active connections if the server
3562: refuses to do passive. For the other tools, add the following to your
1.4 rillig 3563: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3564: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3565: <p>Having that option present will prevent
3566: <code class="filename">/usr/bin/ftp</code> from falling back to active
3567: transfers.</p>
3568: </div>
3569: <div class="sect1" lang="en">
3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3571: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3572: <p>You would like to download all the distfiles in a single batch
3573: from work or university, where you can't run a <span><strong class="command">make
3574: 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>,
3575: but downloading the entire directory may not be appropriate.</p>
3576: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
3577: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3578: resulting list to your machine at work/school and use it there. If you
3579: 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
3580: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3581: URL:</p>
3582: <p>At home:</p>
3583: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3584: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3585: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3586: <p>At work:</p>
3587: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3588: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3589: home.</p>
3590: <p>If you have a machine running NetBSD, and you want to get
3591: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3592: machine architecture), you can do so by using the above-mentioned
3593: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3594: directly by running:</p>
3595: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3596: <p>If you even decide to ignore
3597: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3598: by running:</p>
3599: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3600: </div>
3601: <div class="sect1" lang="en">
3602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3603: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.1 dsieger 3604: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
3605: <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>
3606: package, you get the error from make that it doesn't know how to make
3607: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
3608: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3609: the NetBSD base distribution on your machine. It is recommended to do
3610: that to format man pages.</p>
3611: <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
3612: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.4 rillig 3613: environment or in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3614: </div>
3615: <div class="sect1" lang="en">
3616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3617: <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 3618: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3619: when you installed your NetBSD machine. Please get and install it, by
3620: extracting it in <code class="filename">/</code>:</p>
3621: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3622: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3623: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
3624: the one that corresponds to your release (determine via <span><strong class="command">uname
3625: -r</strong></span>).</p>
3626: </div>
3627: <div class="sect1" lang="en">
3628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3629: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3630: <p>When installing packages as non-root user and using the just-in-time
3631: <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
3632: password for each required package installed. To avoid this, the sudo
3633: package can be used, which does password caching over a limited time. To
3634: use it, install sudo (either as binary package or from
3635: <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 3636: following into your <a href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3637: <span class="emphasis"><em>after</em></span> the definition of the
3638: <code class="varname">LOCALBASE</code> variable:</p>
3639: <pre class="programlisting">
3640: .if exists(${LOCALBASE}/bin/sudo)
3641: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3642: .endif
3643: </pre>
3644: </div>
3645: <div class="sect1" lang="en">
3646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3647: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3648: <p>As the system administrator, you can choose where configuration files
3649: are installed. The default settings make all these files go into
3650: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3651: be suboptimal depending on your expectations (e.g., a read-only,
3652: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3653: configuration of the provided packages).</p>
3654: <p>In order to change the defaults, you can modify the
3655: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.4 rillig 3656: <a href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3657: directory; some common examples include <code class="filename">/etc</code> or
3658: <code class="filename">/etc/pkg</code>.</p>
3659: <p>Furthermore, you can change this value on a per-package basis by
3660: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3661: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3662: package you would like to modify, that is, the contents of
3663: <code class="varname">PKGBASE</code>.</p>
3664: <p>Note that after changing these settings, you must rebuild and
3665: reinstall any affected packages.</p>
3666: </div>
3667: <div class="sect1" lang="en">
3668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3669: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3670: <p>Please be aware that there can often be bugs in third-party software,
3671: and some of these bugs can leave a machine vulnerable to exploitation by
3672: attackers. In an effort to lessen the exposure, the NetBSD packages team
3673: maintains a database of known-exploits to packages which have at one time
3674: been included in pkgsrc. The database can be downloaded automatically, and
3675: a security audit of all packages installed on a system can take place. To
3676: 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
3677: components:</p>
3678: <div class="orderedlist"><ol type="1">
3679: <li>
3680: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3681: download a list of the security vulnerabilities information. This list
3682: is kept up to date by the NetBSD security officer and the NetBSD
3683: packages team, and is distributed from the NetBSD ftp server:</p>
3684: <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>
3685: </li>
3686: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3687: current machine, checking each vulnerability which is known. If a
3688: vulnerable package is installed, it will be shown by output to stdout,
3689: including a description of the type of vulnerability, and a URL
3690: containing more information.</p></li>
3691: </ol></div>
3692: <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>
3693: package is strongly recommended! After
3694: “<span class="quote">audit-packages</span>” is installed, please read
3695: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3696: audit-packages</code></strong>.</p>
3697: <p>If this package is installed, pkgsrc builds will use it to
3698: 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
3699: check.</p>
3700: </div>
3701: <div class="sect1" lang="en">
3702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3703: <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 3704: <p>When you add your own preferences to the
3705: <code class="varname">CFLAGS</code> variable in your
1.4 rillig 3706: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3707: environment variables to the <code class="filename">./configure</code>
3708: 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
3709: <code class="varname">CFLAGS</code> from the environment variable by
3710: overriding them in the <code class="filename">Makefile</code>s of their
3711: package.</p>
3712: <p>Currently there is no solution to this problem. If you
3713: really need the package to use your <code class="varname">CFLAGS</code>
3714: you should run <span><strong class="command">make patch</strong></span> in the package
3715: directory and then inspect any <code class="filename">Makefile</code> and
3716: <code class="filename">Makefile.in</code> for whether they define
3717: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3718: these lines. But be aware that some “<span class="quote">smart</span>”
3719: programmers write so bad code that it only works for the
3720: specific combination of <code class="varname">CFLAGS</code> they have
3721: chosen.</p>
3722: </div>
3723: <div class="sect1" lang="en">
3724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3725: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.1 dsieger 3726: <div class="procedure"><ol type="1">
3727: <li><p>Make sure that your copy of pkgsrc is consistent. A
3728: case that occurs often is that people only update pkgsrc in
3729: parts, because of performance reasons. Since pkgsrc is one large
3730: system, not a collection of many small systems, there are
3731: sometimes changes that only work when the whole pkgsrc tree is
3732: updated.</p></li>
3733: <li><p>Make sure that you don't have any CVS conflicts.
3734: Search for “<span class="quote"><<<<<<</span>” or
3735: “<span class="quote">>>>>>></span>” in all your pkgsrc
3736: files.</p></li>
3737: <li><p>Make sure that you don't have old copies of the packages
3738: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3739: verify this.</p></li>
3740: <li><p>If the problem still exists, write a mail to the
3741: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3742: </ol></div>
3743: </div>
3744: <div class="sect1" lang="en">
3745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3746: <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 3747: <p>You have modified a file from pkgsrc, and someone else has
3748: modified that same file afterwards in the CVS repository. Both changes
3749: are in the same region of the file, so when you updated pkgsrc, the
3750: <code class="literal">cvs</code> command marked the conflicting changes in the
3751: file. Because of these markers, the file is no longer a valid
3752: <code class="filename">Makefile</code>.</p>
3753: <p>Have a look at that file, and if you don't need your local changes
3754: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3755: -dP</strong></span> in that directory to download the current version.</p>
3756: </div>
3757: </div>
3758: </div>
3759: <div class="part" lang="en">
3760: <div class="titlepage"><div><div><h1 class="title">
3761: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
3762: <div class="partintro" lang="en">
3763: <div></div>
3764: <p>This part of the book deals with creating and
3765: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3766: guide on creating a new package. The remaining chapters are more
3767: like a reference manual for pkgsrc.</p>
3768: <div class="toc">
3769: <p><b>Table of Contents</b></p>
3770: <dl>
1.6 rillig 3771: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3772: <dd><dl>
1.6 rillig 3773: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3774: <dd><dl>
1.6 rillig 3775: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3776: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 3777: </dl></dd>
1.6 rillig 3778: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3779: <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>
3780: </dl></dd>
3781: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3782: <dd><dl>
3783: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3784: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
3785: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3786: <dd><dl>
3787: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3788: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3789: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3790: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3791: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3792: </dl></dd>
3793: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3794: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3795: <dd><dl>
3796: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3797: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3798: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3799: </dl></dd>
3800: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3801: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
3802: </dl></dd>
3803: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3804: <dd><dl>
3805: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
3806: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
3807: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3808: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3809: <dd><dl>
3810: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3811: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3812: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3813: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3814: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3815: </dl></dd>
3816: </dl></dd>
3817: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3818: <dd><dl>
3819: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
3820: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3821: <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>
3822: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3823: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
3824: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3825: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3826: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3827: </dl></dd>
3828: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3829: <dd><dl>
3830: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
3831: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3832: <dd><dl>
3833: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3834: <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>
3835: </dl></dd>
3836: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3837: <dd><dl>
3838: <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>
3839: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3840: </dl></dd>
3841: </dl></dd>
3842: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3843: <dd><dl>
3844: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3845: <dd><dl>
3846: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3847: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3848: </dl></dd>
3849: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3850: <dd><dl>
3851: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3852: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3853: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3854: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3855: </dl></dd>
3856: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3857: <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>
3858: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3859: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3860: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3861: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3862: <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>
3863: </dl></dd>
3864: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3865: <dd><dl>
3866: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3867: <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>
3868: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 ! rillig 3869: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3870: </dl></dd>
3871: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3872: <dd><dl>
3873: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3874: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3875: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3876: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
3877: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3878: <dd><dl>
3879: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3880: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3881: </dl></dd>
3882: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3883: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3884: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3885: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3886: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3887: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3888: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3889: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3890: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3891: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3892: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3893: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3894: </dl></dd>
3895: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3896: <dd><dl>
3897: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3898: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3899: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3900: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3901: </dl></dd>
3902: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3903: <dd><dl>
3904: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3905: <dd><dl>
3906: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
3907: <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>
3908: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3909: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3910: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3911: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3912: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3913: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3914: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3915: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3916: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3917: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3918: </dl></dd>
3919: <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>
3920: <dd><dl>
3921: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3922: <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>
3923: </dl></dd>
3924: <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>
3925: <dd><dl>
3926: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3927: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3928: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3929: </dl></dd>
3930: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3931: <dd><dl>
3932: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3933: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3934: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3935: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3936: </dl></dd>
3937: <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>
3938: <dd><dl>
3939: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3940: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
3941: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3942: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3943: </dl></dd>
3944: <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>
3945: <dd><dl>
3946: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3947: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3948: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3949: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3950: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3951: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3952: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3953: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 ! rillig 3954: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 3955: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
3956: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3957: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3958: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3959: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3960: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3961: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3962: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3963: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3964: emulation</a></span></dt>
1.6 rillig 3965: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3966: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3967: </dl></dd>
1.6 rillig 3968: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3969: </dl></dd>
1.6 rillig 3970: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3971: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3972: <dd><dl>
1.6 rillig 3973: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3974: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3975: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3976: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3977: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3978: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
3979: </dl></dd>
3980: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3981: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3982: <dd><dl>
3983: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3984: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3985: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3986: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3987: </dl></dd>
3988: </dl>
3989: </div>
3990: </div>
3991: <div class="chapter" lang="en">
3992: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3993: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3994: <div class="toc">
3995: <p><b>Table of Contents</b></p>
3996: <dl>
1.6 rillig 3997: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3998: <dd><dl>
1.6 rillig 3999: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
4000: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.1 dsieger 4001: </dl></dd>
1.6 rillig 4002: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
4003: <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 4004: </dl>
4005: </div>
4006: <p>When you find a package that is not yet in pkgsrc, you
4007: most likely have a URL from where you can download the source
4008: code. Starting with this URL, creating a package involves only a
4009: few steps.</p>
4010: <div class="procedure"><ol type="1">
4011: <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>
4012: <li><p>Then, choose one of the top-level directories as the
4013: category in which you want to place your package. You can also create a
4014: directory of your own (maybe called <code class="filename">local</code>). In that
4015: category directory, create another directory for your package and change
4016: into it.</p></li>
4017: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
4018: you for a URL. Enter the URL of the distribution file (in most cases a
4019: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
4020: of your package are created automatically. The distribution file is
4021: extracted automatically to fill in some details in the
4022: <code class="filename">Makefile</code> that would otherwise have to be done
4023: manually.</p></li>
4024: <li>
4025: <p>Examine the extracted files to determine the dependencies of
4026: your package. Ideally, this is mentioned in some
4027: <code class="filename">README</code> file, but things may differ. For each of
4028: these dependencies, look where it exists in pkgsrc, and if there is a
4029: file called <code class="filename">buildlink3.mk</code> in that directory, add a
4030: line to your package <code class="filename">Makefile</code> which includes that
4031: file just before the last line. If the
4032: <code class="filename">buildlink3.mk</code> file does not exist, add a
4033: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
4034: version of the dependency and where it can be found in pkgsrc. This line
4035: should be placed in the third paragraph. If the dependency is only
4036: needed for building the package, but not when using it, use
4037: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
4038: Your package may then look like this:</p>
4039: <pre class="programlisting">
4040: [...]
4041:
4042: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
4043: DEPENDS+= screen-[0-9]*:../../misc/screen
4044: DEPENDS+= screen>=4.0:../../misc/screen
4045:
4046: [...]
4047:
4048: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
4049: .include "../../devel/glib2/buildlink3.mk"
4050: .include "../../mk/bsd.pkg.mk"
4051: </pre>
4052: </li>
4053: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
4054: to be done to make your package a “<span class="quote">good</span>” one. If you don't
4055: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
4056: --explain</strong></span> or <span><strong class="command">pkglint
4057: -e</strong></span>, which outputs additional
4058: explanations.</p></li>
4059: <li><p>In many cases the package is not yet ready to build. You can
1.6 rillig 4060: 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 4061: over there, you can hopefully continue here.</p></li>
4062: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
4063: directory from the extracted files. Besides these files, a lot of cache
4064: files and other system information has been saved in the working
4065: directory, which may become wrong after you edited the
4066: <code class="filename">Makefile</code>.</p></li>
4067: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
1.6 rillig 4068: 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 4069: <li><p>When the package builds fine, the next step is to install
4070: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
4071: everything works.</p></li>
4072: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
4073: contains a list of the files that are installed by the package, is
4074: nearly empty. Run <span><strong class="command">bmake print-PLIST
4075: >PLIST</strong></span> to generate a probably correct list. Check
4076: the file using your preferred text editor to see if the list of
4077: files looks plausible.</p></li>
4078: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
4079: <code class="filename">PLIST</code> contains garbage or not.</p></li>
4080: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
4081: has been registered in the database of installed files, but with an
4082: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
4083: and <span><strong class="command">bmake install</strong></span> again. Now the package is
4084: registered with the list of files from
4085: <code class="filename">PLIST</code>.</p></li>
4086: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
4087: package from the set of installed files.</p></li>
4088: </ol></div>
4089: <div class="sect1" lang="en">
4090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4091: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.1 dsieger 4092: <div class="sect2" lang="en">
4093: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4094: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 4095: <p>Simple Perl modules are handled automatically by
4096: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4097: </div>
4098: <div class="sect2" lang="en">
4099: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4100: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1 dsieger 4101: <p>KDE applications should always include
4102: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4103: settings that are typical of KDE packages.</p>
4104: </div>
4105: </div>
4106: <div class="sect1" lang="en">
4107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4108: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.1 dsieger 4109: <div class="sect2" lang="en">
4110: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4111: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.1 dsieger 4112: <div class="sect3" lang="en">
4113: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4114: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 4115: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4116: that the “<span class="quote">nvu</span>” package has not yet been imported into
4117: pkgsrc. As the description says it has to do with the web, the obvious
4118: choice for the category is “<span class="quote">www</span>”.</p>
4119: <pre class="programlisting">
4120: <code class="prompt">$</code> mkdir www/nvu
4121: <code class="prompt">$</code> cd www/nvu
4122: </pre>
4123: <p>The web site says that the sources are available as a tar file, so
4124: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4125: <pre class="programlisting">
4126: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4127: </pre>
4128: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4129: below the <code class="varname">DISTNAME</code> line, as the package name should
4130: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4131: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4132: <code class="varname">COMMENT</code> fields. Then the package
4133: <code class="filename">Makefile</code> looked like that:</p>
4134: <pre class="programlisting">
4135: # $NetBSD$
4136: #
4137:
4138: DISTNAME= nvu-1.0-sources
4139: PKGNAME= nvu-1.0
4140: CATEGORIES= www
4141: MASTER_SITES= http://cvs.nvu.com/download/
4142: EXTRACT_SUFX= .tar.bz2
4143:
4144: MAINTAINER= rillig@NetBSD.org
4145: HOMEPAGE= http://cvs.nvu.com/
4146: COMMENT= Web Authoring System
4147:
4148: # url2pkg-marker (please do not remove this line.)
4149: .include "../../mk/bsd.pkg.mk"
4150: </pre>
4151: <p>Then, I quit the editor and watched pkgsrc downloading a large
4152: source archive:</p>
4153: <pre class="programlisting">
4154: url2pkg> Running "make makesum" ...
4155: => Required installed package digest>=20010302: digest-20060826 found
4156: => Fetching nvu-1.0-sources.tar.bz2
4157: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4158: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4159: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4160: url2pkg> Running "make extract" ...
4161: => Required installed package digest>=20010302: digest-20060826 found
4162: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4163: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4164: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4165: ===> Installing dependencies for nvu-1.0
4166: ===> Overriding tools for nvu-1.0
4167: ===> Extracting for nvu-1.0
4168: url2pkg> Adjusting the Makefile.
4169:
4170: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4171:
4172: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4173: </pre>
4174: </div>
4175: <div class="sect3" lang="en">
4176: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4177: <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 4178: <p>Now that the package has been extracted, let's see what's inside
4179: it. The package has a <code class="filename">README.txt</code>, but that only
4180: says something about mozilla, so it's probably useless for seeing what
4181: dependencies this package has. But since there is a GNU configure script
4182: in the package, let's hope that it will complain about everything it
4183: needs.</p>
4184: <pre class="programlisting">
4185: <code class="prompt">$</code> bmake
4186: => Required installed package digest>=20010302: digest-20060826 found
4187: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4188: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4189: ===> Patching for nvu-1.0
4190: ===> Creating toolchain wrappers for nvu-1.0
4191: ===> Configuring for nvu-1.0
4192: [...]
4193: configure: error: Perl 5.004 or higher is required.
4194: [...]
4195: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4196: [...]
4197: </pre>
4198: <p>That worked quite well. So I opened the package Makefile in my
4199: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4200: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4201: package have changed now, and since a perl wrapper is automatically
4202: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4203: from scratch.</p>
4204: <pre class="programlisting">
4205: <code class="prompt">$</code> bmake clean
4206: ===> Cleaning for nvu-1.0
4207: <code class="prompt">$</code> bmake
4208: [...]
4209: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4210: GNU Make. You will not be able to build Mozilla without GNU Make.
4211: [...]
4212: </pre>
4213: <p>So I added “<span class="quote">gmake</span>” to the
4214: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4215: <pre class="programlisting">
4216: [...]
4217: checking for GTK - version >= 1.2.0... no
4218: *** Could not run GTK test program, checking why...
4219: [...]
4220: </pre>
4221: <p>Now to the other dependencies. The first question is: Where is the
4222: GTK package hidden in pkgsrc?</p>
4223: <pre class="programlisting">
4224: <code class="prompt">$</code> echo ../../*/gtk*
4225: [many packages ...]
4226: <code class="prompt">$</code> echo ../../*/gtk
4227: ../../x11/gtk
4228: <code class="prompt">$</code> echo ../../*/gtk2
4229: ../../x11/gtk2
4230: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4231: ../../x11/gtk2/buildlink3.mk
4232: </pre>
4233: <p>The first try was definitely too broad. The second one had exactly
4234: one result, which is very good. But there is one pitfall with GNOME
4235: packages. Before GNOME 2 had been released, there were already many
4236: GNOME 1 packages in pkgsrc. To be able to continue to use these
4237: packages, the GNOME 2 packages were imported as separate packages, and
4238: their names usually have a “<span class="quote">2</span>” appended. So I checked
4239: whether this was the case here, and indeed it was.</p>
4240: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4241: file, adding the dependency is very easy. I just inserted an
4242: <code class="literal">.include</code> line before the last line of the package
4243: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4244: <pre class="programlisting">
4245: [...]
4246: .include "../../x11/gtk2/buildlink3.mk"
4247: .include "../../mk/bsd.pkg.mk
4248: </pre>
4249: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4250: was:</p>
4251: <pre class="programlisting">
4252: [...]
4253: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4254: checking for GTK - version >= 1.2.0... no
4255: *** Could not run GTK test program, checking why...
4256: *** The test program failed to compile or link. See the file config.log for the
4257: *** exact error that occured. This usually means GTK was incorrectly installed
4258: *** or that you have moved GTK since it was installed. In the latter case, you
4259: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4260: configure: error: Test for GTK failed.
4261: [...]
4262: </pre>
4263: <p>In this particular case, the assumption that “<span class="quote">every package
4264: prefers GNOME 2</span>” had been wrong. The first of the lines above
4265: told me that this package really wanted to have the GNOME 1 version of
4266: GTK. If the package had looked for GTK2, it would have looked for
4267: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4268: So I changed the <code class="literal">x11/gtk2</code> to
4269: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4270: and tried again.</p>
4271: <pre class="programlisting">
4272: [...]
4273: 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
4274: In file included from xpidl.c:42:
4275: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4276: In file included from xpidl.c:42:
4277: xpidl.h:132: error: parse error before "IDL_ns"
4278: [...]
4279: </pre>
4280: <p>The package still does not find all of its dependencies. Now the
4281: question is: Which package provides the
4282: <code class="filename">libIDL/IDL.h</code> header file?</p>
4283: <pre class="programlisting">
4284: <code class="prompt">$</code> echo ../../*/*idl*
4285: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4286: <code class="prompt">$</code> echo ../../*/*IDL*
4287: ../../net/libIDL
4288: </pre>
4289: <p>Let's take the one from the second try. So I included the
4290: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4291: again. But the error didn't change. After digging through some of the
4292: code, I concluded that the build process of the package was broken and
4293: couldn't have ever worked, but since the Mozilla source tree is quite
4294: large, I didn't want to fix it. So I added the following to the package
4295: <code class="filename">Makefile</code> and tried again:</p>
4296: <pre class="programlisting">
4297: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4298: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4299: </pre>
4300: <p>The latter line is needed because the package expects the library
4301: <code class="filename">libIDL.so</code>, but only
4302: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4303: wrapper to rewrite that on the fly.</p>
4304: <p>The next problem was related to a recent change of the FreeType
4305: 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>
4306: which patch files were relevant for this issue and copied them to the
4307: <code class="filename">patches</code> directory. Then I retried, fixed the
4308: patches so that they applied cleanly and retried again. This time,
4309: everything worked.</p>
4310: </div>
4311: <div class="sect3" lang="en">
4312: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4313: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 4314: <pre class="programlisting">
4315: <code class="prompt">$</code> bmake CHECK_FILES=no install
4316: [...]
4317: <code class="prompt">$</code> bmake print-PLIST >PLIST
4318: <code class="prompt">$</code> bmake deinstall
4319: <code class="prompt">$</code> bmake install
4320: </pre>
4321: </div>
4322: </div>
4323: </div>
4324: </div>
4325: <div class="chapter" lang="en">
4326: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4327: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 4328: <div class="toc">
4329: <p><b>Table of Contents</b></p>
4330: <dl>
1.6 rillig 4331: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4332: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
4333: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4334: <dd><dl>
4335: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4336: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4337: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4338: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4339: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4340: </dl></dd>
4341: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4342: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4343: <dd><dl>
4344: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4345: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4346: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 4347: </dl></dd>
1.6 rillig 4348: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4349: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 4350: </dl>
4351: </div>
4352: <p>Whenever you're preparing a package, there are a number of
4353: files involved which are described in the following
4354: sections.</p>
4355: <div class="sect1" lang="en">
4356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4357: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 4358: </h2></div></div></div>
4359: <p>Building, installation and creation of a binary package are all
4360: controlled by the package's <code class="filename">Makefile</code>.
4361: The <code class="filename">Makefile</code> describes various things about
4362: a package, for example from where to get it, how to configure,
4363: build, and install it.</p>
4364: <p>A package <code class="filename">Makefile</code> contains several
4365: sections that describe the package.</p>
4366: <p>In the first section there are the following variables, which
4367: should appear exactly in the order given here. The order and
4368: grouping of the variables is mostly historical and has no further
4369: meaning.</p>
4370: <div class="itemizedlist"><ul type="disc">
4371: <li><p><code class="varname">DISTNAME</code> is the basename of the
4372: distribution file to be downloaded from the package's
4373: website.</p></li>
4374: <li><p><code class="varname">PKGNAME</code> is the name of the
4375: package, as used by pkgsrc. You only need to provide it if
4376: <code class="varname">DISTNAME</code> (which is the default) is not a good
4377: name for the package in pkgsrc. Usually it is the pkgsrc
4378: directory name together with the version number. It must match the
4379: regular expression
4380: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4381: starts with a letter or digit, and contains only letters, digits,
4382: dashes, underscores, dots and plus signs.</p></li>
4383: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4384: the package file to create if the <code class="varname">PKGNAME</code>
4385: isn't unique on a SVR4 system. The default is
4386: <code class="varname">PKGNAME</code>, which may be shortened when you use
4387: <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
4388: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4389: does not produce an unique package name on a SVR4 system.
4390: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4391: characters.</p></li>
4392: <li>
4393: <p><code class="varname">CATEGORIES</code> is a list of categories
4394: which the package fits in. You can choose any of the top-level
4395: directories of pkgsrc for it.</p>
4396: <p>Currently the following values are available for
4397: <code class="varname">CATEGORIES</code>. If more than
4398: one is used, they need to be separated by spaces:</p>
4399: <pre class="programlisting">
4400: archivers cross geography meta-pkgs security
4401: audio databases graphics misc shells
4402: benchmarks devel ham multimedia sysutils
4403: biology editors inputmethod net textproc
4404: cad emulators lang news time
4405: chat finance mail parallel wm
4406: comms fonts math pkgtools www
4407: converters games mbone print x11
4408: </pre>
4409: </li>
4410: <li><p><code class="varname">MASTER_SITES</code>,
4411: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4412: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4413: and <code class="varname">DISTFILES</code> are discussed in detail in
1.6 rillig 4414: <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 4415: </ul></div>
4416: <p>The second section contains information about separately
4417: downloaded patches, if any.
4418: </p>
4419: <div class="itemizedlist"><ul type="disc">
4420: <li><p><code class="varname">PATCHFILES:</code>
4421: Name(s) of additional files that contain distribution patches.
4422: There is no default. pkgsrc will look for them at
4423: <code class="varname">PATCH_SITES</code>.
4424: They will automatically be uncompressed before patching if
4425: the names end with <code class="filename">.gz</code> or
4426: <code class="filename">.Z</code>.</p></li>
4427: <li><p><code class="varname">PATCH_SITES</code>:
4428: Primary location(s) for distribution patch files (see
4429: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4430: </ul></div>
4431: <p>The third section contains the following variables.
4432: </p>
4433: <div class="itemizedlist"><ul type="disc">
4434: <li><p><code class="varname">MAINTAINER</code> is the email address
4435: of the person who feels responsible for this package, and who is
4436: most likely to look at problems or questions regarding this
4437: 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
4438: developers should contact the <code class="varname">MAINTAINER</code> before
4439: making major changes to the package. When packaging a new program,
4440: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4441: maintain the package for future updates, set it to
4442: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
4443: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
4444: find more information about the package.</p></li>
4445: <li><p><code class="varname">COMMENT</code> is a one-line
4446: description of the package (should not include the package
4447: name).</p></li>
4448: </ul></div>
4449: <p>Other variables that affect the build:
4450: </p>
4451: <div class="itemizedlist"><ul type="disc"><li>
4452: <p><code class="varname">WRKSRC</code>: The directory where the
4453: interesting distribution files of the package are found. The
4454: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4455: works for most packages.</p>
4456: <p>If a package doesn't create a subdirectory for itself
4457: (most GNU software does, for instance), but extracts itself in
4458: the current directory, you should set
4459: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4460: <p>If a package doesn't create a subdirectory with the
4461: name of <code class="varname">DISTNAME</code> but some different name,
4462: set <code class="varname">WRKSRC</code> to point to the proper name in
4463: <code class="filename">${WRKDIR}</code>, for example
4464: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4465: <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>
4466: <p>The name of the working directory created by pkgsrc is
4467: taken from the <code class="varname">WRKDIR_BASENAME</code>
4468: variable. By default, its value is
4469: <code class="filename">work</code>. If you want to use the same
4470: pkgsrc tree for building different kinds of binary packages,
4471: you can change the variable according to your needs. Two
4472: other variables handle common cases of setting
4473: <code class="varname">WRKDIR_BASENAME</code> individually. If
4474: <code class="varname">OBJHOSTNAME</code> is defined in
1.4 rillig 4475: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4476: the host's name is attached to the directory name. If
4477: <code class="varname">OBJMACHINE</code> is defined, the platform name
4478: is attached, which might look like
4479: <code class="filename">work.i386</code> or
4480: <code class="filename">work.sparc</code>.</p>
4481: </li></ul></div>
4482: <p>Please pay attention to the following gotchas:</p>
4483: <div class="itemizedlist"><ul type="disc">
4484: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
4485: installed in compressed form by the package. For packages using
4486: BSD-style makefiles which honor MANZ, there is
4487: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
4488: <li><p>Replace <code class="filename">/usr/local</code> with
4489: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4490: below).</p></li>
1.6 rillig 4491: <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 4492: </ul></div>
4493: </div>
4494: <div class="sect1" lang="en">
4495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4496: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4497: </h2></div></div></div>
4498: <p>The <code class="filename">distinfo</code> file contains the message
4499: digest, or checksum, of each distfile needed for the package. This
4500: ensures that the distfiles retrieved from the Internet have not been
4501: corrupted during transfer or altered by a malign force to introduce
4502: a security hole. Due to recent rumor about weaknesses of digest
4503: algorithms, all distfiles are protected using both SHA1 and RMD160
4504: message digests, as well as the file size.</p>
4505: <p>The <code class="filename">distinfo</code> file also contains the
4506: checksums for all the patches found in the
1.6 rillig 4507: <code class="filename">patches</code> directory (see <a href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 4508: <p>To regenerate the <code class="filename">distinfo</code> file, use the
4509: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4510: command.</p>
4511: <p>Some packages have different sets of distfiles depending on
4512: 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
4513: <code class="filename">distinfo</code> file and care should be taken when
4514: upgrading such a package to ensure distfile information is not
4515: lost.</p>
4516: </div>
4517: <div class="sect1" lang="en">
4518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4519: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4520: <p>Many packages still don't work out-of-the box on the various
4521: platforms that are supported by pkgsrc. Therefore, a number of custom
4522: patch files are needed to make the package work. These patch files are
4523: found in the <code class="filename">patches/</code> directory.</p>
4524: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4525: applied to the files in <code class="varname">WRKSRC</code> directory after
4526: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4527: order</a>, so <code class="filename">patch-aa</code> is applied before
4528: <code class="filename">patch-ab</code>, etc.</p>
4529: <div class="sect2" lang="en">
4530: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4531: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4532: <p>The <code class="filename">patch-*</code> files should be in
4533: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
4534: problems. (To force patches to apply with fuzz you can set
4535: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4536: should contain only changes for a single file, and no file should be
4537: patched by more than one patch file. This helps to keep future
4538: modifications simple.</p>
4539: <p>Each patch file is structured as follows: In the first line,
4540: there is the RCS Id of the patch itself. The second line should be
4541: empty for aesthetic reasons. After that, there should be a comment for
4542: each change that the patch does. There are a number of standard
4543: cases:</p>
4544: <div class="itemizedlist"><ul type="disc">
4545: <li><p>Patches that replace the <code class="literal">==</code>
4546: 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
4547: should contain a reference to , to avoid
4548: redundant explanations.</p></li>
4549: <li><p>Patches for commonly known vulnerabilities should
4550: mention the vulnerability ID (CAN, CVE).</p></li>
4551: <li><p>Patches that change source code should mention the
4552: platform and other environment (for example, the compiler) that the
4553: patch is needed for.</p></li>
4554: </ul></div>
4555: <p>In all other cases, the patch should be commented so that any
4556: developer who knows the code of the application can make some use of
4557: the patch. Special care should be taken for the upstream developers,
4558: since we generally want that they accept our patches, so we have less
4559: work in the future.</p>
4560: </div>
4561: <div class="sect2" lang="en">
4562: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4563: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4564: <p>One important thing to mention is to pay attention that no RCS
4565: IDs get stored in the patch files, as these will cause problems when
4566: later checked into the NetBSD CVS tree. Use the
4567: <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
4568: problems.</p>
4569: <p>For even more automation, we recommend using
4570: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4571: whole set of patches. You just have to backup files before you
4572: edit them to <code class="filename">filename.orig</code>, e.g. with
4573: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4574: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4575: you upgrade a package this way, you can easily compare the new
4576: set of patches with the previously existing one with
4577: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4578: or update from the <code class="filename">work/.newpatches</code>
4579: directory to <code class="filename">patches/</code>.</p>
4580: <p>When you have finished a package, remember to generate
4581: the checksums for the patch files by using the <span><strong class="command">make
1.6 rillig 4582: 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 4583: <p>When adding a patch that corrects a problem in the
4584: distfile (rather than e.g. enforcing pkgsrc's view of where
4585: man pages should go), send the patch as a bug report to the
4586: maintainer. This benefits non-pkgsrc users of the package,
4587: and usually makes it possible to remove the patch in future
4588: version.</p>
1.2 rillig 4589: <p>The file names of the patch files are usually of the form
4590: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1 dsieger 4591: </div>
4592: <div class="sect2" lang="en">
4593: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4594: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4595: <p>If you want to share patches between multiple packages
4596: in pkgsrc, e.g. because they use the same distfiles, set
4597: <code class="varname">PATCHDIR</code> to the path where the patch files
4598: can be found, e.g.:</p>
4599: <pre class="programlisting">
4600: PATCHDIR= ${.CURDIR}/../xemacs/patches
4601: </pre>
4602: <p>Patch files that are distributed by the author or other
4603: maintainers can be listed in
4604: <code class="varname">PATCHFILES</code>.</p>
4605: <p>If it is desired to store any patches that should not be
4606: committed into pkgsrc, they can be kept outside the pkgsrc
4607: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4608: directory tree there is expected to have the same
4609: “<span class="quote">category/package</span>” structure as pkgsrc, and
4610: patches are expected to be stored inside these dirs (also
4611: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4612: example, if you want to keep a private patch for
4613: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4614: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4615: files in the named directory are expected to be patch files,
4616: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4617: applied</em></span>.</p>
4618: </div>
4619: <div class="sect2" lang="en">
4620: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4621: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4622: <p>When fixing a portability issue in the code do not use
4623: preprocessor magic to check for the current operating system nor
4624: platform. Doing so hurts portability to other platforms because
4625: the OS-specific details are not abstracted appropriately.</p>
4626: <p>The general rule to follow is: instead of checking for the
4627: operating system the application is being built on, check for the
4628: specific <span class="emphasis"><em>features</em></span> you need. For example,
4629: instead of assuming that kqueue is available under NetBSD and
4630: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.6 rillig 4631: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4632: yes, this generally involves patching the
4633: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4634: that prevents some OSes from adopting interfaces from other OSes
4635: (e.g. Linux implementing kqueue), something that the above checks
4636: cannot take into account.</p>
4637: <p>Of course, checking for features generally involves more
4638: work on the developer's side, but the resulting changes are
4639: cleaner and there are chances they will work on many other
4640: platforms. Not to mention that there are higher chances of being
4641: later integrated into the mainstream sources. Remember:
4642: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4643: <p>Some typical examples:</p>
4644: <div class="table">
1.6 rillig 4645: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4646: <div class="table-contents"><table summary="Patching examples" border="1">
4647: <colgroup>
4648: <col>
4649: <col>
4650: <col>
4651: </colgroup>
4652: <thead><tr>
4653: <th>Where</th>
4654: <th>Incorrect</th>
4655: <th>Correct</th>
4656: </tr></thead>
4657: <tbody>
4658: <tr>
4659: <td>configure script</td>
4660: <td>
4661: <pre class="programlisting">
4662: case ${target_os} in
4663: netbsd*) have_kvm=yes ;;
4664: *) have_kvm=no ;;
4665: esac
4666: </pre>
4667: </td>
4668: <td>
4669: <pre class="programlisting">
4670: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4671: </pre>
4672: </td>
4673: </tr>
4674: <tr>
4675: <td>C source file</td>
4676: <td>
4677: <pre class="programlisting">
4678: #if defined(__NetBSD__)
4679: # include <sys/event.h>
4680: #endif
4681: </pre>
4682: </td>
4683: <td>
4684: <pre class="programlisting">
4685: #if defined(HAVE_SYS_EVENT_H)
4686: # include <sys/event.h>
4687: #endif
4688: </pre>
4689: </td>
4690: </tr>
4691: <tr>
4692: <td>C source file</td>
4693: <td>
4694: <pre class="programlisting">
4695: int
4696: monitor_file(...)
4697: {
4698: #if defined(__NetBSD__)
4699: int fd = kqueue();
4700: ...
4701: #else
4702: ...
4703: #endif
4704: }
4705: </pre>
4706: </td>
4707: <td>
4708: <pre class="programlisting">
4709: int
4710: monitor_file(...)
4711: {
4712: #if defined(HAVE_KQUEUE)
4713: int fd = kqueue();
4714: ...
4715: #else
4716: ...
4717: #endif
4718: }
4719: </pre>
4720: </td>
4721: </tr>
4722: </tbody>
4723: </table></div>
4724: </div>
4725: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
4726: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4727: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4728: 2</a>). It summarizes multiple details on how to make
4729: software easier to package; all the suggestions in it were
4730: collected from our experience in pkgsrc work, so they are possibly
4731: helpful when creating patches too.</p>
4732: </div>
4733: <div class="sect2" lang="en">
4734: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4735: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4736: <p>Always, always, <span class="strong"><strong>always</strong></span>
4737: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4738: improvements you do to a package to the mainstream developers.
4739: This is the only way to get their attention on portability issues
4740: and to ensure that future versions can be built out-of-the box on
4741: NetBSD. Furthermore, any user that gets newer distfiles will get
4742: the fixes straight from the packaged code.</p>
4743: <p>This generally involves cleaning up the patches
4744: (because sometimes the patches that are
4745: added to pkgsrc are quick hacks), filling bug reports in the
4746: appropriate trackers for the projects and working with the
4747: mainstream authors to accept your changes. It is
4748: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4749: the packages in pkgsrc are kept simple and thus further changes
4750: can be done without much hassle.</p>
4751: <p>Support the idea of free software!</p>
4752: </div>
4753: </div>
4754: <div class="sect1" lang="en">
4755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4756: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1 dsieger 4757: <div class="variablelist"><dl>
4758: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4759: <dd><p>A multi-line description of the piece of software. This should include
4760: any credits where they are due. Please bear in mind that others do not
4761: share your sense of humour (or spelling idiosyncrasies), and that others
4762: will read everything that you write here.</p></dd>
4763: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4764: <dd><p>This file governs the files that are installed on your
4765: system: all the binaries, manual pages, etc. There are other
4766: directives which may be entered in this file, to control the
4767: creation and deletion of directories, and the location of
1.6 rillig 4768: inserted files. See <a href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4769: information.</p></dd>
4770: </dl></div>
4771: </div>
4772: <div class="sect1" lang="en">
4773: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4774: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1 dsieger 4775: <div class="sect2" lang="en">
4776: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4777: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1 dsieger 4778: <div class="variablelist"><dl>
4779: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4780: <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>.
4781: First time after package extraction and before files are
4782: moved in place, the second time after the files to install
4783: are moved in place. This can be used to do any custom
4784: procedures not possible with @exec commands in
4785: <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 4786: <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 4787: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4788: <dd><p>This script is executed before and after any files are removed. It is
4789: this script's responsibility to clean up any additional messy details
4790: around the package's installation, since all pkg_delete knows is how to
4791: delete the files created in the original distribution.
4792: 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>
4793: 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>
4794: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4795: <dd>
4796: <p>This file is displayed after installation of the package.
4797: Useful for things like legal notices on almost-free
4798: software and hints for updating config files after
4799: installing modules for apache, PHP etc.
4800: Please note that you can modify variables in it easily by using
4801: <code class="varname">MESSAGE_SUBST</code> in the package's
4802: <code class="filename">Makefile</code>:</p>
4803: <pre class="programlisting">
4804: MESSAGE_SUBST+= SOMEVAR="somevalue"
4805: </pre>
4806: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
4807: <code class="filename">MESSAGE</code>. By default, substitution is
4808: performed for <code class="varname">PKGNAME</code>,
4809: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4810: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4811: <code class="varname">X11BASE</code>,
4812: <code class="varname">PKG_SYSCONFDIR</code>,
4813: <code class="varname">ROOT_GROUP</code>, and
4814: <code class="varname">ROOT_GROUP</code>.</p>
4815: <p>You can display a different or additional files by
4816: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4817: default is <code class="filename">MESSAGE</code>, if the file
4818: exists.</p>
4819: </dd>
4820: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4821: <dd><p>FIXME: There is no documentation on the
4822: alternatives framework.</p></dd>
4823: </dl></div>
4824: </div>
4825: <div class="sect2" lang="en">
4826: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4827: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1 dsieger 4828: <div class="variablelist"><dl>
4829: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4830: <dd><p>This file contains arbitrary things that could
4831: also go into a <code class="filename">Makefile</code>, but its purpose is
4832: to be used by more than one package. This file should only be
4833: used when the packages that will use the file are known in
4834: advance. For other purposes it is often better to write a
4835: <code class="filename">*.mk</code> file and give it a good name that
4836: describes what it does.</p></dd>
4837: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4838: <dd><p>This file contains the dependency information
1.6 rillig 4839: 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 4840: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4841: <dd><p>This file contains workarounds for compiler bugs
4842: and similar things. It is included automatically by the pkgsrc
4843: infrastructure, so you don't need an extra
4844: <code class="literal">.include</code> line for
4845: it.</p></dd>
4846: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4847: <dd><p>This file contains the code for the
1.6 rillig 4848: 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 4849: selected by the user. If a package has only one or two options,
4850: it is equally acceptable to put the code directly into the
4851: <code class="filename">Makefile</code>.</p></dd>
4852: </dl></div>
4853: </div>
4854: <div class="sect2" lang="en">
4855: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4856: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1 dsieger 4857: <div class="variablelist"><dl>
4858: <dt><span class="term"><code class="filename">README*</code></span></dt>
4859: <dd><p>These files do not take place in the creation of
4860: a package and thus are purely informative to the package
4861: developer.</p></dd>
4862: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4863: <dd><p>This file contains things that need to be done
4864: to make the package even
4865: better.</p></dd>
4866: </dl></div>
4867: </div>
4868: </div>
4869: <div class="sect1" lang="en">
4870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4871: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4872: </h2></div></div></div>
4873: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
4874: unpacked into the directory denoted by
4875: <code class="varname">WRKDIR</code>. It can be removed by running
4876: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4877: directory is also used to keep various timestamp files.
4878: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4879: The default is <code class="filename">${.CURDIR}/work</code>
4880: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4881: if <code class="varname">OBJMACHINE</code> is set.</p>
4882: </div>
4883: <div class="sect1" lang="en">
4884: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4885: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4886: </h2></div></div></div>
4887: <p>If you have any files that you wish to be placed in the package prior
4888: to configuration or building, you could place these files here and use
4889: a <span><strong class="command">${CP}</strong></span> command in the
4890: “<span class="quote">pre-configure</span>” target to achieve
4891: this. Alternatively, you could simply diff the file against
4892: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4893: the creation of this file.</p>
4894: <p>If you want to share files in this way with other
4895: packages, set the <code class="varname">FILESDIR</code> variable to point
4896: to the other package's <code class="filename">files</code> directory,
4897: e.g.:</p>
4898: <pre class="programlisting">
4899: FILESDIR=${.CURDIR}/../xemacs/files
4900: </pre>
4901: </div>
4902: </div>
4903: <div class="chapter" lang="en">
4904: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4905: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4906: <div class="toc">
4907: <p><b>Table of Contents</b></p>
4908: <dl>
1.6 rillig 4909: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
4910: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
4911: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4912: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4913: <dd><dl>
4914: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4915: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4916: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4917: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4918: <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 4919: </dl></dd>
4920: </dl>
4921: </div>
4922: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4923: each of which forms a well-defined part of the pkgsrc system. Using
4924: 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
4925: like pkgsrc requires some discipline to keep the code correct and
4926: understandable.</p>
4927: <p>The basic ingredients for <code class="filename">Makefile</code>
4928: programming are variables (which are actually macros) and shell
4929: commands. Among these shell commands may even be more complex ones
4930: 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
4931: as intended it is necessary to quote all variables correctly when they
4932: are used.</p>
4933: <p>This chapter describes some patterns, that appear quite often in
4934: <code class="filename">Makefile</code>s, including the pitfalls that come along
4935: with them.</p>
4936: <div class="sect1" lang="en">
4937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4938: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.1 dsieger 4939: <div class="itemizedlist"><ul type="disc"><li>
4940: <p>When you are creating a file as a
4941: target of a rule, always write the data to a temporary file first
4942: and finally rename that file. Otherwise there might occur an error
4943: in the middle of generating the file, and when the user runs
4944: <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
4945: regenerated properly. Example:</p>
4946: <pre class="programlisting">
4947: wrong:
4948: @echo "line 1" > ${.TARGET}
4949: @echo "line 2" >> ${.TARGET}
4950: @false
4951:
4952: correct:
4953: @echo "line 1" > ${.TARGET}.tmp
4954: @echo "line 2" >> ${.TARGET}.tmp
4955: @false
4956: @mv ${.TARGET}.tmp ${.TARGET}
4957: </pre>
4958: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4959: <code class="filename">wrong</code> will exist, although there was an error
4960: message in the first run. On the other hand, running <span><strong class="command">make
4961: correct</strong></span> gives an error message twice, as expected.</p>
4962: <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
4963: <code class="literal">${.TARGET}</code> in case of error, but this only
4964: happens when it is interrupted, for example by pressing
4965: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4966: 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>
4967: </li></ul></div>
4968: </div>
4969: <div class="sect1" lang="en">
4970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4971: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4972: <p><code class="filename">Makefile</code> variables contain strings that
4973: can be processed using the five operators ``='', ``+='', ``?='',
4974: ``:='', 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
4975: page.</p>
4976: <p>When a variable's value is parsed from a
4977: <code class="filename">Makefile</code>, the hash character ``#'' and the
4978: backslash character ``\'' are handled specially. If a backslash is
4979: followed by a newline, any whitespace immediately in front of the
4980: backslash, the backslash, the newline, and any whitespace
4981: immediately behind the newline are replaced with a single space. A
4982: backslash character and an immediately following hash character are
4983: replaced with a single hash character. Otherwise, the backslash is
4984: passed as is. In a variable assignment, any hash character that is
4985: not preceded by a backslash starts a comment that continues upto the
4986: end of the logical line.</p>
4987: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4988: the only way to create a variable consisting of a single backslash
4989: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4990: <p>So far for defining variables. The other thing you can do with
4991: variables is evaluating them. A variable is evaluated when it is
4992: part of the right side of the ``:='' or the ``!='' operator, or
4993: directly before executing a shell command which the variable is part
4994: 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
4995: is, variables are not evaluated until there's no other way. The
4996: ``modifiers'' mentioned in the man page also evaluate the
4997: variable.</p>
4998: <p>Some of the modifiers split the string into words and then
4999: operate on the words, others operate on the string as a whole. When
5000: a string is split into words, it is split as you would expect
5001: 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 5002: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.1 dsieger 5003: loop does not follow the shell quoting rules but splits at sequences
5004: of whitespace.</p>
5005: <p>There are several types of variables that should be handled
5006: differently. Strings and two types of lists.</p>
5007: <div class="itemizedlist"><ul type="disc">
5008: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
5009: characters. Nevertheless, you should restrict yourself to only
5010: using printable characters. Examples are
5011: <code class="varname">PREFIX</code> and
5012: <code class="varname">COMMENT</code>.</p></li>
5013: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
5014: are never exported to any shell command. Their elements are
5015: separated by whitespace. Therefore, the elements themselves cannot
5016: have embedded whitespace. Any other characters are allowed.
5017: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
5018: Examples are <code class="varname">DEPENDS</code> and
5019: <code class="varname">BUILD_DEPENDS</code>.</p></li>
5020: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
5021: may be exported to a shell command. Their elements can contain any
5022: characters, including whitespace. That's why they cannot be used
5023: in <span><strong class="command">.for</strong></span> loops. Examples are
5024: <code class="varname">DISTFILES</code> and
5025: <code class="varname">MASTER_SITES</code>.</p></li>
5026: </ul></div>
5027: <div class="sect2" lang="en">
5028: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5029: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.1 dsieger 5030: <div class="itemizedlist"><ul type="disc">
5031: <li><p>All variable names starting with an underscore
5032: are reserved for use by the pkgsrc infrastructure. They shall
5033: not be used by package
5034: <code class="filename">Makefile</code>s.</p></li>
5035: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
5036: lowercase variable names for the iteration
5037: variables.</p></li>
5038: <li><p>All list variables should have a ``plural''
5039: name, e.g. <code class="varname">PKG_OPTIONS</code> or
5040: <code class="varname">DISTFILES</code>.</p></li>
5041: </ul></div>
5042: </div>
5043: </div>
5044: <div class="sect1" lang="en">
5045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5046: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 5047: <p>This section presents you with some code snippets you should
5048: use in your own code. If you don't find anything appropriate here,
5049: you should test your code and add it here.</p>
5050: <div class="sect2" lang="en">
5051: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5052: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 5053: <pre class="programlisting">
5054: STRING= foo * bar `date`
5055: INT_LIST= # empty
5056: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
5057: EXT_LIST= # empty
5058: ANOTHER_EXT_LIST= a=b c=d
5059:
5060: INT_LIST+= ${STRING} # 1
5061: INT_LIST+= ${ANOTHER_INT_LIST} # 2
5062: EXT_LIST+= ${STRING:Q} # 3
5063: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
5064: </pre>
5065: <p>When you add a string to an external list (example 3), it
5066: must be quoted. In all other cases, you must not add a quoting
5067: level. You must not merge internal and external lists, unless you
5068: are sure that all entries are correctly interpreted in both
5069: lists.</p>
5070: </div>
5071: <div class="sect2" lang="en">
5072: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5073: <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 5074: <pre class="programlisting">
5075: EXT_LIST= # empty
5076: .for i in ${INT_LIST}
5077: EXT_LIST+= ${i:Q}""
5078: .endfor
5079: </pre>
5080: <p>This code converts the internal list
5081: <code class="varname">INT_LIST</code> into the external list
5082: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5083: are unquoted they must be quoted here. The reason for appending
5084: <code class="varname">""</code> is explained below.</p>
5085: </div>
5086: <div class="sect2" lang="en">
5087: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5088: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 5089: <p>Sometimes you may want to print an arbitrary string. There
5090: are many ways to get it wrong and only few that can handle every
5091: nastiness.</p>
5092: <pre class="programlisting">
5093: STRING= foo bar < > * `date` $$HOME ' "
5094: EXT_LIST= string=${STRING:Q} x=second\ item
5095:
5096: all:
5097: echo ${STRING} # 1
5098: echo "${STRING}" # 2
5099: echo "${STRING:Q}" # 3
5100: echo ${STRING:Q} # 4
5101: echo x${STRING:Q} | sed 1s,.,, # 5
5102: printf "%s\\n" ${STRING:Q}"" # 6
5103: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
5104: </pre>
5105: <p>Example 1 leads to a syntax error in the shell, as the
5106: characters are just copied.</p>
5107: <p>Example 2 leads to a syntax error too, and if you leave out
5108: the last " character from <code class="varname">${STRING}</code>,
5109: <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
5110: variable would be evaluated, too.</p>
5111: <p>Example 3 outputs each space character preceded by a
5112: backslash (or not), depending on the implementation of the
5113: <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>
5114: <p>Example 4 handles correctly every string that does not start
5115: with a dash. In that case, the result depends on the
5116: 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
5117: guarantee that your input does not start with a dash, this form is
5118: appropriate.</p>
5119: <p>Example 5 handles even the case of a leading dash
5120: correctly.</p>
5121: <p>Example 6 also works with every string and is the
5122: light-weight solution, since it does not involve a pipe, which has
5123: its own problems.</p>
5124: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5125: because the quoting has already been done when adding elements to
5126: the list.</p>
5127: <p>As internal lists shall not be passed to the shell, there is
5128: no example for it.</p>
5129: </div>
5130: <div class="sect2" lang="en">
5131: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5132: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 5133: <p>There are many possible sources of wrongly quoted variables.
5134: This section lists some of the commonly known ones.</p>
5135: <div class="itemizedlist"><ul type="disc">
5136: <li>
5137: <p>Whenever you use the value of a list, think
5138: about what happens to leading or trailing whitespace. If the
5139: list is a well-formed shell expression, you can apply the
5140: <code class="varname">:M*</code> modifier to strip leading and trailing
5141: whitespace from each word. The <code class="varname">:M</code> operator
5142: first splits its argument according to the rules of the shell,
5143: and then creates a new list consisting of all words that match
5144: the shell glob expression <code class="varname">*</code>, that is: all.
5145: One class of situations where this is needed is when adding a
5146: variable like <code class="varname">CPPFLAGS</code> to
5147: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5148: invokes other configure scripts, it strips the leading and
5149: trailing whitespace from the variable and then passes it to the
5150: other configure scripts. But these configure scripts expect the
5151: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5152: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5153: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5154: here is how we do it:</p>
5155: <pre class="programlisting">
5156: CPPFLAGS= # empty
5157: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5158: CPPFLAGS+= ${MY_CPPFLAGS}
5159:
5160: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5161:
5162: all:
5163: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5164: echo x${CONFIGURE_ARGS}x # properly trimmed
5165: </pre>
5166: </li>
5167: <li><p>The example above contains one bug: The
5168: <code class="varname">${PREFIX}</code> is a properly quoted shell
5169: expression, but there is the C compiler after it, which also
5170: expects a properly quoted string (this time in C syntax). The
5171: version above is therefore only correct if
5172: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5173: or double quotes. If you want to allow these, you have to add
5174: another layer of quoting to each variable that is used as a C
5175: string literal. You cannot use the <code class="varname">:Q</code>
5176: operator for it, as this operator only works for the
5177: shell.</p></li>
5178: <li>
5179: <p>Whenever a variable can be empty, the
5180: <code class="varname">:Q</code> operator can have surprising results. Here
5181: are two completely different cases which can be solved with the
5182: same trick.</p>
5183: <pre class="programlisting">
5184: EMPTY= # empty
5185: empty_test:
5186: for i in a ${EMPTY:Q} c; do \
5187: echo "$$i"; \
5188: done
5189:
5190: for_test:
5191: .for i in a:\ a:\test.txt
5192: echo ${i:Q}
5193: echo "foo"
5194: .endfor
5195: </pre>
5196: <p>The first example will only print two of the three lines
5197: we might have expected. This is because
5198: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5199: the shell cannot see. The workaround is to write
5200: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5201: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5202: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5203: <p>The second example will only print three lines instead of
5204: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5205: This is because the backslash of the value
5206: <code class="varname">a:\</code> is interpreted as a line-continuation by
5207: <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
5208: <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
5209: <code class="varname">${i:Q}""</code>.</p>
5210: </li>
5211: </ul></div>
5212: </div>
5213: <div class="sect2" lang="en">
5214: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5215: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 5216: <p>The pkgsrc bmake program does not handle the following
5217: assignment correctly. In case <code class="varname">_othervar_</code>
5218: contains a ``-'' character, one of the closing braces is included
5219: in <code class="varname">${VAR}</code> after this code executes.</p>
5220: <pre class="programlisting">
5221: VAR:= ${VAR:N${_othervar_:C/-//}}
5222: </pre>
5223: <p>For a more complex code snippet and a workaround, see the
5224: 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
5225: <code class="varname">bug1</code>.</p>
5226: </div>
5227: </div>
5228: </div>
5229: <div class="chapter" lang="en">
5230: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5231: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 5232: <div class="toc">
5233: <p><b>Table of Contents</b></p>
5234: <dl>
1.6 rillig 5235: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
5236: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5237: <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>
5238: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5239: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
5240: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5241: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5242: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 5243: </dl>
5244: </div>
5245: <p>The <code class="filename">PLIST</code> file contains a package's
5246: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5247: the package (relative to the <code class="filename">${PREFIX}</code>
5248: directory it's been installed in) plus some additional statements
5249: - 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.
5250: This chapter addresses some issues that need attention when
5251: dealing with the <code class="filename">PLIST</code> file (or files, see
5252: below!).</p>
5253: <div class="sect1" lang="en">
5254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5255: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 5256: <p>Be sure to add a RCS ID line as the first thing in any
5257: <code class="filename">PLIST</code> file you write:</p>
5258: <pre class="programlisting">
5259: @comment $NetBSD$
5260: </pre>
5261: </div>
5262: <div class="sect1" lang="en">
5263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5264: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.1 dsieger 5265: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
5266: to output a PLIST that matches any new files since the package
1.6 rillig 5267: 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 5268: more information on this target.</p>
5269: </div>
5270: <div class="sect1" lang="en">
5271: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5272: <a name="print-PLIST"></a>13.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
1.1 dsieger 5273: </h2></div></div></div>
5274: <p>If you have used any of the *-dirs packages, as explained in
1.6 rillig 5275: <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 5276: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5277: <code class="varname">@comment</code>s instead of real
5278: <code class="varname">@dirrm</code> lines. You can also do this for
5279: specific directories and files, so that the results of that
5280: command are very close to reality. This helps <span class="emphasis"><em>a
5281: lot</em></span> during the update of packages.</p>
5282: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5283: of AWK patterns and actions that are used to filter the output of
5284: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5285: scripting you like to it, but be careful with quoting.</p>
5286: <p>For example, to get all files inside the
5287: <code class="filename">libdata/foo</code> directory removed from the
5288: resulting PLIST:</p>
5289: <pre class="programlisting">
5290: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5291: </pre>
5292: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5293: to a specific (shared) directory converted to
5294: <code class="varname">@comment</code>s:</p>
5295: <pre class="programlisting">
5296: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5297: </pre>
5298: </div>
5299: <div class="sect1" lang="en">
5300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5301: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 5302: <p>A number of variables are substituted automatically in
5303: PLISTs when a package is installed on a system. This includes the
5304: following variables:</p>
5305: <div class="variablelist"><dl>
5306: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5307: <dd>
5308: <p>Some packages like emacs and perl embed information
5309: about which architecture they were built on into the
5310: pathnames where they install their files. To handle this
5311: case, PLIST will be preprocessed before actually used, and
5312: the symbol
5313: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5314: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5315: same is done if the string
5316: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5317: PLIST somewhere - use this on packages that have GNU
5318: autoconf-created configure scripts.</p>
5319: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5320: <h3 class="title">Legacy note</h3>
5321: <p>There used to be a symbol
5322: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5323: was replaced by the output of <span><strong class="command">uname
5324: -m</strong></span>, but that's no longer supported and has
5325: been removed.</p>
5326: </div>
5327: </dd>
5328: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5329: <dd>
5330: <p>Some packages want to embed the OS name and version
5331: into some paths. To do this, use these variables in the
5332: <code class="filename">PLIST</code>:
5333: </p>
5334: <div class="itemizedlist"><ul type="disc">
5335: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5336: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5337: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5338: </ul></div>
5339: </dd>
5340: </dl></div>
5341: <p>For a complete list of values which are replaced by
5342: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5343: search for <code class="varname">PLIST_SUBST</code>).</p>
5344: <p>If you want to change other variables not listed above, you
5345: can add variables and their expansions to this variable in the
1.6 rillig 5346: 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 5347: <pre class="programlisting">
5348: PLIST_SUBST+= SOMEVAR="somevalue"
5349: </pre>
5350: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
5351: in the <code class="filename">PLIST</code> with
5352: “<span class="quote">somevalue</span>”.</p>
5353: </div>
5354: <div class="sect1" lang="en">
5355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5356: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5357: <p>Man pages should be installed in compressed form if
5358: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5359: and uncompressed otherwise. To handle this in the
5360: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5361: appended/removed automatically for man pages according to
5362: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5363: or not, see above for details. This modification of the
5364: <code class="filename">PLIST</code> file is done on a copy of it, not
5365: <code class="filename">PLIST</code> itself.</p>
5366: </div>
5367: <div class="sect1" lang="en">
5368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5369: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5370: </h2></div></div></div>
5371: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5372: in generating the binary package, set the variable
5373: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5374: 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
5375: important. The default for <code class="varname">PLIST_SRC</code> is
5376: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5377: </div>
5378: <div class="sect1" lang="en">
5379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5380: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5381: <p>Some packages decide to install a different set of files based on
5382: the operating system being used. These differences can be
5383: automatically handled by using the following files:</p>
5384: <div class="itemizedlist"><ul type="disc">
5385: <li><p><code class="filename">PLIST.common</code></p></li>
5386: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5387: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5388: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5389: <li><p><code class="filename">PLIST.common_end</code></p></li>
5390: </ul></div>
5391: </div>
5392: <div class="sect1" lang="en">
5393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5394: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.1 dsieger 5395: <p>A “<span class="quote">shared directory</span>” is a directory where
5396: multiple (and unrelated) packages install files. These
5397: directories are problematic because you have to add special tricks
5398: in the PLIST to conditionally remove them, or have some
5399: centralized package handle them.</p>
5400: <p>Within pkgsrc, you'll find both approaches. If a directory
5401: is shared by a few unrelated packages, it's often not worth to add
5402: an extra package to remove it. Therefore, one simply does:</p>
5403: <pre class="programlisting">
5404: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
5405: </pre>
5406: <p>in the PLISTs of all affected packages, instead of the
5407: regular "@dirrm" line.</p>
5408: <p>However, if the directory is shared across many packages, two
5409: different solutions are available:</p>
5410: <div class="orderedlist"><ol type="1">
5411: <li><p>If the packages have a common dependency, the directory
5412: can be removed in that. For example, see
5413: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
5414: removes the shared directory
5415: <code class="filename">share/omf</code>.</p></li>
5416: <li><p>If the packages using the directory are not related at
5417: all (they have no common dependencies), a *-dirs package is
5418: used.</p></li>
5419: </ol></div>
5420: <p>From now on, we'll discuss the second solution. To get an
5421: idea of the *-dirs packages available, issue:</p>
5422: <pre class="programlisting">
5423: <code class="prompt">%</code> cd .../pkgsrc
5424: <code class="prompt">%</code> ls -d */*-dirs
5425: </pre>
5426: <p>Their use from other packages is very simple. The
5427: <code class="varname">USE_DIRS</code> variable takes a list of package names
5428: (without the “<span class="quote">-dirs</span>” part) together with the required
5429: version number (always pick the latest one when writing new
5430: packages).</p>
5431: <p>For example, if a package installs files under
5432: <code class="filename">share/applications</code>, it should have the
5433: following line in it:</p>
5434: <pre class="programlisting">
5435: USE_DIRS+= xdg-1.1
5436: </pre>
5437: <p>After regenerating the PLIST using <span><strong class="command">make
5438: print-PLIST</strong></span>, you should get the right (commented out)
5439: lines.</p>
5440: <p>Note that even if your package is using
5441: <code class="filename">$X11BASE</code>, it must not depend on the
5442: *-x11-dirs packages. Just specify the name without that part and
5443: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5444: care of it.</p>
5445: </div>
5446: </div>
5447: <div class="chapter" lang="en">
5448: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5449: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5450: <div class="toc">
5451: <p><b>Table of Contents</b></p>
5452: <dl>
1.6 rillig 5453: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
5454: <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 5455: <dd><dl>
1.6 rillig 5456: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5457: <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 5458: </dl></dd>
1.6 rillig 5459: <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 5460: <dd><dl>
1.6 rillig 5461: <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>
5462: <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 5463: </dl></dd>
5464: </dl>
5465: </div>
5466: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5467: are seen by a package's configure and build processes. This is implemented
5468: in a two step process:</p>
5469: <div class="orderedlist"><ol type="1">
5470: <li><p>Symlink headers and libraries for dependencies into
5471: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5472: of <code class="varname">WRKDIR</code>.</p></li>
5473: <li><p>Create wrapper scripts that are used in place of the normal compiler
5474: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5475: <code class="option">-L${LOCALBASE}/lib</code> into references to
5476: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5477: native compiler on some operating systems look like GCC, so that
5478: packages that expect GCC won't require modifications to build with
5479: those native compilers.</p></li>
5480: </ol></div>
5481: <p>This normalizes the environment in which a package is built so that the
5482: package may be built consistently despite what other software may be
5483: installed. Please note that the normal system header and library paths,
5484: e.g. <code class="filename">/usr/include</code>,
5485: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5486: designed to insulate the package build from non-system-supplied
5487: software.</p>
5488: <div class="sect1" lang="en">
5489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5490: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5491: <p>The process of converting packages to use the buildlink3
5492: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5493: The things to keep in mind are:</p>
5494: <div class="orderedlist"><ol type="1">
5495: <li><p>Ensure that the build always calls the wrapper scripts
5496: instead of the actual toolchain. Some packages are tricky,
5497: and the only way to know for sure is the check
5498: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5499: wrappers are being invoked.</p></li>
5500: <li><p>Don't override <code class="varname">PREFIX</code> from within
5501: the package Makefile, e.g. Java VMs, standalone shells,
5502: etc., because the code to symlink files into
5503: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5504: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5505: </p></li>
5506: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5507: <code class="filename">buildlink3.mk</code> files that you list in a
5508: package's Makefile are added as dependencies for that package.
5509: </p></li>
5510: </ol></div>
5511: <p>If a dependency on a particular package is required for its libraries and
5512: headers, then we replace:</p>
5513: <pre class="programlisting">
5514: DEPENDS+= foo>=1.1.0:../../category/foo
5515: </pre>
5516: <p>with</p>
5517: <pre class="programlisting">
5518: .include "../../category/foo/buildlink3.mk"
5519: </pre>
5520: <p>The buildlink3.mk files usually define the required dependencies.
5521: If you need a newer version of the dependency when using buildlink3.mk
5522: files, then you can define it in your Makefile; for example:</p>
5523: <pre class="programlisting">
5524: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5525: .include "../../category/foo/buildlink3.mk"
5526: </pre>
5527: <p>There are several <code class="filename">buildlink3.mk</code>
5528: files in <code class="filename">pkgsrc/mk</code>
5529: that handle special package issues:</p>
5530: <div class="itemizedlist"><ul type="disc">
5531: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
5532: the native or a pkgsrc Berkeley DB implementation based on
5533: the values of <code class="varname">BDB_ACCEPTED</code> and
5534: <code class="varname">BDB_DEFAULT</code>.</p></li>
5535: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
5536: comes with neither Curses nor NCurses, this will take care
5537: 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>
5538: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
5539: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5540: adding a dependency on Heimdal or MIT-krb5 for packages that
5541: require a Kerberos 5 implementation.</p></li>
5542: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5543: system-provided Motif installation or adds a dependency on
5544: <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
5545: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5546: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5547: which Motif version will be used.</p></li>
5548: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
5549: variables that may be used by packages that use the
5550: Open Sound System (OSS) API.</p></li>
5551: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
5552: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
5553: the file for more information.</p></li>
5554: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
5555: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5556: 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>
5557: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
5558: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5559: library.</p></li>
5560: </ul></div>
5561: <p>The comments in those <code class="filename">buildlink3.mk</code>
5562: files provide a more complete
5563: description of how to use them properly.</p>
5564: </div>
5565: <div class="sect1" lang="en">
5566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5567: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 ! rillig 5568: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5569: included by Makefiles to indicate the need to compile and link
5570: against header files and libraries provided by the package. A
5571: <code class="filename">buildlink3.mk</code> file should always provide
5572: enough information to add the correct type of dependency
5573: relationship and include any other
5574: <code class="filename">buildlink3.mk</code> files that it needs to find
5575: headers and libraries that it needs in turn.</p>
5576: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5577: 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>
5578: package is highly recommended. For most packages, the following
5579: command will generate a good starting point for
5580: <code class="filename">buildlink3.mk</code> files:</p>
5581: <pre class="screen">
5582: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5583: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5584: </pre>
5585: <div class="sect2" lang="en">
5586: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5587: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5588: <p>The following real-life example
5589: <code class="filename">buildlink3.mk</code> is taken
5590: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5591: <pre class="programlisting">
5592: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
5593:
5594: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5595: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
5596:
5597: .if ${BUILDLINK_DEPTH} == "+"
5598: BUILDLINK_DEPENDS+= tiff
5599: .endif
5600:
5601: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5602: BUILDLINK_PACKAGES+= tiff
5603:
5604: .if ${TIFF_BUILDLINK3_MK} == "+"
5605: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5606: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5607: .endif # TIFF_BUILDLINK3_MK
5608:
5609: .include "../../devel/zlib/buildlink3.mk"
5610: .include "../../graphics/jpeg/buildlink3.mk"
5611:
5612: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5613: </pre>
5614: <p>The header and footer manipulate
5615: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5616: <code class="filename">buildlink3.mk</code> files and is used to track
5617: at what depth we are including
5618: <code class="filename">buildlink3.mk</code> files.</p>
5619: <p>The first section controls if the dependency on
5620: <em class="replaceable"><code>pkg</code></em> is added.
5621: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5622: packages for which dependencies are added by
5623: buildlink3.</p>
5624: <p>The second section advises pkgsrc that the
5625: <code class="filename">buildlink3.mk</code> file for
5626: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5627: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5628: packages for which <code class="filename">buildlink3.mk</code> files
5629: have been included. It must <span class="emphasis"><em>always</em></span> be
5630: appended to within a <code class="filename">buildlink3.mk</code>
5631: file.</p>
5632: <p>The third section is protected from multiple inclusion
5633: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5634: added. Several important variables are set in the section:</p>
5635: <div class="itemizedlist"><ul type="disc">
5636: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5637: is the actual dependency recorded in the installed
5638: package; this should always be set using
5639: <span><strong class="command">+=</strong></span> to ensure that
5640: we're appending to any pre-existing list of values. This
5641: variable should be set to the first version of the
5642: package that had an API change.
5643: </p></li>
5644: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5645: is the location of the <em class="replaceable"><code>pkg</code></em>
5646: pkgsrc directory.</p></li>
5647: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5648: (not shown above) controls whether we use
5649: <code class="varname">BUILD_DEPENDS</code> or
5650: <code class="varname">DEPENDS</code> to add the dependency on
5651: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5652: selected by setting
5653: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5654: to “<span class="quote">build</span>”. By default, the full dependency is
5655: used.</p></li>
5656: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
5657: and
5658: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5659: (not shown above) are lists of subdirectories of
5660: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5661: to add to the header and library search paths. These
5662: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
5663: respectively.</p></li>
5664: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
5665: (not shown above) is the list of preprocessor flags to add
5666: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5667: configure and build phases. The “<span class="quote">-I</span>” option
5668: should be avoided and instead be handled using
5669: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5670: above.</p></li>
5671: </ul></div>
5672: <p>The following variables are all optionally defined within
5673: this second section (protected against multiple inclusion) and
5674: control which package files are symlinked into
5675: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5676: transformed during the symlinking:</p>
5677: <div class="itemizedlist"><ul type="disc">
5678: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
5679: (not shown above) is a shell glob pattern relative to
5680: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5681: to be symlinked into
5682: <code class="filename">${BUILDLINK_DIR}</code>,
5683: e.g. <code class="filename">include/*.h</code>.</p></li>
5684: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5685: (not shown above) is a shell pipeline that
5686: outputs to stdout a list of files relative to
5687: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5688: The resulting files are to be symlinked
5689: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5690: this takes the <code class="filename">+CONTENTS</code> of a
5691: <em class="replaceable"><code>pkg</code></em> and filters it through
5692: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5693: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5694: (not shown above) is a filter command that filters
5695: <code class="filename">+CONTENTS</code> input into a list of files
5696: relative to
5697: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5698: on stdout. By default for overwrite packages,
5699: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5700: outputs the contents of the <code class="filename">include</code>
5701: and <code class="filename">lib</code> directories in the package
5702: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5703: it outputs any libtool archives in
5704: <code class="filename">lib</code> directories.</p></li>
5705: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
5706: (not shown above) is a list of sed arguments used to
5707: transform the name of the source filename into a
5708: destination filename, e.g. <span><strong class="command">-e
5709: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5710: </ul></div>
5711: <p>The last section includes any
5712: <code class="filename">buildlink3.mk</code> needed for
5713: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5714: Including these <code class="filename">buildlink3.mk</code> files
5715: means that the headers and libraries for these
5716: dependencies are also symlinked into
5717: <code class="filename">${BUILDLINK_DIR}</code>
5718: whenever the <em class="replaceable"><code>pkg</code></em>
5719: <code class="filename">buildlink3.mk</code>
5720: file is included.</p>
5721: </div>
5722: <div class="sect2" lang="en">
5723: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5724: <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 5725: <p>The situation that requires increasing the dependency listed in
5726: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5727: after a package update is when the API or interface to the
5728: header files change.</p>
5729: <p>In this case,
5730: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5731: should be adjusted to require at least the new package
5732: version. In some cases, the packages that depend on this new
5733: version may need their <code class="varname">PKGREVISION</code>s
5734: increased and, if they have <code class="filename">buildlink3.mk</code>
5735: files, their
5736: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5737: adjusted, too. This is needed so pkgsrc will require the
5738: correct package dependency and not settle for an older one
5739: when building the source.</p>
5740: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5741: should be increased when the binary interface or sonames
5742: (major number of the library version) of any installed
5743: shared libraries change. This is needed so that binary
5744: packages made using it will require the correct package
5745: dependency and not settle for an older one which will not
5746: contain the necessary shared libraries.</p>
1.6 rillig 5747: <p>See <a href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.1 dsieger 5748: more information about dependencies on other packages,
5749: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
5750: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5751: <p>Please take careful consideration before adjusting
5752: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5753: or
5754: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5755: as we don't want to cause unneeded package deletions and
5756: rebuilds. In many cases, new versions of packages work just
5757: fine with older dependencies.</p>
5758: <p>Also it is not needed to set
5759: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5760: when it is identical to
5761: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5762: </div>
5763: </div>
5764: <div class="sect1" lang="en">
5765: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5766: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5767: <p>Some packages in pkgsrc install headers and libraries that
5768: coincide with headers and libraries present in the base system.
5769: Aside from a <code class="filename">buildlink3.mk</code> file, these
5770: packages should also include a <code class="filename">builtin.mk</code>
5771: file that includes the necessary checks to decide whether using
5772: the built-in software or the pkgsrc software is
5773: appropriate.</p>
5774: <p>The only requirements of a builtin.mk file for
5775: <em class="replaceable"><code>pkg</code></em> are:</p>
5776: <div class="orderedlist"><ol type="1">
5777: <li><p>It should set
5778: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5779: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5780: after it is included.</p></li>
5781: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5782: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5783: which is already set before the
5784: <code class="filename">builtin.mk</code> file is included.</p></li>
5785: <li><p>It should be written to allow multiple inclusion. This
5786: is <span class="emphasis"><em>very</em></span> important and takes careful
5787: attention to <code class="filename">Makefile</code> coding.</p></li>
5788: </ol></div>
5789: <div class="sect2" lang="en">
5790: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5791: <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 5792: <p>The following is the recommended template for builtin.mk
5793: files:</p>
5794: <pre class="programlisting">
5795: .if !defined(IS_BUILTIN.foo)
5796: #
5797: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5798: # genuinely exists in the system or not.
5799: #
5800: IS_BUILTIN.foo?= no
5801:
5802: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5803: # version can be determined.
5804: #
5805: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5806: BUILTIN_PKG.foo?= foo-1.0
5807: . endif
5808: .endif # IS_BUILTIN.foo
5809:
5810: .if !defined(USE_BUILTIN.foo)
5811: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5812: . if defined(BUILTIN_PKG.foo)
5813: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5814: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5815: USE_BUILTIN.foo!= \
5816: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5817: && ${ECHO} "yes" || ${ECHO} "no"
5818: . endif
5819: . endfor
5820: . endif
5821: .endif # USE_BUILTIN.foo
5822:
5823: CHECK_BUILTIN.foo?= no
5824: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5825: #
5826: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5827: # "yes" or "no".
5828: #
5829: .endif # CHECK_BUILTIN.foo
5830: </pre>
5831: <p>The first section sets
5832: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5833: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5834: in the base system. This should not be a base system software
5835: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5836: it should only be “<span class="quote">yes</span>” if the actual package is
5837: included as part of the base system. This variable is only
5838: used internally within the <code class="filename">builtin.mk</code>
5839: file.</p>
5840: <p>The second section sets
5841: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5842: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5843: system if it exists (if
5844: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5845: is “<span class="quote">yes</span>”). This variable is only used internally
5846: within the <code class="filename">builtin.mk</code> file.</p>
5847: <p>The third section sets
5848: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5849: and is <span class="emphasis"><em>required</em></span> in all
5850: <code class="filename">builtin.mk</code> files. The code in this
5851: section must make the determination whether the built-in
5852: software is adequate to satisfy the dependencies listed in
5853: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5854: This is typically done by comparing
5855: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5856: against each of the dependencies in
5857: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5858: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5859: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5860: end of the <code class="filename">builtin.mk</code> file. Note that
5861: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5862: may be “<span class="quote">yes</span>” even if
5863: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5864: is “<span class="quote">no</span>” because we may make the determination
5865: that the built-in version of the software is similar enough to
5866: be used as a replacement.</p>
5867: <p>The last section is guarded by
5868: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5869: and includes code that uses the value of
5870: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5871: set in the previous section. This typically includes, e.g.,
5872: adding additional dependency restrictions and listing additional
5873: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5874: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5875: </div>
5876: <div class="sect2" lang="en">
5877: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5878: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5879: <p>When building packages, it's possible to choose whether to set
5880: a global preference for using either the built-in (native)
5881: version or the pkgsrc version of software to satisfy a
5882: dependency. This is controlled by setting
5883: <code class="varname">PREFER_PKGSRC</code> and
5884: <code class="varname">PREFER_NATIVE</code>. These variables take values
5885: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5886: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5887: use the pkgsrc versions of software, while
5888: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5889: built-in versions. Preferences are determined by the most
5890: specific instance of the package in either
5891: <code class="varname">PREFER_PKGSRC</code> or
5892: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5893: in neither or in both variables, then
5894: <code class="varname">PREFER_PKGSRC</code> has precedence over
5895: <code class="varname">PREFER_NATIVE</code>. For example, to require
5896: using pkgsrc versions of software for all but the most basic
5897: bits on a NetBSD system, you can set:</p>
5898: <pre class="programlisting">
5899: PREFER_PKGSRC= yes
5900: PREFER_NATIVE= getopt skey tcp_wrappers
5901: </pre>
5902: <p>A package <span class="emphasis"><em>must</em></span> have a
5903: <code class="filename">builtin.mk</code>
5904: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5905: otherwise it is simply ignored in that list.</p>
5906: </div>
5907: </div>
5908: </div>
5909: <div class="chapter" lang="en">
5910: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5911: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5912: <div class="toc">
5913: <p><b>Table of Contents</b></p>
5914: <dl>
1.6 rillig 5915: <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 5916: <dd><dl>
1.6 rillig 5917: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5918: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5919: </dl></dd>
1.6 rillig 5920: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5921: <dd><dl>
1.6 rillig 5922: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5923: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5924: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5925: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5926: </dl></dd>
5927: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5928: <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>
5929: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5930: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5931: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5932: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5933: <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 5934: </dl>
5935: </div>
5936: <p>This chapter describes the framework known as
5937: <code class="literal">pkginstall</code>, whose key features are:</p>
5938: <div class="itemizedlist"><ul type="disc">
5939: <li><p>Generic installation and manipulation of directories and files
5940: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5941: <li><p>Automatic handling of configuration files during installation,
5942: provided that packages are correctly designed.</p></li>
5943: <li><p>Generation and installation of system startup scripts.</p></li>
5944: <li><p>Registration of system users and groups.</p></li>
5945: <li><p>Registration of system shells.</p></li>
5946: <li><p>Automatic updating of fonts databases.</p></li>
5947: </ul></div>
5948: <p>The following sections inspect each of the above points in detail.</p>
5949: <p>You may be thinking that many of the things described here could be
5950: easily done with simple code in the package's post-installation target
5951: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5952: as the code in them is only executed when building from source. Machines
5953: using binary packages could not benefit from it at all (as the code itself
5954: could be unavailable). Therefore, the only way to achieve any of the items
5955: described above is by means of the installation scripts, which are
5956: automatically generated by pkginstall.</p>
5957: <div class="sect1" lang="en">
5958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5959: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5960: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5961: of files and directories that belong to a package. The names used in it
5962: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5963: which means that it cannot register files outside this directory (absolute
5964: path names are not allowed). Despite this restriction, some packages need
5965: to install files outside this location; e.g., under
5966: <code class="filename">${VARBASE}</code> or
5967: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5968: is to create such files during installation time by using
5969: installation scripts.</p>
5970: <p>The generic installation scripts are shell scripts that can
5971: contain arbitrary code. The list of scripts to execute is taken from
5972: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5973: <code class="filename">INSTALL</code>. A similar variable exists for package
5974: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5975: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5976: commands, so they have the potential to create and manage files
5977: anywhere in the file system.</p>
5978: <p>Using these general installation files is not recommended, but
5979: may be needed in some special cases. One reason for avoiding them is
5980: that the user has to trust the packager that there is no unwanted or
5981: simply erroneous code included in the installation script. Also,
5982: previously there were many similar scripts for the same functionality,
5983: and fixing a common error involved finding and changing all of
5984: them.</p>
5985: <p>The pkginstall framework offers another, standardized way. It
5986: provides generic scripts to abstract the manipulation of such files
5987: and directories based on variables set in the package's
5988: <code class="filename">Makefile</code>. The rest of this section describes
5989: these variables.</p>
5990: <div class="sect2" lang="en">
5991: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5992: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 5993: <p>The following variables can be set to request the creation of
5994: directories anywhere in the file system:</p>
5995: <div class="itemizedlist"><ul type="disc">
5996: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5997: contain a list of directories that should be created and should attempt
5998: to be destroyed by the installation scripts. The difference between
5999: the two is that the latter prompts the administrator to remove any
6000: directories that may be left after deinstallation (because they were
6001: not empty), while the former does not.</p></li>
6002: <li>
6003: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6004: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6005: which directories should be created and should attempt to be destroyed
6006: by the installation scripts. Each tuple holds the following values,
6007: separated by spaces: the directory name, its owner, its group and its
6008: numerical mode. For example:</p>
6009: <pre class="programlisting">
6010: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
6011: </pre>
6012: <p>The difference between the two is exactly the same as their
6013: non-<code class="varname">PERMS</code> counterparts.</p>
6014: </li>
6015: </ul></div>
6016: </div>
6017: <div class="sect2" lang="en">
6018: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6019: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 6020: <p>Creating non-empty files outside the installation prefix is tricky
6021: because the <code class="filename">PLIST</code> forces all files to be inside it.
6022: To overcome this problem, the only solution is to extract the file in the
6023: known place (i.e., inside the installation prefix) and copy it to the
6024: appropriate location during installation (done by the installation scripts
6025: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6026: file</em></span> in the following paragraphs, which describe the variables
6027: that can be used to automatically and consistently handle files outside the
6028: installation prefix:</p>
6029: <div class="itemizedlist"><ul type="disc">
6030: <li>
6031: <p><code class="varname">CONF_FILES</code> and
6032: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
6033: During installation time, the master file is copied to the target one
6034: if and only if the latter does not exist. Upon deinstallation, the
6035: target file is removed provided that it was not modified by the
6036: installation.</p>
6037: <p>The difference between the two is that the latter prompts the
6038: administrator to remove any files that may be left after
6039: deinstallation (because they were not empty), while the former does
6040: not.</p>
6041: </li>
6042: <li>
6043: <p><code class="varname">CONF_FILES_PERMS</code> and
6044: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
6045: files as well as their target locations. For each of them, it also
6046: specifies their owner, their group and their numeric permissions, in
6047: this order. For example:</p>
6048: <pre class="programlisting">
6049: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
6050: </pre>
6051: <p>The difference between the two is exactly the same as their
6052: non-<code class="varname">PERMS</code> counterparts.</p>
6053: </li>
6054: </ul></div>
6055: </div>
6056: </div>
6057: <div class="sect1" lang="en">
6058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6059: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 6060: <p>Configuration files are special in the sense that they are installed
6061: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6062: need special treatment during installation (most of which is automated by
6063: pkginstall). The main concept you must bear in mind is that files marked
6064: as configuration files are automatically copied to the right place (somewhere
6065: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6066: and only if</em></span> they didn't exist before. Similarly, they will not
6067: be removed if they have local modifications. This ensures that
6068: administrators never lose any custom changes they may have made.</p>
6069: <div class="sect2" lang="en">
6070: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6071: <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 6072: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6073: specifies where configuration files shall be installed. Its contents are
6074: set based upon the following variables:</p>
6075: <div class="itemizedlist"><ul type="disc">
6076: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
6077: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
6078: be overridden by the user to point to his preferred location (e.g.,
6079: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
6080: Packages must not use it directly.</p></li>
6081: <li>
6082: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6083: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6084: for the package being built shall be installed. The definition of this
6085: variable only makes sense in the package's
6086: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
6087: <p>As an example, consider the Apache package,
6088: <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
6089: configuration files under the
6090: <code class="filename">httpd/</code> subdirectory of
6091: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6092: Makefile.</p>
6093: </li>
6094: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6095: variable that holds this package's configuration directory (if
6096: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6097: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6098: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6099: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6100: directory where the configuration files for the package identified by
6101: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6102: </ul></div>
6103: <p>Based on the above variables, pkginstall determines the value of
6104: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6105: variable that can be used within a package to refer to its configuration
6106: directory. The algorithm used to set its value is basically the
6107: following:</p>
6108: <div class="orderedlist"><ol type="1">
6109: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6110: its value is used.</p></li>
6111: <li><p>If the previous variable is not defined but
6112: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
6113: <code class="filename">Makefile</code>, the resulting value is
6114: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
6115: <li><p>Otherwise, it is set to
6116: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
6117: </ol></div>
6118: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.6 rillig 6119: 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 6120: </div>
6121: <div class="sect2" lang="en">
6122: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6123: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 6124: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6125: known place, you need to teach each package where it shall install its
6126: files. In some cases you will have to patch the package Makefiles to
6127: achieve it. If you are lucky, though, it may be as easy as passing an
6128: extra flag to the configuration script; this is the case of GNU Autoconf-
6129: generated files:</p>
6130: <pre class="programlisting">
6131: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
6132: </pre>
6133: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6134: for</em></span> its configuration files, not where they will be originally
6135: installed (although the difference is never explicit,
6136: unfortunately).</p>
6137: </div>
6138: <div class="sect2" lang="en">
6139: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6140: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 6141: <p>As said before, pkginstall automatically handles configuration files.
6142: This means that <span class="strong"><strong>the packages themselves must not
6143: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6144: directly</strong></span>. Bad news is that many software installation scripts
6145: will, out of the box, mess with the contents of that directory. So what is
6146: the correct procedure to fix this issue?</p>
6147: <p>You must teach the package (usually by manually patching it) to
6148: install any configuration files under the examples hierarchy,
6149: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6150: <code class="filename">PLIST</code> registers them and the administrator always
6151: has the original copies available.</p>
6152: <p>Once the required configuration files are in place (i.e., under the
6153: examples hierarchy), the pkginstall framework can use them as master copies
6154: during the package installation to update what is in
6155: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
6156: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.6 rillig 6157: 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 6158: about their syntax and their purpose. Here is an example, taken from the
6159: <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>
6160: <pre class="programlisting">
6161: EGDIR= ${PREFIX}/share/doc/mutt/samples
6162: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6163: </pre>
6164: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6165: package and has no meaning outside it.</p>
6166: </div>
6167: <div class="sect2" lang="en">
6168: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6169: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 6170: <p>The automatic copying of config files can be toggled by setting the
6171: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6172: installation.</p>
6173: </div>
6174: </div>
6175: <div class="sect1" lang="en">
6176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6177: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 6178: <p>System startup scripts are special files because they must be
6179: installed in a place known by the underlying OS, usually outside the
1.6 rillig 6180: 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 6181: can be used. However, pkginstall provides a special mechanism to handle
6182: these files.</p>
6183: <p>In order to provide system startup scripts, the package has
6184: to:</p>
6185: <div class="orderedlist"><ol type="1">
6186: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
6187: the <code class="literal">.sh</code> suffix appended. Considering the
6188: <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
6189: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
6190: <li>
6191: <p>Tell pkginstall to handle it, appending the name of the script,
6192: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6193: Continuing the previous example:</p>
6194: <pre class="programlisting">
6195: RCD_SCRIPTS+= cupsd
6196: </pre>
6197: </li>
6198: </ol></div>
6199: <p>Once this is done, pkginstall will do the following steps for each
6200: script in an automated fashion:</p>
6201: <div class="orderedlist"><ol type="1">
6202: <li><p>Process the file found in the files directory applying all the
6203: substitutions described in the <code class="filename">FILES_SUBST</code>
6204: variable.</p></li>
6205: <li><p>Copy the script from the files directory to the examples
6206: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
6207: that this master file must be explicitly registered in the
6208: <code class="filename">PLIST</code>.</p></li>
6209: <li><p>Add code to the installation scripts to copy the startup script
6210: from the examples hierarchy into the system-wide startup scripts
6211: directory.</p></li>
6212: </ol></div>
6213: <div class="sect2" lang="en">
6214: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6215: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 6216: <p>The automatic copying of config files can be toggled by setting the
6217: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6218: installation. Note that the scripts will be always copied inside the
6219: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6220: matter what the value of this variable is.</p>
6221: </div>
6222: </div>
6223: <div class="sect1" lang="en">
6224: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6225: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 6226: <p>If a package needs to create special users and/or groups during
6227: installation, it can do so by using the pkginstall framework.</p>
6228: <p>Users can be created by adding entries to the
6229: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6230: syntax:</p>
6231: <pre class="programlisting">
6232: user:group
6233: </pre>
6234: <p>Further specification of user details may be done by setting
6235: per-user variables.
6236: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6237: numeric UID for the user.
6238: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6239: user's description or comment.
6240: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6241: user's home directory, and defaults to
6242: <code class="filename">/nonexistent</code> if not specified.
6243: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6244: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6245: not specified.</p>
6246: <p>Similarly, groups can be created by adding entries to the
6247: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6248: <pre class="programlisting">
6249: group
6250: </pre>
6251: <p>The numeric GID of the group may be set by defining
6252: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6253: <p>If a package needs to create the users and groups at an earlier
6254: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6255: either <code class="literal">configure</code> or <code class="literal">build</code> to
6256: indicate the phase before which the users and groups are created. In
6257: this case, the numeric UIDs and GIDs of the created users and groups
6258: are automatically hardcoded into the final installation scripts.</p>
6259: </div>
6260: <div class="sect1" lang="en">
6261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6262: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 6263: <p>Packages that install system shells should register them in the shell
6264: database, <code class="filename">/etc/shells</code>, to make things easier to the
6265: administrator. This must be done from the installation scripts to keep
6266: binary packages working on any system. pkginstall provides an easy way to
6267: accomplish this task.</p>
6268: <p>When a package provides a shell interpreter, it has to set the
6269: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6270: add some hooks to the installation scripts to handle it. Consider the
6271: 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>
6272: <pre class="programlisting">
6273: PKG_SHELL= ${PREFIX}/bin/zsh
6274: </pre>
6275: <div class="sect2" lang="en">
6276: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6277: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 6278: <p>The automatic registration of shell interpreters can be disabled by
6279: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6280: environment variable to <code class="literal">NO</code>.</p>
6281: </div>
6282: </div>
6283: <div class="sect1" lang="en">
6284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6285: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 6286: <p>Packages that install X11 fonts should update the database files
6287: that index the fonts within each fonts directory. This can easily be
6288: accomplished within the pkginstall framework.</p>
6289: <p>When a package installs X11 fonts, it must list the directories in
6290: which fonts are installed in the
6291: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6292: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6293: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6294: installation scripts to run the appropriate commands to update the fonts
6295: database files within each of those directories. For convenience, if the
6296: directory path is relative, it is taken to be relative to the package's
6297: 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>
6298: <pre class="programlisting">
6299: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6300: </pre>
6301: <div class="sect2" lang="en">
6302: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6303: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6304: <p>The automatic update of fonts databases can be disabled by
6305: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6306: environment variable to <code class="literal">NO</code>.</p>
6307: </div>
6308: </div>
6309: </div>
6310: <div class="chapter" lang="en">
6311: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6312: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6313: <div class="toc">
6314: <p><b>Table of Contents</b></p>
6315: <dl>
1.6 rillig 6316: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
6317: <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>
6318: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 ! rillig 6319: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6320: </dl>
6321: </div>
6322: <p>Many packages have the ability to be built to support different
6323: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6324: in pkgsrc that provides generic handling of those options that
6325: determine different ways in which the packages can be built. It's
6326: possible for the user to specify exactly which sets of options will be
6327: built into a package or to allow a set of global default options
6328: apply.</p>
1.7 ! rillig 6329: <p>There are two broad classes of behaviors that one might want to
! 6330: control via options. One is whether some particular feature is
! 6331: enabled in a program that will be built anyway, often by including or
! 6332: not including a dependency on some other package. The other is
! 6333: whether or not an additional program will be built as part of the
! 6334: package. Generally, it is better to make a split package for such
! 6335: additional programs instead of using options, because it enables
! 6336: binary packages to be built which can then be added separately. For
! 6337: example, the foo package might have minimal dependencies (those
! 6338: packages without which foo doesn't make sense), and then the foo-gfoo
! 6339: package might include the GTK frontend program gfoo. This is better
! 6340: than including a gtk option to foo that adds gfoo, because either that
! 6341: option is default, in which case binary users can't get foo without
! 6342: gfoo, or not default, in which case they can't get gfoo. With split
! 6343: packages, they can install foo without having GTK, and later decide to
! 6344: install gfoo (pulling in GTK at that time). This is an advantage to
! 6345: source users too, avoiding the need for rebuilds.</p>
! 6346: <p>Plugins with widely varying dependencies should usually be split
! 6347: instead of options.</p>
! 6348: <p>It is often more work to maintain split packages, especially if
! 6349: the upstream package does not support this. The decision of split
! 6350: vs. option should be made based on the likelihood that users will want
! 6351: or object to the various pieces, the size of the dependencies that are
! 6352: included, and the amount of work.</p>
! 6353: <p>A further consideration is licensing. Non-free parts, or parts
! 6354: that depend on non-free dependencies (especially plugins) should
! 6355: almost always be split if feasible.</p>
1.1 dsieger 6356: <div class="sect1" lang="en">
6357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6358: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6359: <p>Global default options are listed in
6360: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6361: that should be built into every package if that option is supported.
1.4 rillig 6362: This variable should be set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6363: </div>
6364: <div class="sect1" lang="en">
6365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6366: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6367: </h2></div></div></div>
6368: <p>The following example shows how
6369: <code class="filename">bsd.options.mk</code> should be used
6370: by the hypothetical ``wibble'' package, either in the package
6371: <code class="filename">Makefile</code>, or in a file,
6372: e.g. <code class="filename">options.mk</code>, that is included by the
6373: main package <code class="filename">Makefile</code>.</p>
6374: <pre class="programlisting">
6375: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6376: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6377: PKG_OPTIONS_OPTIONAL_GROUPS= database
6378: PKG_OPTIONS_GROUP.database= mysql pgsql
6379: PKG_SUGGESTED_OPTIONS= wibble-foo
6380: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6381: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6382:
6383: .include "../../mk/bsd.prefs.mk"
6384:
6385: # this package was previously named wibble2
6386: .if defined(PKG_OPTIONS.wibble2)
6387: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6388: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6389: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6390: .endif
6391:
6392: .include "../../mk/bsd.options.mk"
6393:
6394: # Package-specific option-handling
6395:
6396: ###
6397: ### FOO support
6398: ###
6399: .if !empty(PKG_OPTIONS:Mwibble-foo)
6400: CONFIGURE_ARGS+= --enable-foo
6401: .endif
6402:
6403: ###
6404: ### LDAP support
6405: ###
6406: .if !empty(PKG_OPTIONS:Mldap)
6407: . include "../../databases/openldap-client/buildlink3.mk"
6408: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6409: .endif
6410:
6411: ###
6412: ### database support
6413: ###
6414: .if !empty(PKG_OPTIONS:Mmysql)
6415: . include "../../mk/mysql.buildlink3.mk"
6416: .endif
6417: .if !empty(PKG_OPTIONS:Mpgsql)
6418: . include "../../mk/pgsql.buildlink3.mk"
6419: .endif
6420: </pre>
6421: <p>The first section contains the information about which build
6422: options are supported by the package, and any default options settings
6423: if needed.</p>
6424: <div class="orderedlist"><ol type="1">
6425: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6426: <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
6427: options. It should be set to
6428: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6429: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6430: at the point where the options are processed.</p></li>
6431: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6432: build options supported by the package.</p></li>
6433: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6434: list of names of groups of mutually exclusive options. The options in
6435: each group are listed in
6436: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6437: The most specific setting of any option from the group takes
6438: precedence over all other options in the group. Options from the
6439: groups will be automatically added to
6440: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6441: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6442: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6443: packages will fail if no option from the group is
6444: selected.</p></li>
6445: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6446: of names of sets of options. At least one option from each set must
6447: be selected. The options in each set are listed in
6448: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6449: Options from the sets will be automatically added to
6450: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6451: fail if no option from the set is selected.</p></li>
6452: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6453: build options which are enabled by default.</p></li>
6454: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6455: of
6456: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.4 rillig 6457: pairs that map legacy <a href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6458: their option counterparts. Pairs should be added with
6459: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6460: warning will be issued if the user uses a legacy
6461: variable.</p></li>
6462: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6463: of
6464: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6465: pairs that map options that have been renamed to their new
6466: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6467: the listing of global legacy options. A warning will be issued if
6468: the user uses a legacy option.</p></li>
6469: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6470: options implied by deprecated variables used. This can be used for
6471: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6472: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6473: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6474: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6475: a list of warnings about deprecated variables or options used, and
6476: what to use instead.</p></li>
6477: </ol></div>
6478: <p>A package should never modify
6479: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6480: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6481: To suggest a default set of options, use
6482: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6483: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6484: including <code class="filename">bsd.options.mk</code>. If none of
6485: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6486: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6487: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6488: happen with platform-specific options if none of them is supported on
6489: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6490: empty list and the package is otherwise treated as not using the
6491: options framework.</p>
6492: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6493: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6494: build options, properly filtered to remove unsupported and duplicate
6495: options.</p>
6496: <p>The remaining sections contain the logic that is specific to
6497: each option. The correct way to check for an option is to check
6498: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6499: <pre class="programlisting">
6500: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6501: </pre>
6502: </div>
6503: <div class="sect1" lang="en">
6504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6505: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6506: <p>Options that enable similar features in different packages (like
6507: optional support for a library) should use a common name in all
6508: packages that support it (like the name of the library). If another
6509: package already has an option with the same meaning, use the same
6510: name.</p>
6511: <p>Options that enable features specific to one package, where it's
6512: unlikely that another (unrelated) package has the same (or a similar)
6513: optional feature, should use a name prefixed with
6514: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6515: <p>If a group of related packages share an optional feature
6516: specific to that group, prefix it with the name of the
6517: “<span class="quote">main</span>” package
6518: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6519: <p>For new options, add a line to
6520: <code class="filename">mk/defaults/options.description</code>. Lines have two
6521: fields, separated by tab. The first field is the option name, the
6522: second its description. The description should be a whole sentence
6523: (starting with an uppercase letter and ending with a period) that
6524: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6525: support.</span>” The file is sorted by option names.</p>
6526: </div>
1.7 ! rillig 6527: <div class="sect1" lang="en">
! 6528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
! 6529: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
! 6530: <p>When writing <a href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
! 6531: different dependencies based on the options with which the package was
! 6532: built. For querying these options, the file
! 6533: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
! 6534: typical example looks like this:</p>
! 6535: <pre class="programlisting">
! 6536: pkgbase := libpurple
! 6537: .include "../../mk/pkg-build-options.mk"
! 6538:
! 6539: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
! 6540: ...
! 6541: .endif
! 6542: </pre>
! 6543: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
! 6544: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
! 6545: options of the libpurple package, which can then be queried like
! 6546: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
! 6547: file. See the file <code class="filename">pkg-build-options.mk</code> for more
! 6548: details.</p>
! 6549: </div>
1.1 dsieger 6550: </div>
6551: <div class="chapter" lang="en">
6552: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6553: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6554: <div class="toc">
6555: <p><b>Table of Contents</b></p>
6556: <dl>
1.6 rillig 6557: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6558: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6559: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6560: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
6561: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6562: <dd><dl>
6563: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6564: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6565: </dl></dd>
6566: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6567: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6568: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6569: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6570: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6571: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6572: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6573: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6574: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6575: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6576: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6577: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6578: </dl>
6579: </div>
6580: <div class="sect1" lang="en">
6581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6582: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6583: <p>This chapter gives a detailed description on how a package is
6584: built. Building a package is separated into different
6585: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6586: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6587: described in the following sections. Each phase is splitted into
6588: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6589: containing phase, prefixed by one of <code class="varname">pre-</code>,
6590: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6591: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6592: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6593: <p>Never override the regular targets (like
6594: <code class="varname">fetch</code>), if you have to, override the
6595: <code class="varname">do-*</code> ones instead.</p>
6596: <p>The basic steps for building a program are always the same. First
6597: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6598: the local system and then extracted. After any pkgsrc-specific patches
6599: to compile properly are applied, the software can be configured, then
6600: built (usually by compiling), and finally the generated binaries, etc.
6601: can be put into place on the system.</p>
6602: <p>To get more details about what is happening at each step,
6603: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6604: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6605: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6606: </div>
6607: <div class="sect1" lang="en">
6608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6609: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6610: <p>Before outlining the process performed by the NetBSD package system in
6611: the next section, here's a brief discussion on where programs are
6612: installed, and which variables influence this.</p>
6613: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6614: where all files of the final program shall be installed. It is
6615: usually set to <code class="varname">LOCALBASE</code>
6616: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6617: for pkgs in the <code class="filename">cross</code> category. The value of
6618: <code class="varname">PREFIX</code> needs to be put
6619: into the various places in the program's source where paths to
1.6 rillig 6620: 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 6621: <p>When choosing which of these variables to use,
6622: follow the following rules:</p>
6623: <div class="itemizedlist"><ul type="disc">
6624: <li><p><code class="varname">PREFIX</code> always points to the location
6625: where the current pkg will be installed. When referring to a
6626: pkg's own installation path, use
6627: “<span class="quote">${PREFIX}</span>”.</p></li>
6628: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6629: are installed. If you need to construct a -I or -L argument
6630: to the compiler to find includes and libraries installed by
6631: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
6632: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6633: installed all packages in <code class="filename">/usr/local</code>. As
6634: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6635: administrator, this variable is a misnomer.</p></li>
6636: <li><p><code class="varname">X11BASE</code> is where the actual X11
6637: distribution (from xsrc, etc.) is installed. When looking for
6638: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6639: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6640: <li>
6641: <p>X11-based packages are special in that they may be
6642: installed in either <code class="varname">X11BASE</code> or
6643: <code class="varname">LOCALBASE</code>.</p>
6644: <p>Usually, X11 packages should be installed under
6645: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6646: will need to include
6647: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6648: request the presence of X11 and to get the right compilation
6649: flags.</p>
6650: <p>Even though, there are some packages that cannot be installed
6651: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6652: files. These packages are special and they must be placed under
6653: <code class="varname">X11BASE</code>. To accomplish this, set either
6654: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6655: your package.</p>
6656: <p>Some notes: If you need
6657: to find includes or libraries installed by a pkg that has
6658: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6659: its pkg <code class="filename">Makefile</code>, you need to look in
6660: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6661: <code class="filename">${LOCALBASE}</code>. To force installation of
6662: all X11 packages in <code class="varname">LOCALBASE</code>, the
6663: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6664: is enabled by default.</p>
6665: </li>
6666: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6667: the installed location of an X11
6668: package. <code class="varname">X11PREFIX</code> will be set to
6669: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6670: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6671: installed.</p></li>
6672: <li>
6673: <p>If xpkgwedge is installed, it is possible to have some
6674: packages installed in <code class="varname">X11BASE</code> and some in
6675: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6676: installed package, the <code class="varname">EVAL_PREFIX</code>
6677: definition can be used. It takes pairs in the format
6678: “<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>
6679: variable <code class="varname">DIRNAME</code> will be set to the prefix
6680: of the installed package <package>, or
6681: “<span class="quote">${X11PREFIX}</span>” if the package is not
6682: installed.</p>
6683: <p>This is best illustrated by example.</p>
6684: <p>The following lines are taken from
6685: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6686: <pre class="programlisting">
6687: EVAL_PREFIX+= GTKDIR=gtk+
6688: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6689: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6690: CONFIGURE_ARGS+= --enable-multibyte
6691: </pre>
6692: <p>Specific defaults can be defined for the packages
6693: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6694: definition of the form:</p>
6695: <pre class="programlisting">
6696: GTKDIR_DEFAULT= ${LOCALBASE}
6697: </pre>
6698: <p>where <code class="varname">GTKDIR</code> corresponds
6699: to the first definition in
6700: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6701: </li>
6702: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
6703: 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
6704: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6705: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6706: </ul></div>
6707: </div>
6708: <div class="sect1" lang="en">
6709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6710: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.1 dsieger 6711: <p>When building a package, a number of directories is used to store
6712: source files, temporary files, pkgsrc-internal files, and so on. These
6713: directories are explained here.</p>
6714: <p>Some of the directory variables contain relative pathnames. There
6715: are two common base directories for these relative directories:
6716: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6717: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6718: inside the package itself.</p>
6719: <div class="variablelist"><dl>
6720: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6721: <dd><p>This is an absolute pathname that points to the pkgsrc
6722: root directory. Generally, you don't need
6723: it.</p></dd>
6724: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6725: <dd><p>This is an absolute pathname that points to the
6726: current package.</p></dd>
6727: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6728: <dd><p>This is a pathname relative to
6729: <code class="varname">PKGSRCDIR</code> that points to the current
6730: package.</p></dd>
6731: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6732: <dd><p>This is an absolute pathname pointing to the directory
6733: where all work takes place. The distfiles are extracted to this
6734: directory. It also contains temporary directories and log files used by
6735: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6736: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6737: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6738: <dd><p>This is an absolute pathname pointing to the directory
6739: where the distfiles are extracted. It is usually a direct subdirectory
6740: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6741: that isn't hidden. This variable may be changed by a package
6742: <code class="filename">Makefile</code>.</p></dd>
6743: </dl></div>
6744: </div>
6745: <div class="sect1" lang="en">
6746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6747: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.1 dsieger 6748: <p>You can run a particular phase by typing <span><strong class="command">make
6749: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6750: phase. This will automatically run all phases that are required for this
6751: phase. The default phase is <code class="varname">build</code>, that is, when you
6752: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6753: the package will be built, but not installed.</p>
6754: </div>
6755: <div class="sect1" lang="en">
6756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6757: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6758: <p>The first step in building a package is to fetch the
6759: distribution files (distfiles) from the sites that are providing
6760: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6761: phase.</p>
6762: <div class="sect2" lang="en">
6763: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6764: <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 6765: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6766: defines all URLs from where the distfile, whose name is
6767: derived from the <code class="varname">DISTNAME</code> variable, is
6768: fetched. The more complicated cases are described
6769: below.</p>
6770: <p>The variable <code class="varname">DISTFILES</code> specifies
6771: the list of distfiles that have to be fetched. Its value
6772: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6773: so that most packages don't need to define it at all.
6774: <code class="varname">EXTRACT_SUFX</code> is
6775: <code class="literal">.tar.gz</code> by default, but can be changed
6776: freely. Note that if your package requires additional
6777: distfiles to the default one, you cannot just append the
6778: additional filenames using the <code class="literal">+=</code>
6779: operator, but you have write for example:</p>
6780: <pre class="programlisting">
6781: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6782: </pre>
6783: <p>Each distfile is fetched from a list of sites, usually
6784: <code class="varname">MASTER_SITES</code>. If the package has multiple
6785: <code class="varname">DISTFILES</code> or multiple
6786: <code class="varname">PATCHFILES</code> from different sites, you can
6787: set
6788: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6789: to the list of URLs where the file
6790: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6791: (including the suffix) can be found.</p>
6792: <pre class="programlisting">
6793: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6794: DISTFILES+= foo-file.tar.gz
6795: SITES.foo-file.tar.gz= \
6796: http://www.somewhere.com/somehow/ \
6797: http://www.somewhereelse.com/mirror/somehow/
6798: </pre>
6799: <p>When actually fetching the distfiles, each item from
6800: <code class="varname">MASTER_SITES</code> or
6801: <code class="varname">SITES.*</code> gets the name of each distfile
6802: appended to it, without an intermediate slash. Therefore,
6803: all site values have to end with a slash or other separator
6804: character. This allows for example to set
6805: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6806: that gets the name of the distfile as a parameter. In this
6807: case, the definition would look like:</p>
6808: <pre class="programlisting">
6809: MASTER_SITES= http://www.example.com/download.cgi?file=
6810: </pre>
6811: <p>There are some predefined values for
6812: <code class="varname">MASTER_SITES</code>, which can be used in
6813: packages. The names of the variables should speak for
6814: themselves.</p>
6815: <pre class="programlisting">
6816: ${MASTER_SITE_APACHE}
6817: ${MASTER_SITE_BACKUP}
6818: ${MASTER_SITE_CYGWIN}
6819: ${MASTER_SITE_DEBIAN}
6820: ${MASTER_SITE_FREEBSD}
6821: ${MASTER_SITE_FREEBSD_LOCAL}
6822: ${MASTER_SITE_GENTOO}
6823: ${MASTER_SITE_GNOME}
6824: ${MASTER_SITE_GNU}
6825: ${MASTER_SITE_GNUSTEP}
6826: ${MASTER_SITE_IFARCHIVE}
6827: ${MASTER_SITE_KDE}
6828: ${MASTER_SITE_MOZILLA}
6829: ${MASTER_SITE_MYSQL}
6830: ${MASTER_SITE_OPENOFFICE}
6831: ${MASTER_SITE_PERL_CPAN}
6832: ${MASTER_SITE_PGSQL}
6833: ${MASTER_SITE_R_CRAN}
6834: ${MASTER_SITE_SOURCEFORGE}
6835: ${MASTER_SITE_SOURCEFORGE_JP}
6836: ${MASTER_SITE_SUNSITE}
6837: ${MASTER_SITE_SUSE}
6838: ${MASTER_SITE_TEX_CTAN}
6839: ${MASTER_SITE_XCONTRIB}
6840: ${MASTER_SITE_XEMACS}
6841: </pre>
6842: <p>Some explanations for the less self-explaining ones:
6843: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
6844: 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
6845: 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>
6846: <p>If you choose one of these predefined sites, you may
6847: want to specify a subdirectory of that site. Since these
6848: macros may expand to more than one actual site, you
6849: <span class="emphasis"><em>must</em></span> use the following construct to
6850: specify a subdirectory:</p>
6851: <pre class="programlisting">
6852: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6853: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6854: </pre>
6855: <p>Note the trailing slash after the subdirectory
6856: name.</p>
6857: </div>
6858: <div class="sect2" lang="en">
6859: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6860: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6861: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6862: all the distfiles exist in a local directory
6863: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6864: user). If the files do not exist, they are fetched using
6865: commands of the form</p>
6866: <pre class="programlisting">
6867: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6868: </pre>
6869: <p>where <code class="literal">${site}</code> varies through
6870: several possibilities in turn: first,
6871: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6872: sites specified in either <code class="varname">SITES.file</code> if
6873: defined, else <code class="varname">MASTER_SITES</code> or
6874: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6875: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6876: all except the first and the last can be optionally sorted
6877: by the user, via setting either
6878: <code class="varname">MASTER_SORT_RANDOM</code>, and
6879: <code class="varname">MASTER_SORT_AWK</code> or
6880: <code class="varname">MASTER_SORT_REGEX</code>.</p>
6881: <p>The distfiles mirror run by the NetBSD Foundation uses the
6882: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6883: distfiles, if they are freely distributable. Packages setting
6884: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6885: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6886: mirrored.</p>
6887: </div>
6888: </div>
6889: <div class="sect1" lang="en">
6890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6891: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6892: <p>After the distfile(s) are fetched, their checksum is
6893: generated and compared with the checksums stored in the
6894: distinfo file. If the checksums don't match, the build is
6895: aborted. This is to ensure the same distfile is used for
6896: building, and that the distfile wasn't changed, e.g. by some
6897: malign force, deliberately changed distfiles on the master
6898: distribution site or network lossage.</p>
6899: </div>
6900: <div class="sect1" lang="en">
6901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6902: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6903: <p>When the distfiles are present on the local system, they
6904: need to be extracted, as they usually come in the form of some
6905: compressed archive format.</p>
6906: <p>By default, all <code class="varname">DISTFILES</code> are
6907: extracted. If you only need some of them, you can set the
6908: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6909: files.</p>
6910: <p>Extracting the files is usually done by a little
6911: program, <code class="filename">mk/extract/extract</code>, which
6912: already knows how to extract various archive formats, so most
6913: likely you will not need to change anything here. But if you
6914: need, the following variables may help you:</p>
6915: <div class="variablelist"><dl>
6916: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6917: <dd><p>Use these variables to override the default
6918: options for an extract command, which are defined in
6919: <code class="filename">mk/extract/extract</code>.</p></dd>
6920: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6921: <dd><p>This variable can be set to
6922: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6923: default value), <code class="literal">pax</code>, or an
6924: absolute pathname pointing to the command with which tar
6925: archives should be
6926: extracted.</p></dd>
6927: </dl></div>
6928: <p>If the <code class="filename">extract</code> program doesn't
6929: serve your needs, you can also override the
6930: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6931: command used for extracting the files. This command is
6932: executed in the <code class="filename">${WRKSRC}</code>
6933: directory. During execution of this command, the shell
6934: variable <code class="varname">extract_file</code> holds the absolute
6935: pathname of the file that is going to be extracted.</p>
6936: <p>And if that still does not suffice, you can override the
6937: <code class="varname">do-extract</code> target in the package
6938: Makefile.</p>
6939: </div>
6940: <div class="sect1" lang="en">
6941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6942: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6943: <p>After extraction, all the patches named by the
6944: <code class="varname">PATCHFILES</code>, those present in the patches
6945: subdirectory of the package as well as in
6946: $LOCALPATCHES/$PKGPATH (e.g.
6947: <code class="filename">/usr/local/patches/graphics/png</code>) are
6948: applied. Patchfiles ending in <code class="filename">.Z</code> or
6949: <code class="filename">.gz</code> are uncompressed before they are
6950: applied, files ending in <code class="filename">.orig</code> or
6951: <code class="filename">.rej</code> are ignored. Any special options to
6952: <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 6953: <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 6954: <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
6955: it fail if the patches apply with some lines of fuzz. Please
6956: fix (regen) the patches so that they apply cleanly. The
6957: rationale behind this is that patches that don't apply cleanly
6958: may end up being applied in the wrong place, and cause severe
6959: harm there.</p>
6960: </div>
6961: <div class="sect1" lang="en">
6962: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6963: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6964: <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 6965: </p>
6966: </div>
6967: <div class="sect1" lang="en">
6968: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6969: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 6970: <p>This phase creates wrapper programs for the compilers and
6971: linkers. The following variables can be used to tweak the
6972: wrappers.</p>
6973: <div class="variablelist"><dl>
6974: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6975: <dd><p>The command used to print progress
6976: messages. Does nothing by default. Set to
6977: <code class="literal">${ECHO}</code> to see the progress
6978: messages.</p></dd>
6979: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6980: <dd><p>This variable can be set to
6981: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6982: depending on whether you want additional information in the
6983: wrapper log file.</p></dd>
6984: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6985: <dd><p>This variable can be set to
6986: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6987: on whether the wrapper should use its cache, which will
6988: improve the speed. The default value is
6989: <code class="literal">yes</code>, but is forced to
6990: <code class="literal">no</code> if the platform does not support
6991: it.</p></dd>
6992: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6993: <dd><p>A list of reordering commands. A reordering
6994: command has the form
6995: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6996: It ensures that that
6997: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6998: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6999: </p></dd>
7000: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
7001: <dd><p>A list of transformation commands. [TODO:
7002: investigate further]</p></dd>
7003: </dl></div>
7004: </div>
7005: <div class="sect1" lang="en">
7006: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7007: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 7008: <p>Most pieces of software need information on the header
7009: files, system calls, and library routines which are available
7010: on the platform they run on. The process of determining this
7011: information is known as configuration, and is usually
7012: automated. In most cases, a script is supplied with the
7013: distfiles, and its invocation results in generation of header
7014: files, Makefiles, etc.</p>
7015: <p>If the package contains a configure script, this can be
7016: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
7017: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
7018: script, you should set <code class="varname">GNU_CONFIGURE</code> to
7019: “<span class="quote">yes</span>” instead. What happens in the
7020: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
7021: <pre class="programlisting">
7022: .for d in ${CONFIGURE_DIRS}
7023: cd ${WRKSRC} \
7024: && cd ${d} \
7025: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
7026: .endfor
7027: </pre>
7028: <p><code class="varname">CONFIGURE_DIRS</code> (default:
7029: “<span class="quote">.</span>”) is a list of pathnames relative to
7030: <code class="varname">WRKSRC</code>. In each of these directories, the
7031: configure script is run with the environment
7032: <code class="varname">CONFIGURE_ENV</code> and arguments
7033: <code class="varname">CONFIGURE_ARGS</code>. The variables
7034: <code class="varname">CONFIGURE_ENV</code>,
7035: <code class="varname">CONFIGURE_SCRIPT</code> (default:
7036: “<span class="quote">./configure</span>”) and
7037: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
7038: package.</p>
7039: <p>If the program uses an <code class="filename">Imakefile</code>
7040: for configuration, the appropriate steps can be invoked by
7041: setting <code class="varname">USE_IMAKE</code> to
7042: “<span class="quote">yes</span>”. (If you only want the package installed in
7043: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
7044: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
7045: xmkmf's environment by adding them to the
7046: <code class="varname">SCRIPTS_ENV</code> variable.</p>
7047: <p>If there is no configure step at all, set
7048: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
7049: </div>
7050: <div class="sect1" lang="en">
7051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7052: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7053: <p>For building a package, a rough equivalent of the
7054: following code is executed.</p>
7055: <pre class="programlisting">
7056: .for d in ${BUILD_DIRS}
7057: cd ${WRKSRC} \
7058: && cd ${d} \
7059: && env ${MAKE_ENV} \
7060: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
7061: -f ${MAKE_FILE} \
7062: ${BUILD_TARGET}
7063: .endfor
7064: </pre>
7065: <p><code class="varname">BUILD_DIRS</code> (default:
7066: “<span class="quote">.</span>”) is a list of pathnames relative to
7067: <code class="varname">WRKSRC</code>. In each of these directories,
7068: <code class="varname">MAKE_PROGRAM</code> is run with the environment
7069: <code class="varname">MAKE_ENV</code> and arguments
7070: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
7071: <code class="varname">MAKE_ENV</code>,
7072: <code class="varname">BUILD_MAKE_FLAGS</code>,
7073: <code class="varname">MAKE_FILE</code> and
7074: <code class="varname">BUILD_TARGET</code> may all be changed by the
7075: package.</p>
7076: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
7077: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
7078: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
7079: default value of <code class="varname">MAKE_FILE</code> is
7080: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
7081: defaults to “<span class="quote">all</span>”.</p>
7082: <p>If there is no build step at all, set
7083: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
7084: </div>
7085: <div class="sect1" lang="en">
7086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7087: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 7088: <p>[TODO]</p>
7089: </div>
7090: <div class="sect1" lang="en">
7091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7092: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 7093: <p>Once the build stage has completed, the final step is to
7094: install the software in public directories, so users can
7095: access the programs and files.</p>
7096: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
7097: equivalent of the following code is executed. Additionally,
7098: before and after this code, much magic is performed to do
7099: consistency checks, registering the package, and so on.</p>
7100: <pre class="programlisting">
7101: .for d in ${INSTALL_DIRS}
7102: cd ${WRKSRC} \
7103: && cd ${d} \
7104: && env ${MAKE_ENV} \
7105: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7106: -f ${MAKE_FILE} \
7107: ${INSTALL_TARGET}
7108: .endfor
7109: </pre>
7110: <p>The variable's meanings are analogous to the ones in the
7111: <span class="emphasis"><em>build</em></span> phase.
7112: <code class="varname">INSTALL_DIRS</code> defaults to
7113: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7114: is “<span class="quote">install</span>” by default, plus
7115: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
7116: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7117: defined.</p>
7118: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7119: variables are useful. They are all variations of the
7120: <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
7121: permissions preset. <code class="varname">INSTALL</code> is the plain
7122: install command. The specialized variants, together with their
7123: intended use, are:</p>
7124: <div class="variablelist"><dl>
7125: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7126: <dd><p>directories that contain
7127: binaries</p></dd>
7128: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7129: <dd><p>directories that contain
7130: scripts</p></dd>
7131: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7132: <dd><p>directories that contain shared and static
7133: libraries</p></dd>
7134: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7135: <dd><p>directories that contain data
7136: files</p></dd>
7137: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7138: <dd><p>directories that contain man
7139: pages</p></dd>
7140: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7141: <dd><p>binaries that can be stripped from debugging
7142: symbols</p></dd>
7143: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7144: <dd><p>binaries that cannot be
7145: stripped</p></dd>
7146: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7147: <dd><p>game
7148: binaries</p></dd>
7149: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7150: <dd><p>shared and static
7151: libraries</p></dd>
7152: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7153: <dd><p>data files</p></dd>
7154: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7155: <dd><p>data files for
7156: games</p></dd>
7157: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7158: <dd><p>man pages</p></dd>
7159: </dl></div>
7160: <p>Some other variables are:</p>
7161: <div class="variablelist"><dl>
7162: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7163: <dd><p>A list of directories relative to
7164: <code class="varname">PREFIX</code> that are created by pkgsrc at the
7165: beginning of the <span class="emphasis"><em>install</em></span> phase.
7166: The package is supposed to create all needed directories itself
7167: before installing files to it and list all other directories here.
7168: </p></dd>
7169: </dl></div>
7170: <p>In the rare cases that a package shouldn't install anything,
7171: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7172: mostly relevant for packages in the <code class="filename">regress</code>
7173: category.</p>
7174: </div>
7175: <div class="sect1" lang="en">
7176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7177: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 7178: <p>Once the install stage has completed, a binary package of
7179: the installed files can be built. These binary packages can be
7180: used for quick installation without previous compilation, e.g. by
7181: the <span><strong class="command">make bin-install</strong></span> or by using
7182: <span><strong class="command">pkg_add</strong></span>.</p>
7183: <p>By default, the binary packages are created in
7184: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7185: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7186: one for each category in the <code class="varname">CATEGORIES</code>
7187: variable. <code class="varname">PACKAGES</code> defaults to
7188: <code class="filename">pkgsrc/packages</code>.</p>
7189: <p>If there should be no binary package, set
7190: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7191: This should only be used in rare cases, like when a package
7192: definitely is only usable on the machine where it is built and even
7193: then, a binary package can be useful.</p>
7194: </div>
7195: <div class="sect1" lang="en">
7196: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7197: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 7198: <p>Once you're finished with a package, you can clean the work
7199: directory by running <span><strong class="command">make clean</strong></span>. If you want
7200: to clean the work directories of all dependencies too, use
7201: <span><strong class="command">make clean-depends</strong></span>.</p>
7202: </div>
7203: <div class="sect1" lang="en">
7204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7205: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1 dsieger 7206: <div class="variablelist"><dl>
7207: <dt><span class="term">pre/post-*</span></dt>
7208: <dd><p>For any of the main targets described in the
7209: previous section, two auxiliary targets exist with
7210: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7211: prefix for the main target's name. These targets are
7212: invoked before and after the main target is called,
7213: allowing extra configuration or installation steps be
7214: performed from a package's Makefile, for example, which
7215: a program's configure script or install target
7216: omitted.</p></dd>
7217: <dt><span class="term">do-*</span></dt>
7218: <dd><p>Should one of the main targets do the wrong thing,
7219: and should there be no variable to fix this, you can
7220: redefine it with the do-* target. (Note that redefining
7221: the target itself instead of the do-* target is a bad
7222: idea, as the pre-* and post-* targets won't be called
7223: anymore, etc.) You will not usually need to do
7224: this.</p></dd>
7225: <dt><span class="term">reinstall</span></dt>
7226: <dd>
7227: <p>If you did a <span><strong class="command">make install</strong></span> and
7228: you noticed some file was not installed properly, you
7229: can repeat the installation with this target, which will
7230: ignore the “<span class="quote">already installed</span>” flag.</p>
7231: <p>This is the default value of
7232: <code class="varname">DEPENDS_TARGET</code> except in the case of
7233: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7234: package</strong></span>, where the defaults are
7235: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7236: respectively.</p>
7237: </dd>
7238: <dt><span class="term">deinstall</span></dt>
7239: <dd>
7240: <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
7241: current directory, effectively de-installing the
7242: package. The following variables can be used to tune the
7243: behaviour:</p>
7244: <div class="variablelist"><dl>
7245: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7246: <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>
7247: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7248: <dd><p>Remove all packages that require (depend on)
7249: the given package. This can be used to remove any
7250: packages that may have been pulled in by a given
7251: package, e.g. if <span><strong class="command">make deinstall
7252: DEINSTALLDEPENDS=1</strong></span> is done in
7253: <code class="filename">pkgsrc/x11/kde</code>, this is
7254: likely to remove whole KDE. Works by adding
7255: “<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>
7256: command line.</p></dd>
7257: </dl></div>
7258: </dd>
7259: <dt><span class="term">bin-install</span></dt>
7260: <dd><p>Install a binary package from local disk and via FTP
7261: from a list of sites (see the
7262: <code class="varname">BINPKG_SITES</code> variable), and do a
7263: <span><strong class="command">make package</strong></span> if no binary package is
7264: available anywhere. The arguments given to
7265: <span><strong class="command">pkg_add</strong></span> can be set via
7266: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7267: operation, etc.</p></dd>
7268: <dt><span class="term">update</span></dt>
7269: <dd>
7270: <p>This target causes the current package to be
7271: updated to the latest version. The package and all
7272: depending packages first get de-installed, then current
7273: versions of the corresponding packages get compiled and
7274: installed. This is similar to manually noting which
7275: packages are currently installed, then performing a
7276: series of <span><strong class="command">make deinstall</strong></span> and
7277: <span><strong class="command">make install</strong></span> (or whatever
7278: <code class="varname">UPDATE_TARGET</code> is set to) for these
7279: packages.</p>
7280: <p>You can use the “<span class="quote">update</span>” target to
7281: resume package updating in case a previous <span><strong class="command">make
7282: update</strong></span> was interrupted for some reason.
7283: However, in this case, make sure you don't call
7284: <span><strong class="command">make clean</strong></span> or otherwise remove the
7285: list of dependent packages in <code class="varname">WRKDIR</code>.
7286: Otherwise, you lose the ability to automatically update
7287: the current package along with the dependent packages
7288: you have installed.</p>
7289: <p>Resuming an interrupted <span><strong class="command">make
7290: update</strong></span> will only work as long as the package
7291: tree remains unchanged. If the source code for one of
7292: the packages to be updated has been changed, resuming
7293: <span><strong class="command">make update</strong></span> will most certainly
7294: fail!</p>
7295: <p>The following variables can be used either on the
1.4 rillig 7296: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7297: alter the behaviour of <span><strong class="command">make
7298: update</strong></span>:</p>
7299: <div class="variablelist"><dl>
7300: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7301: <dd><p>Install target to recursively use for the
7302: updated package and the dependent packages.
7303: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7304: set, “<span class="quote">install</span>” otherwise for
7305: <span><strong class="command">make update</strong></span>. Other good
7306: targets are “<span class="quote">package</span>” or
7307: “<span class="quote">bin-install</span>”. Do not set this to
7308: “<span class="quote">update</span>” or you will get stuck in an
7309: endless loop!</p></dd>
7310: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7311: <dd><p>Don't clean up after updating. Useful if
7312: you want to leave the work sources of the updated
7313: packages around for inspection or other purposes.
7314: Be sure you eventually clean up the source tree
7315: (see the “<span class="quote">clean-update</span>” target below)
7316: or you may run into troubles with old source code
7317: still lying around on your next
7318: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7319: update</strong></span>.</p></dd>
7320: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7321: <dd><p>Deinstall each package before installing
7322: (making <code class="varname">DEPENDS_TARGET</code>). This
7323: may be necessary if the
7324: “<span class="quote">clean-update</span>” target (see below) was
7325: called after interrupting a running <span><strong class="command">make
7326: update</strong></span>.</p></dd>
7327: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7328: <dd><p>Allows you to disable recursion and hardcode
7329: the target for packages. The default is
7330: “<span class="quote">update</span>” for the update target,
7331: facilitating a recursive update of prerequisite
7332: packages. Only set
7333: <code class="varname">DEPENDS_TARGET</code> if you want to
7334: disable recursive updates. Use
7335: <code class="varname">UPDATE_TARGET</code> instead to just
7336: set a specific target for each package to be
7337: installed during <span><strong class="command">make update</strong></span>
7338: (see above).</p></dd>
7339: </dl></div>
7340: </dd>
7341: <dt><span class="term">clean-update</span></dt>
7342: <dd>
7343: <p>Clean the source tree for all packages that would
7344: get updated if <span><strong class="command">make update</strong></span> was called
7345: from the current directory. This target should not be
7346: used if the current package (or any of its depending
7347: packages) have already been de-installed (e.g., after
7348: calling <span><strong class="command">make update</strong></span>) or you may lose
7349: some packages you intended to update. As a rule of
7350: thumb: only use this target <span class="emphasis"><em>before</em></span>
7351: the first time you run <span><strong class="command">make update</strong></span>
7352: and only if you have a dirty package tree (e.g., if you
7353: used <code class="varname">NOCLEAN</code>).</p>
7354: <p>If you are unsure about whether your tree is
7355: clean, you can either perform a <span><strong class="command">make
7356: clean</strong></span> at the top of the tree, or use the
7357: following sequence of commands from the directory of the
7358: package you want to update (<span class="emphasis"><em>before</em></span>
7359: running <span><strong class="command">make update</strong></span> for the first
7360: time, otherwise you lose all the packages you wanted to
7361: update!):</p>
7362: <pre class="screen">
7363: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7364: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7365: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7366: </pre>
7367: <p>The following variables can be used either on the
1.4 rillig 7368: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7369: <span><strong class="command">make clean-update</strong></span>:</p>
1.1 dsieger 7370: <div class="variablelist"><dl>
7371: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
7372: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7373: reconstruct the list of directories to update for
7374: this package. Only use this if <span><strong class="command">make
7375: update</strong></span> successfully installed all
7376: packages you wanted to update. Normally, this is
7377: done automatically on <span><strong class="command">make
7378: update</strong></span>, but may have been suppressed by
7379: the <code class="varname">NOCLEAN</code> variable (see
7380: above).</p></dd>
7381: </dl></div>
7382: </dd>
7383: <dt><span class="term">replace</span></dt>
7384: <dd>
7385: <p>Update the installation of the current package. This
7386: differs from update in that it does not replace dependent
7387: 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
7388: target to work.</p>
7389: <p><span class="emphasis"><em>Be careful when using this
7390: target!</em></span> There are no guarantees that dependent
7391: packages will still work, in particular they will most
7392: certainly break if you <span><strong class="command">make replace</strong></span> a
7393: library package whose shared library major version changed
7394: between your installed version and the new one. For this
7395: reason, this target is not officially supported and only
7396: recommended for advanced users.</p>
7397: </dd>
7398: <dt><span class="term">info</span></dt>
7399: <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
7400: package. You can use this to check which version of a
7401: package is installed.</p></dd>
7402: <dt><span class="term">index</span></dt>
7403: <dd>
7404: <p>This is a top-level command, i.e. it should be used in
7405: the <code class="filename">pkgsrc</code> directory. It creates a
7406: database of all packages in the local pkgsrc tree, including
7407: dependencies, comment, maintainer, and some other useful
7408: information. Individual entries are created by running
7409: <span><strong class="command">make describe</strong></span> in the packages'
7410: directories. This index file is saved as
7411: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7412: verbose format by running <span><strong class="command">make
7413: print-index</strong></span>. You can search in it with
7414: <span><strong class="command">make search
7415: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7416: extract a list of all packages that depend on a particular
7417: one by running <span><strong class="command">make show-deps
7418: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7419: <p>Running this command takes a very long time, some
7420: hours even on fast machines!</p>
7421: </dd>
7422: <dt><span class="term">readme</span></dt>
7423: <dd>
7424: <p>This target generates a
7425: <code class="filename">README.html</code> file, which can be
7426: 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
7427: contain references to any packages which are in the
7428: <code class="varname">PACKAGES</code> directory on the local
7429: host. The generated files can be made to refer to URLs
7430: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7431: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7432: wanted to generate <code class="filename">README.html</code>
7433: files which pointed to binary packages on the local
7434: machine, in the directory
7435: <code class="filename">/usr/packages</code>, set
7436: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7437: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7438: <code class="varname">${PACKAGES}</code> directory and its
7439: subdirectories will be searched for all the binary
7440: packages.</p>
7441: <p>The target can be run at the toplevel or in category
7442: directories, in which case it descends recursively.</p>
7443: </dd>
7444: <dt><span class="term">readme-all</span></dt>
7445: <dd><p>This is a top-level command, run it in
7446: <code class="filename">pkgsrc</code>. Use this target to create a
7447: file <code class="filename">README-all.html</code> which contains a
7448: list of all packages currently available in the NetBSD
7449: Packages Collection, together with the category they belong
7450: to and a short description. This file is compiled from the
7451: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7452: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7453: readme</strong></span>.</p></dd>
7454: <dt><span class="term">cdrom-readme</span></dt>
7455: <dd><p>This is very much the same as the
7456: “<span class="quote">readme</span>” target (see above), but is to be
7457: used when generating a pkgsrc tree to be written to a
7458: CD-ROM. This target also produces
7459: <code class="filename">README.html</code> files, and can be made
7460: to refer to URLs based on
7461: <code class="varname">CDROM_PKG_URL_HOST</code> and
7462: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7463: <dt><span class="term">show-distfiles</span></dt>
7464: <dd><p>This target shows which distfiles and patchfiles
7465: are needed to build the package
7466: (<code class="varname">ALLFILES</code>, which contains all
7467: <code class="varname">DISTFILES</code> and
7468: <code class="varname">PATCHFILES</code>, but not
7469: <code class="filename">patches/*</code>).</p></dd>
7470: <dt><span class="term">show-downlevel</span></dt>
7471: <dd><p>This target shows nothing if the package is not
7472: installed. If a version of this package is installed,
7473: but is not the version provided in this version of
7474: pkgsrc, then a warning message is displayed. This target
7475: can be used to show which of your installed packages are
7476: downlevel, and so the old versions can be deleted, and
7477: the current ones added.</p></dd>
7478: <dt><span class="term">show-pkgsrc-dir</span></dt>
7479: <dd><p>This target shows the directory in the pkgsrc
7480: hierarchy from which the package can be built and
7481: installed. This may not be the same directory as the one
7482: from which the package was installed. This target is
7483: intended to be used by people who may wish to upgrade
7484: many packages on a single host, and can be invoked from
7485: the top-level pkgsrc Makefile by using the
7486: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
7487: <dt><span class="term">show-installed-depends</span></dt>
7488: <dd><p>This target shows which installed packages match
7489: the current package's <code class="varname">DEPENDS</code>. Useful
7490: if out of date dependencies are causing build
7491: problems.</p></dd>
7492: <dt><span class="term">check-shlibs</span></dt>
7493: <dd><p>After a package is installed, check all its
7494: binaries and (on ELF platforms) shared libraries to see
7495: if they find the shared libs they need. Run by default
1.4 rillig 7496: 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 7497: <dt><span class="term">print-PLIST</span></dt>
7498: <dd>
7499: <p>After a “<span class="quote">make install</span>” from a new or
7500: upgraded pkg, this prints out an attempt to generate a
7501: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7502: -newer work/.extract_done</strong></span>. An attempt is made
7503: to care for shared libs etc., but it is
7504: <span class="emphasis"><em>strongly</em></span> recommended to review the
7505: result before putting it into
7506: <code class="filename">PLIST</code>. On upgrades, it's useful to
7507: diff the output of this command against an already
7508: existing <code class="filename">PLIST</code> file.</p>
7509: <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
7510: other methods that don't update file access times, be
7511: sure to add these files manually to your
7512: <code class="filename">PLIST</code>, as the “<span class="quote">find
7513: -newer</span>” command used by this target won't catch
7514: them!</p>
1.6 rillig 7515: <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 7516: information on this target.</p>
7517: </dd>
7518: <dt><span class="term">bulk-package</span></dt>
7519: <dd>
7520: <p>Used to do bulk builds. If an appropriate binary
7521: package already exists, no action is taken. If not, this
7522: target will compile, install and package it (and its
7523: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.6 rillig 7524: properly. See <a href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.1 dsieger 7525: After creating the binary package, the sources, the
7526: just-installed package and its required packages are
7527: removed, preserving free disk space.</p>
7528: <p><span class="emphasis"><em>Beware that this target may deinstall
7529: all packages installed on a system!</em></span></p>
7530: </dd>
7531: <dt><span class="term">bulk-install</span></dt>
7532: <dd>
7533: <p>Used during bulk-installs to install required
7534: packages. If an up-to-date binary package is available,
7535: 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,
7536: <span><strong class="command">make bulk-package</strong></span> will be executed,
7537: but the installed binary won't be removed.</p>
7538: <p>A binary package is considered
7539: “<span class="quote">up-to-date</span>” to be installed via
7540: <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>
7541: <div class="itemizedlist"><ul type="disc">
7542: <li><p>None of the package's files
7543: (<code class="filename">Makefile</code>, ...) were modified
7544: since it was built.</p></li>
7545: <li><p>None of the package's required (binary)
7546: packages were modified since it was built.</p></li>
7547: </ul></div>
7548: <p><span class="emphasis"><em>Beware that this target may deinstall
7549: all packages installed on a system!</em></span></p>
7550: </dd>
7551: </dl></div>
7552: </div>
7553: </div>
7554: <div class="chapter" lang="en">
7555: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7556: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7557: <div class="toc">
7558: <p><b>Table of Contents</b></p>
7559: <dl>
1.6 rillig 7560: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7561: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7562: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7563: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7564: </dl>
7565: </div>
7566: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7567: by pkgsrc and also for individual packages to define what commands
7568: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7569: or for later run-time of an installed packaged (such as
7570: <code class="varname">DEPENDS</code>).
7571: If the native system provides an adequate tool, then in many cases, a pkgsrc
7572: package will not be used.</p>
7573: <p>When building a package, the replacement tools are
7574: made available in a directory (as symlinks or wrapper scripts)
7575: that is early in the executable search path. Just like the buildlink
7576: system, this helps with consistent builds.</p>
7577: <p>A tool may be needed to help build a specific package. For example,
7578: perl, GNU make (gmake) or yacc may be needed.</p>
7579: <p>Also a tool may be needed, for example, because the native system's supplied
7580: tool may be inefficient for building a package with pkgsrc.
7581: For example, a package may need GNU awk, bison (instead of
7582: yacc) or a better sed.</p>
7583: <p>The tools used by a package can be listed by running
7584: <span><strong class="command">make show-tools</strong></span>.</p>
7585: <div class="sect1" lang="en">
7586: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7587: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7588: <p>The default set of tools used by pkgsrc is defined in
7589: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
7590: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7591: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7592: These can be seen by running:
7593: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7594: <p>If a package needs a specific program to build
7595: then the <code class="varname">USE_TOOLS</code> variable can be used
7596: to define the tools needed.</p>
7597: </div>
7598: <div class="sect1" lang="en">
7599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7600: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.1 dsieger 7601: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
7602: and not the native version for a build dependency.
7603: And the :run means that it is used for a
7604: run-time dependencies also (and becomes a DEPENDS).
7605: The default is a build dependency which can be set with
7606: :build. (So in this example, it is the same as gmake:build
7607: and pkg-config:build.)</p>
7608: <pre class="programlisting">
7609: USE_TOOLS+= mktemp:pkgsrc
7610: USE_TOOLS+= gmake perl:run pkg-config
7611: </pre>
7612: <p>When using the tools framework, a
7613: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7614: which contains the full path to the appropriate tool. For example,
7615: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
7616: on Linux systems.</p>
7617: <p>If you always need a pkgsrc version of the
7618: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7619: </p>
7620: </div>
7621: <div class="sect1" lang="en">
7622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7623: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7624: <p>When improving or porting pkgsrc to a new platform, have a look
7625: at (or create) the corresponding platform specific make file fragment under
7626: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7627: the name of the common tools. For example:</p>
7628: <pre class="programlisting">
7629: .if exists(/usr/bin/bzcat)
7630: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7631: .elif exists(/usr/bin/bzip2)
7632: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7633: .endif
7634:
7635: TOOLS_PLATFORM.true?= true # shell builtin
7636: </pre>
7637: </div>
7638: <div class="sect1" lang="en">
7639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7640: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.1 dsieger 7641: <div class="qandaset">
7642: <dl>
1.6 rillig 7643: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7644: </dt>
1.6 rillig 7645: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7646: tools?</a>
7647: </dt>
1.6 rillig 7648: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7649: package is using while being built? I want to know whether it
7650: uses sed or not.</a>
7651: </dt>
7652: </dl>
7653: <table border="0" summary="Q and A Set">
7654: <col align="left" width="1%">
7655: <tbody>
7656: <tr class="question">
7657: <td align="left" valign="top">
1.7 ! rillig 7658: <a name="tools.new"></a><a name="id2708188"></a><b>18.4.1.</b>
1.1 dsieger 7659: </td>
7660: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7661: </tr>
7662: <tr class="answer">
7663: <td align="left" valign="top"></td>
7664: <td align="left" valign="top"><p>TODO</p></td>
7665: </tr>
7666: <tr class="question">
7667: <td align="left" valign="top">
1.7 ! rillig 7668: <a name="tools.listall"></a><a name="id2708198"></a><b>18.4.2.</b>
1.1 dsieger 7669: </td>
7670: <td align="left" valign="top"><p>How do I get a list of all available
7671: tools?</p></td>
7672: </tr>
7673: <tr class="answer">
7674: <td align="left" valign="top"></td>
7675: <td align="left" valign="top"><p>TODO</p></td>
7676: </tr>
7677: <tr class="question">
7678: <td align="left" valign="top">
1.7 ! rillig 7679: <a name="tools.used"></a><a name="id2708209"></a><b>18.4.3.</b>
1.1 dsieger 7680: </td>
7681: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7682: package is using while being built? I want to know whether it
7683: uses sed or not.</p></td>
7684: </tr>
7685: <tr class="answer">
7686: <td align="left" valign="top"></td>
7687: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7688: to do it.)</p></td>
7689: </tr>
7690: </tbody>
7691: </table>
7692: </div>
7693: </div>
7694: </div>
7695: <div class="chapter" lang="en">
7696: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7697: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7698: <div class="toc">
7699: <p><b>Table of Contents</b></p>
7700: <dl>
1.6 rillig 7701: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7702: <dd><dl>
1.6 rillig 7703: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
7704: <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>
7705: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7706: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7707: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7708: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7709: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7710: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7711: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7712: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7713: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7714: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7715: </dl></dd>
7716: <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>
7717: <dd><dl>
7718: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7719: <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>
7720: </dl></dd>
7721: <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>
7722: <dd><dl>
7723: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7724: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7725: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7726: </dl></dd>
7727: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7728: <dd><dl>
7729: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7730: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7731: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7732: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7733: </dl></dd>
7734: <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>
7735: <dd><dl>
7736: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7737: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
7738: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7739: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7740: </dl></dd>
7741: <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>
7742: <dd><dl>
7743: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7744: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7745: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7746: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7747: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7748: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7749: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7750: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 ! rillig 7751: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6 rillig 7752: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
7753: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7754: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7755: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7756: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7757: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7758: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7759: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7760: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7761: emulation</a></span></dt>
1.6 rillig 7762: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7763: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7764: </dl></dd>
1.6 rillig 7765: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7766: </dl>
7767: </div>
7768: <div class="sect1" lang="en">
7769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7770: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1 dsieger 7771: <div class="sect2" lang="en">
7772: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7773: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7774: <p>One appealing feature of pkgsrc is that it runs on many
7775: different platforms. As a result, it is important to ensure,
7776: where possible, that packages in pkgsrc are portable. This
7777: chapter mentions some particular details you should pay
7778: attention to while working on pkgsrc.</p>
7779: </div>
7780: <div class="sect2" lang="en">
7781: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7782: <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 7783: </h3></div></div></div>
7784: <p>The pkgsrc user can configure pkgsrc by overriding several
7785: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.4 rillig 7786: which is <a href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7787: want to use those variables in the preprocessor directives of
7788: <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
7789: <code class="literal">.for</code>), you need to include the file
7790: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7791: loads the user preferences.</p>
7792: <p>But note that some variables may not be completely defined
7793: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7794: included, as they may contain references to variables that are
7795: not yet defined. In shell commands this is no problem, since
7796: variables are actually macros, which are only expanded when they
7797: are used. But in the preprocessor directives mentioned above and
7798: in dependency lines (of the form <code class="literal">target:
7799: dependencies</code>) the variables are expanded at load
7800: time.</p>
7801: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7802: <h3 class="title">Note</h3>
7803: <p>Currently there is no exhaustive list of all
7804: variables that tells you whether they can be used at load time
7805: or only at run time, but it is in preparation.</p>
7806: </div>
7807: </div>
7808: <div class="sect2" lang="en">
7809: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7810: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7811: <p>Occasionally, packages require interaction from the user,
7812: and this can be in a number of ways:</p>
7813: <div class="itemizedlist"><ul type="disc">
7814: <li><p>When fetching the distfiles, some packages require user
7815: interaction such as entering username/password or accepting a
7816: license on a web page.</p></li>
7817: <li><p>When extracting the distfiles, some packages may ask for
7818: passwords.</p></li>
7819: <li><p>help to configure the package before it is built</p></li>
7820: <li><p>help during the build process</p></li>
7821: <li><p>help during the installation of a package</p></li>
7822: </ul></div>
7823: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7824: provided to notify the pkgsrc mechanism of an interactive stage
7825: which will be needed, and this should be set in the package's
7826: <code class="filename">Makefile</code>, e.g.:</p>
7827: <pre class="programlisting">
7828: INTERACTIVE_STAGE= build
7829: </pre>
7830: <p>Multiple interactive stages can be specified:</p>
7831: <pre class="programlisting">
7832: INTERACTIVE_STAGE= configure install
7833: </pre>
7834: <p>The user can then decide to skip this package by setting the
7835: <code class="varname">BATCH</code> variable.</p>
7836: </div>
7837: <div class="sect2" lang="en">
7838: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7839: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7840: <p>Authors of software can choose the licence under which
7841: software can be copied. This is due to copyright law, and reasons
7842: for license choices are outside the scope of pkgsrc. The pkgsrc
7843: system recognizes that there are a number of licenses which some
7844: users may find objectionable or difficult or impossible to comply
7845: with. The Free Software Foundation has declared some licenses
7846: "Free", and the Open Source Initiative has a definition of "Open
7847: Source". The pkgsrc system, as a policy choice, does not label
7848: packages which have licenses that are Free or Open Source.
7849: However, packages without a license meeting either of those tests
7850: are labeled with a license tag denoting the license. Note that a
7851: package with no license to copy trivially does not meet either the
7852: Free or Open Source test.</p>
7853: <p>For packages which are not Free or Open Source, pkgsrc will
7854: not build the package unless the user has indicated to pkgsrc that
7855: packages with that particular license may be built. Note that
7856: this documentation avoids the term "accepted the license". The
7857: pkgsrc system is merely providing a mechanism to avoid
7858: accidentally building a package with a non-free license;
7859: judgement and responsibility remain with the user. (Installation
7860: of binary packages are not currently subject to this mechanism;
7861: this is a bug.)</p>
7862: <p>One might want to only install packages with a BSD license,
7863: or the GPL, and not the other. The pkgsrc license tag mechanism
7864: does not provide a way to do this. It might be possible to put in
7865: tags for free licenses, and have a default
7866: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7867: widely viewed as having a very poor ratio of benefit to
7868: work.</p>
7869: <p>The license tag mechanism is intended to address
7870: copyright-related issues surrounding building, installing and
7871: using a package, and not to address redistribution issues (see
7872: <code class="varname">RESTRICTED</code> and
7873: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7874: definition of licenses for which tags are not needed implies
7875: that packages with redistribution restrictions should have
7876: tags, because Free or Open Source programs do not have
7877: redistribution restrictions.</p>
7878: <p>Denoting that a package may be copied according to a
7879: particular license is done by placing the license in
7880: <code class="filename">pkgsrc/licenses</code> and setting the
7881: <code class="varname">LICENSE</code> variable to a string identifying the
7882: 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>
7883: <pre class="programlisting">
7884: LICENSE= xv-license
7885: </pre>
7886: <p>When trying to build, the user will get a notice that the
7887: package is covered by a license which has not been placed in the
7888: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7889: <pre class="programlisting">
7890: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7891: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7892: ===> To view the license, enter "/usr/bin/make show-license".
7893: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7894: ===> ACCEPTABLE_LICENSES+=xv-license
7895: *** Error code 1
7896: </pre>
7897: <p>The license can be viewed with <span><strong class="command">make
7898: show-license</strong></span>, and if the user so chooses, the line
1.4 rillig 7899: printed above can be added to <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7900: convey to pkgsrc that it should not in the future fail because of
7901: that license:</p>
7902: <pre class="programlisting">
7903: ACCEPTABLE_LICENSES+=xv-license
7904: </pre>
7905: <p>When adding a package with a new license, the license text
7906: should be added to <code class="filename">pkgsrc/licenses</code> for
7907: displaying. A list of known licenses can be seen in this
7908: directory.</p>
7909: <p>When the license changes (in a way other than formatting),
7910: please make sure that the new license has a different name (e.g.,
7911: append the version number if it exists, or the date). Just
7912: because a user told pkgsrc to build programs under a previous
7913: version of a license does not mean that pkgsrc should build
7914: programs under the new licenses. The higher-level point is that
7915: pkgsrc does not evaluate licenses for reasonableness; the only
7916: test is a mechanistic test of whether a particular text has been
7917: approved by either of two bodies.</p>
7918: <p>The use of <code class="varname">LICENSE=shareware</code>,
7919: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7920: is deprecated because it does not crisply refer to a particular
7921: license text. Another problem with such usage is that it does not
7922: enable a user to tell pkgsrc to proceed for a single package
7923: without also telling pkgsrc to proceed for all packages with that
7924: tag.</p>
7925: </div>
7926: <div class="sect2" lang="en">
7927: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7928: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 7929: <p>Some licenses restrict how software may be re-distributed.
7930: Because a license tag is required unless the package is Free or
7931: Open Source, all packages with restrictions should have license
7932: tags. By declaring the restrictions, package tools can
7933: automatically refrain from e.g. placing binary packages on FTP
7934: sites.</p>
7935: <p>There are four restrictions that may be encoded, which are
7936: the cross product of sources (distfiles) and binaries not being
7937: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7938: language in any license, and because non-Free licenses tend to be
7939: different from each other, pkgsrc adopts a definition of FTP and
7940: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7941: should not be made available over the Internet at no charge.
7942: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7943: made available on some kind of media, together with other source
7944: and binary packages, and which is sold for a distribution charge.
7945: </p>
7946: <p>In order to encode these restrictions, the package system
7947: defines five make variables that can be set to note these
7948: restrictions:</p>
7949: <div class="itemizedlist"><ul type="disc">
7950: <li>
7951: <p><code class="varname">RESTRICTED</code></p>
7952: <p>This variable should be set whenever a restriction
7953: exists (regardless of its kind). Set this variable to a
7954: string containing the reason for the restriction. It should
7955: be understood that those wanting to understand the restriction
7956: will have to read the license, and perhaps seek advice of
7957: counsel.</p>
7958: </li>
7959: <li>
7960: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7961: <p>Binaries may not be placed on CD-ROM containing other
7962: binary packages, for which a distribution charge may be made.
7963: In this case, set this variable to
7964: <code class="varname">${RESTRICTED}</code>.</p>
7965: </li>
7966: <li>
7967: <p><code class="varname">NO_BIN_ON_FTP</code></p>
7968: <p>Binaries may not made available on the Internet without
7969: charge. In this case, set this variable to
7970: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7971: binary packages will not be included on ftp.NetBSD.org.</p>
7972: </li>
7973: <li>
7974: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7975: <p>Distfiles may not be placed on CD-ROM, together with
7976: other distfiles, for which a fee may be charged. In this
7977: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7978: </p>
7979: </li>
7980: <li>
7981: <p><code class="varname">NO_SRC_ON_FTP</code></p>
7982: <p>Distfiles may not made available via FTP at no charge.
7983: In this case, set this variable to
7984: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7985: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7986: </li>
7987: </ul></div>
7988: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
7989: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7990: generic make variables to denote restrictions is deprecated,
7991: because they unconditionally prevent users from generating
7992: binary packages!</p>
7993: </div>
7994: <div class="sect2" lang="en">
7995: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7996: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 7997: <p>Your package may depend on some other package being present
7998: - and there are various ways of expressing this dependency.
7999: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
8000: <code class="varname">DEPENDS</code> definitions, the
8001: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
8002: via <code class="filename">buildlink3.mk</code>, which is the preferred way
8003: to handle dependencies, and which uses the variables named above.
1.6 rillig 8004: See <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 8005: <p>The basic difference between the two variables is as
8006: follows: The <code class="varname">DEPENDS</code> definition registers
8007: that pre-requisite in the binary package so it will be pulled in
8008: when the binary package is later installed, whilst the
8009: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
8010: dependency that is only needed for building the package.</p>
8011: <p>This means that if you only need a package present whilst
8012: you are building, it should be noted as a
8013: <code class="varname">BUILD_DEPENDS</code>.</p>
8014: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
8015: <code class="varname">DEPENDS</code> definition is:</p>
8016: <pre class="programlisting">
8017: <pre-req-package-name>:../../<category>/<pre-req-package>
8018: </pre>
8019: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
8020: may include any of the wildcard version numbers recognized by
8021: <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>
8022: <div class="orderedlist"><ol type="1">
8023: <li>
8024: <p>If your package needs another package's binaries or
8025: libraries to build or run, and if that package has a
8026: <code class="filename">buildlink3.mk</code> file available, use it:</p>
8027: <pre class="programlisting">
8028: .include "../../graphics/jpeg/buildlink3.mk"
8029: </pre>
8030: </li>
8031: <li>
8032: <p>If your package needs to use another package to build
8033: itself and there is no <code class="filename">buildlink3.mk</code>
8034: file available, use the <code class="varname">BUILD_DEPENDS</code>
8035: definition:</p>
8036: <pre class="programlisting">
8037: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
8038: </pre>
8039: </li>
8040: <li>
8041: <p>If your package needs a library with which to link and
8042: again there is no <code class="filename">buildlink3.mk</code> file
8043: available, this is specified using the
8044: <code class="varname">DEPENDS</code> definition. For example:</p>
8045: <pre class="programlisting">
8046: DEPENDS+= xpm-3.4j:../../graphics/xpm
8047: </pre>
8048: <p>You can also use wildcards in package dependences:</p>
8049: <pre class="programlisting">
8050: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
8051: </pre>
8052: <p>Note that such wildcard dependencies are retained when
8053: creating binary packages. The dependency is checked when
8054: installing the binary package and any package which matches
8055: the pattern will be used. Wildcard dependencies should be
8056: used with care.</p>
8057: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
8058: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
8059: such as “<span class="quote">tk-postgresql</span>” matching a
8060: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
8061: <p>Wildcards can also be used to specify that a package
8062: will only build against a certain minimum version of a
8063: pre-requisite:</p>
8064: <pre class="programlisting">
8065: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
8066: </pre>
8067: <p>This means that the package will build against version
8068: 3.5.4 of the tiff library or newer. Such a dependency may
8069: be warranted if, for example, the API of the library has
8070: changed with version 3.5.4 and a package would not compile
8071: against an earlier version of tiff.</p>
8072: <p>Please note that such dependencies should only be
8073: updated if a package requires a newer pre-requisite, but
8074: not to denote recommendations such as
8075: ABI changes that do not prevent a package from building
8076: correctly. Such recommendations can be expressed using
8077: <code class="varname">ABI_DEPENDS</code>:</p>
8078: <pre class="programlisting">
8079: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
8080: </pre>
8081: <p>In addition to the above <code class="varname">DEPENDS</code>
8082: line, this denotes that while a package will build against
8083: tiff>=3.5.4, at least version 3.6.1 is recommended.
8084: <code class="varname">ABI_DEPENDS</code> entries will be turned into
8085: dependencies unless explicitly ignored (in which case a
8086: warning will be printed).</p>
8087: <p>To ignore these ABI dependency recommendations and just
8088: use the required <code class="varname">DEPENDS</code>, set
8089: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
8090: it easier and faster to update packages built using pkgsrc,
8091: since older compatible dependencies can continue to be
8092: used. This is useful for people who watch their rebuilds
8093: very carefully; it is not very good as a general-purpose
8094: hammer. If you use it, you need to be mindful of possible
8095: ABI changes, including those from the underlying OS.</p>
8096: <p>Packages that are built with recommendations ignored
8097: may not be uploaded to ftp.NetBSD.org by developers and
8098: should not be used across different systems that may have
8099: different versions of binary packages installed.</p>
8100: <p>For security fixes, please update the package
1.6 rillig 8101: 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 8102: information.</p>
8103: </li>
8104: <li>
8105: <p>If your package needs some executable to be able to run
8106: correctly and if there's no
8107: <code class="filename">buildlink3.mk</code> file, this is specified
8108: using the <code class="varname">DEPENDS</code> variable. The
8109: <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
8110: be able to execute the latex binary from the teTeX package
8111: when it runs, and that is specified:</p>
8112: <pre class="programlisting">
8113: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
8114: </pre>
8115: <p>The comment about wildcard dependencies from previous
8116: paragraph applies here, too.</p>
8117: </li>
8118: </ol></div>
8119: <p>If your package needs files from another package to build,
8120: add the relevant distribution files to
8121: <code class="varname">DISTFILES</code>, so they will be extracted
8122: 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.
8123: (It relies on the jpeg sources being present in source form
8124: during the build.)</p>
8125: </div>
8126: <div class="sect2" lang="en">
8127: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8128: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 8129: <p>Your package may conflict with other packages a user might
8130: already have installed on his system, e.g. if your package
8131: installs the same set of files as another package in the pkgsrc
8132: tree.</p>
8133: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8134: space-separated list of packages (including version string) your
8135: package conflicts with.</p>
8136: <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>
8137: 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>
8138: install the same shared library, thus you set in
8139: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8140: <pre class="programlisting">
8141: CONFLICTS= Xaw-Xpm-[0-9]*
8142: </pre>
8143: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8144: <pre class="programlisting">
8145: CONFLICTS= Xaw3d-[0-9]*
8146: </pre>
8147: <p>Packages will automatically conflict with other packages
8148: with the name prefix and a different version
8149: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8150: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
8151: </div>
8152: <div class="sect2" lang="en">
8153: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8154: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 8155: <p>There are several reasons why a package might be
8156: instructed to not build under certain circumstances. If the
8157: package builds and runs on most platforms, the exceptions
8158: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8159: the package builds and runs on a small handful of platforms,
8160: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8161: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8162: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8163: (OS-version-platform) that can use glob-style
8164: wildcards.</p>
8165: <p>Some packages are tightly bound to a specific version of an
8166: 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
8167: backwards compatible with other versions of the OS, and should be
8168: uploaded to a version specific directory on the FTP server. Mark
8169: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8170: “<span class="quote">yes</span>”. This variable is not currently used by any of
8171: the package system internals, but may be used in the
8172: future.</p>
8173: <p>If the package should be skipped (for example, because it
8174: provides functionality already provided by the system), set
8175: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8176: the package should fail because some preconditions are not met,
8177: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8178: message.</p>
8179: </div>
8180: <div class="sect2" lang="en">
8181: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8182: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 8183: <p>To ensure that a package may not be deleted, once it has been
8184: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8185: be set in the package Makefile. This will be carried into any
8186: binary package that is made from this pkgsrc entry. A
8187: “<span class="quote">preserved</span>” package will
8188: 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
8189: “<span class="quote">-f</span>” option is used.</p>
8190: </div>
8191: <div class="sect2" lang="en">
8192: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8193: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8194: <p>When a vulnerability is found, this should be noted in
8195: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8196: and after committing that file, use <span><strong class="command">make upload</strong></span>
8197: in the same directory to update the file on ftp.NetBSD.org.</p>
8198: <p>After fixing the vulnerability by a patch, its
8199: <code class="varname">PKGREVISION</code> should be increased (this
8200: is of course not necessary if the problem is fixed by using
8201: a newer release of the software).</p>
8202: <p>Also, if the fix should be applied to the stable pkgsrc
8203: branch, be sure to submit a pullup request!</p>
8204: <p>Binary packages already on ftp.NetBSD.org will be handled
8205: semi-automatically by a weekly cron job.</p>
8206: </div>
8207: <div class="sect2" lang="en">
8208: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8209: <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 8210: <p>When making fixes to an existing package it can be useful
8211: to change the version number in <code class="varname">PKGNAME</code>. To
8212: avoid conflicting with future versions by the original author, a
8213: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8214: on package versions by setting <code class="varname">PKGREVISION=1</code>
8215: (2, ...). The “<span class="quote">nb</span>” is treated like a
8216: “<span class="quote">.</span>” by the package tools. e.g.</p>
8217: <pre class="programlisting">
8218: DISTNAME= foo-17.42
8219: PKGREVISION= 9
8220: </pre>
8221: <p>will result in a <code class="varname">PKGNAME</code> of
8222: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8223: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8224: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8225: <code class="varname">PKGNAME_NOREV</code>.</p>
8226: <p>When a new release of the package is released, the
8227: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8228: minor release of the above package, things should be like:</p>
8229: <pre class="programlisting">
8230: DISTNAME= foo-17.43
8231: </pre>
8232: <p><code class="varname">PKGREVISION</code> should be incremented for any
8233: non-trivial change in the resulting binary package. Without a
8234: <code class="varname">PKGREVISION</code> bump, someone with the previous
8235: version installed has no way of knowing that their package is out
8236: of date. Thus, changes without increasing
8237: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8238: trivial that no reasonable person would want to upgrade", and this
8239: is the rough test for when increasing
8240: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8241: changes that do not merit increasing
8242: <code class="varname">PKGREVISION</code> are:</p>
8243: <div class="itemizedlist"><ul type="disc">
8244: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8245: or comments in Makefile.</p></li>
8246: <li><p>
8247: Changing build variables if the resulting binary package is the same.</p></li>
8248: <li><p>
8249: Changing <code class="filename">DESCR</code>.</p></li>
8250: <li><p>
8251: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8252: </ul></div>
8253: <p>Examples of changes that do merit an increase to
8254: <code class="varname">PKGREVISION</code> include:</p>
8255: <div class="itemizedlist"><ul type="disc">
8256: <li><p>
8257: Security fixes</p></li>
8258: <li><p>
8259: Changes or additions to a patch file</p></li>
8260: <li><p>
8261: Changes to the <code class="filename">PLIST</code></p></li>
8262: </ul></div>
8263: <p>PKGREVISION must also be incremented when dependencies have ABI
8264: changes.</p>
8265: </div>
8266: <div class="sect2" lang="en">
8267: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8268: <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 8269: <p>When you want to replace the same text in multiple files
8270: or when the replacement text varies, patches alone cannot help.
8271: This is where the SUBST framework comes in. It provides an
8272: easy-to-use interface for replacing text in files.
8273: Example:</p>
8274: <pre class="programlisting">
8275: SUBST_CLASSES+= fix-paths
8276: SUBST_STAGE.fix-paths= pre-configure
8277: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8278: SUBST_FILES.fix-paths= src/*.c
8279: SUBST_FILES.fix-paths+= scripts/*.sh
8280: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8281: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8282: </pre>
8283: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8284: that are used to identify the different SUBST blocks that are
8285: defined. The SUBST framework is heavily used by pkgsrc, so it is
8286: important to always use the <code class="literal">+=</code> operator with
8287: this variable. Otherwise some substitutions may be
8288: skipped.</p>
8289: <p>The remaining variables of each SUBST block are
8290: parameterized with the identifier from the first line
8291: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8292: parameters to a function call.</p>
8293: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8294: which the replacement will take place. All combinations of
8295: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8296: <code class="literal">post-</code> together with a phase name are
8297: possible, though only few are actually used. Most commonly used
8298: are <code class="literal">post-patch</code> and
8299: <code class="literal">pre-configure</code>. Of these two,
8300: <code class="literal">pre-configure</code> should be preferred because
8301: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8302: have the state after applying the patches but before making any
8303: other changes. This is especially useful when you are debugging
8304: a package in order to create new patches for it. Similarly,
8305: <code class="literal">post-build</code> is preferred over
8306: <code class="literal">pre-install</code>, because the install phase should
8307: generally be kept as simple as possible. When you use
8308: <code class="literal">post-build</code>, you have the same files in the
8309: working directory that will be installed later, so you can check
8310: if the substitution has succeeded.</p>
8311: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8312: that is printed just before the substitution is done.</p>
8313: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8314: globbing patterns that specifies the files in which the
8315: substitution will take place. The patterns are interpreted
8316: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8317: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
8318: <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
8319: command should be prefixed with <code class="literal">-e</code>, so that
8320: all SUBST blocks look uniform.</p>
8321: <p>There are some more variables, but they are so seldomly
8322: used that they are only documented in the
8323: <code class="filename">mk/subst.mk</code> file.</p>
8324: </div>
8325: </div>
8326: <div class="sect1" lang="en">
8327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8328: <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 8329: <div class="sect2" lang="en">
8330: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8331: <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 8332: <p>If you need to download from a dynamic URL you can set
8333: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8334: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8335: with the name of each file to download as an argument, expecting
8336: it to output the URL of the directory from which to download
8337: 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
8338: example of this usage.</p>
8339: <p>If the download can't be automated, because the user must
8340: submit personal information to apply for a password, or must pay
8341: for the source, or whatever, you can set
8342: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8343: displayed to the user before aborting the build. Example:</p>
8344: <pre class="programlisting">
8345: FETCH_MESSAGE= "Please download the files"
8346: FETCH_MESSAGE+= " "${DISTFILES:Q}
8347: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8348: </pre>
8349: </div>
8350: <div class="sect2" lang="en">
8351: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8352: <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 8353: <p>Sometimes authors of a software package make some
8354: modifications after the software was released, and they put up a
8355: new distfile without changing the package's version number. If a
8356: package is already in pkgsrc at that time, the checksum will
8357: no longer match. The contents of the new distfile should be
8358: compared against the old one before changing anything, to make
8359: sure the distfile was really updated on purpose, and that
8360: no trojan horse or so crept in.
8361: Please mention that the distfiles were compared and what was found
8362: in your commit message.
8363: Then, the correct way to work around this is to
8364: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8365: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8366: <code class="varname">DISTFILES</code> and
8367: <code class="varname">PATCHFILES</code> for this package will be put in that
8368: subdirectory of the local distfiles directory.
1.6 rillig 8369: (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 8370: In case this
8371: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8372: including the <code class="filename">nbX</code> suffix) or a date stamp
8373: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8374: Do not forget regenerating the <code class="filename">distinfo</code> file
8375: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8376: path in the filenames.
8377: Also increase the PKGREVISION if the installed package is different.
8378: Furthermore, a mail to the package's authors seems appropriate
8379: telling them that changing distfiles after releases without
8380: changing the file names is not good practice.</p>
8381: </div>
8382: </div>
8383: <div class="sect1" lang="en">
8384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8385: <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 8386: <div class="sect2" lang="en">
8387: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8388: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8389: <p>pkgsrc supports many different machines, with different
8390: object formats like a.out and ELF, and varying abilities to do
8391: shared library and dynamic loading at all. To accompany this,
8392: varying commands and options have to be passed to the
8393: compiler, linker, etc. to get the Right Thing, which can be
8394: pretty annoying especially if you don't have all the machines
8395: at your hand to test things. The
8396: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
8397: can help here, as it just “<span class="quote">knows</span>” how to build
8398: both static and dynamic libraries from a set of source files,
8399: thus being platform-independent.</p>
8400: <p>Here's how to use libtool in a package in seven simple
8401: steps:</p>
8402: <div class="orderedlist"><ol type="1">
8403: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
8404: Makefile.</p></li>
8405: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
8406: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8407: add it to the definition of <code class="varname">CC</code>, if only
8408: libraries are being built in a given Makefile. This one command
8409: will build both PIC and non-PIC library objects, so you need not
8410: have separate shared and non-shared library rules.</p></li>
8411: <li>
8412: <p>For the linking of the library, remove any
8413: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8414: -Bshareable</span>” commands, and instead use:</p>
8415: <pre class="programlisting">
8416: ${LIBTOOL} --mode=link \
8417: ${CC} -o ${.TARGET:.a=.la} \
8418: ${OBJS:.o=.lo} \
8419: -rpath ${PREFIX}/lib \
8420: -version-info major:minor
8421: </pre>
8422: <p>Note that the library is changed to have a
8423: <code class="filename">.la</code> extension, and the objects are
8424: changed to have a <code class="filename">.lo</code>
8425: extension. Change <code class="varname">OBJS</code> as
8426: necessary. This automatically creates all of the
8427: <code class="filename">.a</code>,
8428: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8429: necessary) in the build directory. Be sure to include
8430: “<span class="quote">-version-info</span>”, especially when major and
8431: minor are zero, as libtool will otherwise strip off the
8432: shared library version.</p>
8433: <p>From the libtool manual:</p>
8434: <pre class="programlisting">
8435: So, libtool library versions are described by three integers:
8436:
8437: CURRENT
8438: The most recent interface number that this library implements.
8439:
8440: REVISION
8441: The implementation number of the CURRENT interface.
8442:
8443: AGE
8444: The difference between the newest and oldest interfaces that
8445: this library implements. In other words, the library implements
8446: all the interface numbers in the range from number `CURRENT -
8447: AGE' to `CURRENT'.
8448:
8449: If two libraries have identical CURRENT and AGE numbers, then the
8450: dynamic linker chooses the library with the greater REVISION number.
8451: </pre>
8452: <p>The “<span class="quote">-release</span>” option will produce
8453: different results for a.out and ELF (excluding symlinks)
8454: in only one case. An ELF library of the form
8455: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8456: will have a symlink of
8457: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8458: on an a.out platform. This is handled
8459: automatically.</p>
8460: <p>The “<span class="quote">-rpath argument</span>” is the install
8461: directory of the library being built.</p>
8462: <p>In the <code class="filename">PLIST</code>, include only the
8463: <code class="filename">.la</code> file, the other files will be
8464: added automatically.</p>
8465: </li>
8466: <li>
8467: <p>When linking shared object (<code class="filename">.so</code>)
8468: 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
8469: shared libraries, use “<span class="quote">-module
8470: -avoid-version</span>” to prevent them getting version
8471: tacked on.</p>
8472: <p>The <code class="filename">PLIST</code> file gets the
8473: <code class="filename">foo.so</code> entry.</p>
8474: </li>
8475: <li>
8476: <p>When linking programs that depend on these libraries
8477: <span class="emphasis"><em>before</em></span> they are installed, preface
8478: 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}
8479: --mode=link</span>”, and it will find the correct
8480: libraries (static or shared), but please be aware that
8481: libtool will not allow you to specify a relative path in
8482: -L (such as “<span class="quote">-L../somelib</span>”), because it
8483: expects you to change that argument to be the
8484: <code class="filename">.la</code> file. e.g.</p>
8485: <pre class="programlisting">
8486: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8487: </pre>
8488: <p>should be changed to:</p>
8489: <pre class="programlisting">
8490: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8491: </pre>
8492: <p>and it will do the right thing with the libraries.</p>
8493: </li>
8494: <li>
8495: <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>
8496: 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}
8497: --mode=install</span>”, and change the library name to
8498: <code class="filename">.la</code>. e.g.</p>
8499: <pre class="programlisting">
8500: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
8501: </pre>
8502: <p>This will install the static <code class="filename">.a</code>,
8503: shared library, any needed symlinks, and run
8504: <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>
8505: </li>
8506: <li><p>In your <code class="filename">PLIST</code>, include only
8507: the <code class="filename">.la</code>
8508: file (this is a change from previous behaviour).</p></li>
8509: </ol></div>
8510: </div>
8511: <div class="sect2" lang="en">
8512: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8513: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8514: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8515: package Makefile. This will override the package's own libtool
8516: in most cases. For older libtool using packages, libtool is
8517: made by ltconfig script during the do-configure step; you can
8518: check the libtool script location by doing <span><strong class="command">make
8519: configure; find work*/ -name libtool</strong></span>.</p>
8520: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8521: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8522: default, it is set to “<span class="quote">libtool */libtool
8523: */*/libtool</span>”. If this does not match the location of the
8524: package's libtool script(s), set it as appropriate.</p>
8525: <p>If you do not need <code class="filename">*.a</code> static
8526: libraries built and installed, then use
8527: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8528: <p>If your package makes use of the platform-independent library
8529: for loading dynamic shared objects, that comes with libtool
8530: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8531: <p>Some packages use libtool incorrectly so that the package
8532: may not work or build in some circumstances. Some of the more
8533: common errors are:</p>
8534: <div class="itemizedlist"><ul type="disc">
8535: <li>
8536: <p>The inclusion of a shared object (-module) as a dependent library in an
8537: executable or library. This in itself isn't a problem if one of two things
8538: has been done:</p>
8539: <div class="orderedlist"><ol type="1">
8540: <li><p>The shared object is named correctly, i.e.
8541: <code class="filename">libfoo.la</code>, not
8542: <code class="filename">foo.la</code></p></li>
8543: <li><p>The -dlopen option is used when linking an executable.</p></li>
8544: </ol></div>
8545: </li>
8546: <li><p>The use of libltdl without the correct calls to initialisation routines.
8547: The function lt_dlinit() should be called and the macro
8548: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8549: executables.</p></li>
8550: </ul></div>
8551: </div>
8552: <div class="sect2" lang="en">
8553: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8554: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8555: <p>If a package needs GNU autoconf or automake to be executed
8556: to regenerate the configure script and Makefile.in makefile
8557: templates, then they should be executed in a pre-configure
8558: target.</p>
8559: <p>For packages that need only autoconf:</p>
8560: <pre class="programlisting">
8561: AUTOCONF_REQD= 2.50 # if default version is not good enough
8562: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8563: ...
8564:
8565: pre-configure:
8566: cd ${WRKSRC} && autoconf
8567:
8568: ...
8569: </pre>
8570: <p>and for packages that need automake and autoconf:</p>
8571: <pre class="programlisting">
8572: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8573: USE_TOOLS+= automake # use "automake14" for automake-1.4
8574: ...
8575:
8576: pre-configure:
8577: set -e; cd ${WRKSRC}; \
8578: aclocal; autoheader; automake -a --foreign -i; autoconf
8579:
8580: ...
8581: </pre>
8582: <p>Packages which use GNU Automake will almost certainly
8583: require GNU Make.</p>
8584: <p>There are times when the configure process makes
8585: additional changes to the generated files, which then causes
8586: the build process to try to re-execute the automake sequence.
8587: This is prevented by touching various files in the configure
8588: stage. If this causes problems with your package you can set
8589: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8590: Makefile.</p>
8591: </div>
8592: </div>
8593: <div class="sect1" lang="en">
8594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8595: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.1 dsieger 8596: <div class="sect2" lang="en">
8597: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8598: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8599: <p>Compilers for the C, C++, and Fortran languages comes with
8600: the NetBSD base system. By default, pkgsrc assumes that a package
8601: is written in C and will hide all other compilers (via the wrapper
1.6 rillig 8602: framework, see <a href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8603: <p>To declare which language's compiler a package needs, set
8604: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8605: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8606: “<span class="quote">fortran</span>” (and any combination). The default is
8607: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8608: written in C++, usually need a C compiler for the configure
8609: phase.</p>
8610: </div>
8611: <div class="sect2" lang="en">
8612: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8613: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8614: <p>If a program is written in Java, use the Java framework in
8615: pkgsrc. The package must include
8616: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8617: provides the following variables:</p>
8618: <div class="itemizedlist"><ul type="disc">
8619: <li><p><code class="varname">USE_JAVA</code> defines if a build
8620: dependency on the JDK is added. If
8621: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8622: there is only a runtime dependency on the JDK. The default is
8623: “<span class="quote">yes</span>”, which also adds a build dependency on the
8624: JDK.</p></li>
8625: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8626: a package needs a Java2 implementation. The supported values
8627: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8628: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8629: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8630: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8631: above. This variable is not set by default.</p></li>
8632: </ul></div>
8633: </div>
8634: <div class="sect2" lang="en">
8635: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8636: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8637: <p>If your package contains interpreted perl scripts, add
8638: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8639: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8640: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8641: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8642: that you want adjusted. Every occurrence of
8643: <code class="filename">*/bin/perl</code> will be replaced with the full
8644: path to the perl executable.</p>
8645: <p>If a particular version of perl is needed, set the
8646: <code class="varname">PERL5_REQD</code> variable to the version number. The
8647: default is “<span class="quote">5.0</span>”.</p>
1.6 rillig 8648: <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 8649: about handling perl modules.</p>
8650: </div>
8651: <div class="sect2" lang="en">
8652: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8653: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1 dsieger 8654: <p>Currently, there is no special handling for other languages
8655: in pkgsrc. If a compiler package provides a
8656: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8657: just add a (build) dependency on the appropriate compiler
8658: package.</p>
8659: </div>
8660: </div>
8661: <div class="sect1" lang="en">
8662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8663: <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 8664: <p>The most common failures when building a package are that
8665: some platforms do not provide certain header files, functions or
8666: libraries, or they provide the functions in a library that the
8667: original package author didn't know. To work around this, you
8668: can rewrite the source code in most cases so that it does not
8669: use the missing functions or provides a replacement function.</p>
8670: <div class="sect2" lang="en">
8671: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8672: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8673: <p>If a package already comes with a GNU configure script, the
8674: preferred way to fix the build failure is to change the
8675: configure script, not the code. In the other cases, you can
8676: utilize the C preprocessor, which defines certain macros
8677: depending on the operating system and hardware architecture it
8678: compiles for. These macros can be queried using for example
8679: <code class="varname">#if defined(__i386)</code>. Almost every operating
8680: system, hardware architecture and compiler has its own macro.
8681: For example, if the macros <code class="varname">__GNUC__</code>,
8682: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8683: are all defined, you know that you are using NetBSD on an i386
8684: compatible CPU, and your compiler is GCC.</p>
8685: <p>The list of the following macros for hardware and
8686: operating system depends on the compiler that is used. For
8687: example, if you want to conditionally compile code on Solaris,
8688: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8689: does not define it. Use <code class="varname">__sun</code> instead.</p>
8690: <div class="sect3" lang="en">
8691: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8692: <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 8693: <p>To distinguish between 4.4 BSD-derived systems and the
8694: rest of the world, you should use the following code.</p>
8695: <pre class="programlisting">
8696: #include <sys/param.h>
8697: #if (defined(BSD) && BSD >= 199306)
8698: /* BSD-specific code goes here */
8699: #else
8700: /* non-BSD-specific code goes here */
8701: #endif
8702: </pre>
8703: <p>If this distinction is not fine enough, you can also test
8704: for the following macros.</p>
8705: <pre class="programlisting">
8706: FreeBSD __FreeBSD__
8707: DragonFly __DragonFly__
8708: Interix __INTERIX
8709: IRIX __sgi (TODO: get a definite source for this)
8710: Linux linux, __linux, __linux__
8711: NetBSD __NetBSD__
8712: OpenBSD __OpenBSD__
8713: Solaris sun, __sun
8714: </pre>
8715: </div>
8716: <div class="sect3" lang="en">
8717: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8718: <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 8719: <pre class="programlisting">
8720: i386 i386, __i386, __i386__
8721: MIPS __mips
8722: SPARC sparc, __sparc
8723: </pre>
8724: </div>
8725: <div class="sect3" lang="en">
8726: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8727: <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 8728: <pre class="programlisting">
8729: GCC __GNUC__ (major version), __GNUC_MINOR__
8730: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8731: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8732: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8733: </pre>
8734: </div>
8735: </div>
8736: <div class="sect2" lang="en">
8737: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8738: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8739: <p>Some source files trigger bugs in the compiler, based on
8740: combinations of compiler version and architecture and almost
8741: always relation to optimisation being enabled. Common symptoms
8742: are gcc internal errors or never finishing compiling a
8743: file.</p>
8744: <p>Typically, a workaround involves testing the
8745: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8746: optimisation for that combination of file,
8747: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8748: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8749: number of examples.</p>
8750: </div>
8751: <div class="sect2" lang="en">
8752: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8753: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.1 dsieger 8754: <p>This error message often means that a package did not
8755: link to a shared library it needs. The following functions are
8756: known to cause this error message over and over.</p>
8757: <div class="informaltable">
8758: <a name="undefined-reference-functions"></a><table border="1">
8759: <colgroup>
8760: <col>
8761: <col>
8762: <col>
8763: </colgroup>
8764: <thead><tr>
8765: <th>Function</th>
8766: <th>Library</th>
8767: <th>Affected platforms</th>
8768: </tr></thead>
8769: <tbody>
8770: <tr>
8771: <td>accept, bind, connect</td>
8772: <td>-lsocket</td>
8773: <td>Solaris</td>
8774: </tr>
8775: <tr>
8776: <td>crypt</td>
8777: <td>-lcrypt</td>
8778: <td>DragonFly, NetBSD</td>
8779: </tr>
8780: <tr>
8781: <td>dlopen, dlsym</td>
8782: <td>-ldl</td>
8783: <td>Linux</td>
8784: </tr>
8785: <tr>
8786: <td>gethost*</td>
8787: <td>-lnsl</td>
8788: <td>Solaris</td>
8789: </tr>
8790: <tr>
8791: <td>inet_aton</td>
8792: <td>-lresolv</td>
8793: <td>Solaris</td>
8794: </tr>
8795: <tr>
8796: <td>nanosleep, sem_*, timer_*</td>
8797: <td>-lrt</td>
8798: <td>Solaris</td>
8799: </tr>
8800: <tr>
8801: <td>openpty</td>
8802: <td>-lutil</td>
8803: <td>Linux</td>
8804: </tr>
8805: </tbody>
8806: </table>
8807: </div>
8808: <p>To fix these linker errors, it is often sufficient to say
8809: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8810: -l<em class="replaceable"><code>foo</code></em></code> to the package
8811: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8812: bmake</strong></span>.</p>
8813: <div class="sect3" lang="en">
8814: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8815: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8816: <p>When you are using the SunPro compiler, there is another
8817: possibility. That compiler cannot handle the following code:</p>
8818: <pre class="programlisting">
8819: extern int extern_func(int);
8820:
8821: static inline int
8822: inline_func(int x)
8823: {
8824: return extern_func(x);
8825: }
8826:
8827: int main(void)
8828: {
8829: return 0;
8830: }
8831: </pre>
8832: <p>It generates the code for <code class="function">inline_func</code> even if
8833: that function is never used. This code then refers to
8834: <code class="function">extern_func</code>, which can usually not be resolved. To
8835: solve this problem you can try to tell the package to disable inlining
8836: of functions.</p>
8837: </div>
8838: </div>
8839: <div class="sect2" lang="en">
8840: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8841: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8842: <p>Sometimes packages fail to build because the compiler runs
8843: into an operating system specific soft limit. With the
8844: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8845: to unlimit the resources. Currently, the allowed values are
8846: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8847: Setting this variable is similar to running the shell builtin
8848: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8849: segment size or maximum stack size of a process, respectively, to
8850: their hard limits.</p>
8851: </div>
8852: </div>
8853: <div class="sect1" lang="en">
8854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8855: <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 8856: <div class="sect2" lang="en">
8857: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8858: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.1 dsieger 8859: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
8860: with some operating systems cannot create more than one
8861: directory at a time. As such, you should call
8862: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8863: <pre class="programlisting">
8864: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8865: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8866: </pre>
8867: <p>You can also just append “<span class="quote"><code class="literal">dir1
8868: dir2</code></span>” to the
8869: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8870: automatically do the right thing.</p>
8871: </div>
8872: <div class="sect2" lang="en">
8873: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8874: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8875: <p>In general, documentation should be installed into
8876: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8877: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8878: includes the version number of the package).</p>
8879: <p>Many modern packages using GNU autoconf allow to set the
8880: directory where HTML documentation is installed with the
8881: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8882: is needed because otherwise the documentation ends up in
8883: <code class="filename">${PREFIX}/share/doc/html</code> or other
8884: places.</p>
8885: <p>An exception to the above is that library API documentation
8886: 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
8887: browsers (devhelp) should be left at their default location, which
8888: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8889: documentation can be recognized from files ending in
8890: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8891: (It is also acceptable to install such files in
8892: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8893: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8894: <code class="filename">.devhelp*</code> file must be directly in that
8895: directory then, no additional subdirectory level is allowed in
8896: this case. This is usually achieved by using
8897: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8898: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8899: though.)</p>
8900: </div>
8901: <div class="sect2" lang="en">
8902: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8903: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 8904: <p>Certain packages, most of them in the games category, install
8905: a score file that allows all users on the system to record their
8906: highscores. In order for this to work, the binaries need to be
8907: installed setgid and the score files owned by the appropriate
8908: group and/or owner (traditionally the "games" user/group). The
8909: following variables, documented in more detail in
8910: <code class="filename">mk/defaults/mk.conf</code>, control this
8911: behaviour: <code class="varname">SETGIDGAME</code>,
8912: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8913: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
8914: <p>Note that per default, setgid installation of games is
8915: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8916: the other variables accordingly.</p>
8917: <p>A package should therefor never hard code file ownership or
8918: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8919: <code class="varname">INSTALL_GAME_DATA</code> to set these
8920: correctly.</p>
8921: </div>
8922: <div class="sect2" lang="en">
8923: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8924: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.4 rillig 8925: <div class="itemizedlist"><ul type="disc">
8926: <li><p>All installation operations have to be prefixed with
8927: <code class="filename">${DESTDIR}</code>.</p></li>
8928: <li><p>automake gets this DESTDIR mostly right
8929: automatically. Many manual rules and pre/post-install often are
8930: incorrect; fix them.</p></li>
8931: <li><p>If files are installed with special owner/group
8932: either use @owner/@group in the <code class="filename">PLIST</code>
8933: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8934: (discouraged). Note that @owner/@group are sticky during
8935: install, keep this in mind.</p></li>
8936: <li><p>In general, packages should support
8937: <code class="varname">UNPRIVILEGED</code> to be able to use
8938: DESTDIR.</p></li>
8939: </ul></div>
8940: </div>
8941: <div class="sect2" lang="en">
8942: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8943: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 8944: <p>Your package may also contain scripts with hardcoded paths to
8945: other interpreters besides (or as well as) perl. To correct the
8946: full pathname to the script interpreter, you need to set the
8947: following definitions in your <code class="filename">Makefile</code> (we
8948: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8949: <pre class="programlisting">
8950: REPLACE_INTERPRETER+= tcl
8951: REPLACE.tcl.old= .*/bin/tclsh
8952: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8953: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8954: # relative to ${WRKSRC}, just as in REPLACE_PERL
8955: </pre>
8956: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8957: <h3 class="title">Note</h3>
8958: <p>Before March 2006, these variables were called
8959: <code class="varname">_REPLACE.*</code> and
8960: <code class="varname">_REPLACE_FILES.*</code>.</p>
8961: </div>
8962: </div>
8963: <div class="sect2" lang="en">
8964: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8965: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 8966: <p>Makefiles of packages providing perl5 modules should include
8967: the Makefile fragment
8968: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8969: <span><strong class="command">do-configure</strong></span> target for the standard perl
8970: configuration for such modules as well as various hooks to tune
8971: this configuration. See comments in this file for
8972: details.</p>
8973: <p>Perl5 modules will install into different places depending
8974: on the version of perl used during the build process. To
8975: address this, pkgsrc will append lines to the
8976: <code class="filename">PLIST</code> corresponding to the files listed in
8977: the installed <code class="filename">.packlist</code> file generated by
8978: most perl5 modules. This is invoked by defining
8979: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8980: paths to packlist files, e.g.:</p>
8981: <pre class="programlisting">
8982: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8983: </pre>
8984: <p>The variables <code class="varname">PERL5_SITELIB</code>,
8985: <code class="varname">PERL5_SITEARCH</code>, and
8986: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8987: in which perl5 modules may be installed, and may be used by
8988: perl5 packages that don't have a packlist. These three
8989: variables are also substituted for in the
8990: <code class="filename">PLIST</code>.</p>
8991: </div>
8992: <div class="sect2" lang="en">
8993: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8994: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 8995: <p>Some packages install info files or use the
8996: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8997: commands. <code class="varname">INFO_FILES</code> should be defined in
8998: the package Makefile so that <code class="filename">INSTALL</code> and
8999: <code class="filename">DEINSTALL</code> scripts will be generated to
9000: handle registration of the info files in the Info directory
9001: file. The “<span class="quote">install-info</span>” command used for the info
9002: files registration is either provided by the system, or by a
9003: special purpose package automatically added as dependency if
9004: needed.</p>
9005: <p><code class="varname">PKGINFODIR</code> is the directory under
9006: <code class="filename">${PREFIX}</code> where info files are primarily
9007: located. <code class="varname">PKGINFODIR</code> defaults to
9008: “<span class="quote">info</span>” and can be overridden by the user.</p>
9009: <p>The info files for the package should be listed in the
9010: package <code class="filename">PLIST</code>; however any split info files
9011: need not be listed.</p>
9012: <p>A package which needs the “<span class="quote">makeinfo</span>” command
9013: at build time must add “<span class="quote">makeinfo</span>” to
9014: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
9015: version of the “<span class="quote">makeinfo</span>” command is needed it
9016: should be noted with the <code class="varname">TEXINFO_REQD</code>
9017: variable in the package <code class="filename">Makefile</code>. By
9018: default, a minimum version of 3.12 is required. If the system
9019: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
9020: does not match the required minimum, a build dependency on the
9021: <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
9022: be added automatically.</p>
9023: <p>The build and installation process of the software provided
9024: by the package should not use the
9025: <span><strong class="command">install-info</strong></span> command as the registration of
9026: info files is the task of the package
9027: <code class="filename">INSTALL</code> script, and it must use the
9028: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
9029: <p>To achieve this goal, the pkgsrc infrastructure creates
9030: overriding scripts for the <span><strong class="command">install-info</strong></span> and
9031: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
9032: in <code class="varname">PATH</code>.</p>
9033: <p>The script overriding <span><strong class="command">install-info</strong></span> has
9034: no effect except the logging of a message. The script overriding
9035: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
9036: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
9037: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
9038: </div>
9039: <div class="sect2" lang="en">
9040: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9041: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9042: <p>All packages that install manual pages should install them
9043: into the same directory, so that there is one common place to look
9044: for them. In pkgsrc, this place is
9045: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9046: should be used in packages. The default for
9047: <code class="varname">PKGMANDIR</code> is
9048: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
9049: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
9050: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9051: <h3 class="title">Note</h3>
9052: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9053: is far from complete.</p>
9054: </div>
9055: <p>The <code class="filename">PLIST</code> files can just use
9056: <code class="filename">man/</code> as the top level directory for the man
9057: page file entries, and the pkgsrc framework will convert as
9058: needed. In all other places, the correct
9059: <code class="varname">PKGMANDIR</code> must be used.</p>
9060: <p>Packages that are
9061: configured with <code class="varname">GNU_CONFIGURE</code> set as
9062: “<span class="quote">yes</span>”, by default will use the
9063: <code class="filename">./configure</code>
9064: --mandir switch to set where the man pages should be installed.
9065: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9066: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9067: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9068: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
9069: to “<span class="quote">no</span>”.
9070: Or if the <code class="filename">./configure</code> script uses
9071: a non-standard use of --mandir, you can set
9072: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.6 rillig 9073: <p>See <a href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 9074: information on installation of compressed manual pages.</p>
9075: </div>
9076: <div class="sect2" lang="en">
9077: <div class="titlepage"><div><div><h3 class="title">
1.7 ! rillig 9078: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 9079: <p>If a package installs <code class="filename">.schemas</code> or
1.7 ! rillig 9080: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 9081: you need to take some extra steps to make sure they get registered
9082: in the database:</p>
9083: <div class="orderedlist"><ol type="1">
1.7 ! rillig 9084: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 9085: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 ! rillig 9086: takes care of rebuilding the GConf database at installation and
1.1 dsieger 9087: deinstallation time, and tells the package where to install
1.7 ! rillig 9088: GConf data files using some standard configure arguments. It
1.1 dsieger 9089: also disallows any access to the database directly from the
9090: package.</p></li>
9091: <li><p>Ensure that the package installs its
9092: <code class="filename">.schemas</code> files under
9093: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9094: installed under <code class="filename">${PREFIX}/etc</code>, you will
9095: need to manually patch the package.</p></li>
9096: <li><p>Check the PLIST and remove any entries under the etc/gconf
9097: directory, as they will be handled automatically. See
1.6 rillig 9098: <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 9099: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 9100: your <code class="filename">Makefile</code> with a list of all
9101: <code class="filename">.schemas</code> files installed by the package, if
9102: any. Names must not contain any directories in them.</p></li>
1.7 ! rillig 9103: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 9104: your <code class="filename">Makefile</code> with a
9105: list of all <code class="filename">.entries</code> files installed by the
9106: package, if any. Names must not contain any directories in
9107: them.</p></li>
9108: </ol></div>
9109: </div>
9110: <div class="sect2" lang="en">
9111: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9112: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.1 dsieger 9113: <p>If a package installs <code class="filename">.omf</code> files, used by
9114: scrollkeeper, you need to take some extra steps to make sure they
9115: get registered in the database:</p>
9116: <div class="orderedlist"><ol type="1">
9117: <li><p>Include
9118: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
9119: instead of its <code class="filename">buildlink3.mk</code> file. This
9120: takes care of rebuilding the scrollkeeper database at
9121: installation and deinstallation time, and disallows any access
9122: to it directly from the package.</p></li>
9123: <li><p>Check the PLIST and remove any entries under the
9124: <code class="filename">libdata/scrollkeeper</code> directory, as they
9125: will be handled automatically.</p></li>
9126: <li><p>Remove the <code class="filename">share/omf</code> directory from
9127: the PLIST. It will be handled by scrollkeeper.</p></li>
9128: </ol></div>
9129: </div>
9130: <div class="sect2" lang="en">
9131: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9132: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9133: <p>If a package installs font files, you will need to rebuild
9134: the fonts database in the directory where they get installed at
9135: installation and deinstallation time. This can be automatically
9136: done by using the pkginstall framework.</p>
9137: <p>You can list the directories where fonts are installed in the
9138: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9139: variables, where <em class="replaceable"><code>type</code></em> can be one of
9140: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9141: Also make sure that the database file
9142: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9143: <p>Note that you should not create new directories for fonts;
9144: instead use the standard ones to avoid that the user needs to
9145: manually configure his X server to find them.</p>
9146: </div>
9147: <div class="sect2" lang="en">
9148: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9149: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9150: <p>If a package installs GTK2 immodules or loaders, you need to
9151: take some extra steps to get them registered in the GTK2 database
9152: properly:</p>
9153: <div class="orderedlist"><ol type="1">
9154: <li><p>Include
9155: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9156: <code class="filename">buildlink3.mk</code> file. This takes care of
9157: rebuilding the database at installation and deinstallation time.</p></li>
9158: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9159: your package installs GTK2 immodules.</p></li>
9160: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9161: GTK2 loaders.</p></li>
9162: <li>
9163: <p>Patch the package to not touch any of the GTK2
9164: databases directly. These are:</p>
9165: <div class="itemizedlist"><ul type="disc">
9166: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9167: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
9168: </ul></div>
9169: </li>
9170: <li><p>Check the <code class="filename">PLIST</code> and remove
9171: any entries under the <code class="filename">libdata/gtk-2.0</code>
9172: directory, as they will be handled automatically.</p></li>
9173: </ol></div>
9174: </div>
9175: <div class="sect2" lang="en">
9176: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9177: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9178: <p>If a package installs SGML or XML data files that need to be
9179: registered in system-wide catalogs (like DTDs, sub-catalogs,
9180: etc.), you need to take some extra steps:</p>
9181: <div class="orderedlist"><ol type="1">
9182: <li><p>Include
9183: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9184: your <code class="filename">Makefile</code>, which takes care of
9185: registering those files in system-wide catalogs at
9186: installation and deinstallation time.</p></li>
9187: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
9188: any SGML catalogs installed by the package.</p></li>
9189: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
9190: any XML catalogs installed by the package.</p></li>
9191: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
9192: to be added to the SGML catalog. These come in groups of
9193: three strings; see xmlcatmgr(1) for more information
9194: (specifically, arguments recognized by the 'add' action).
9195: Note that you will normally not use this variable.</p></li>
9196: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
9197: to be added to the XML catalog. These come in groups of three
9198: strings; see xmlcatmgr(1) for more information (specifically,
9199: arguments recognized by the 'add' action). Note that you will
9200: normally not use this variable.</p></li>
9201: </ol></div>
9202: </div>
9203: <div class="sect2" lang="en">
9204: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9205: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9206: <p>If a package provides extensions to the MIME database by
9207: installing <code class="filename">.xml</code> files inside
9208: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9209: need to take some extra steps to ensure that the database is kept
9210: consistent with respect to these new files:</p>
9211: <div class="orderedlist"><ol type="1">
9212: <li><p>Include
9213: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9214: (avoid using the <code class="filename">buildlink3.mk</code> file from
9215: this same directory, which is reserved for inclusion from
9216: other <code class="filename">buildlink3.mk</code> files). It takes
9217: care of rebuilding the MIME database at installation and
9218: deinstallation time, and disallows any access to it directly
9219: from the package.</p></li>
9220: <li><p>Check the PLIST and remove any entries under the
9221: <code class="filename">share/mime</code> directory,
9222: <span class="emphasis"><em>except</em></span> for files saved under
9223: <code class="filename">share/mime/packages</code>. The former are
9224: handled automatically by
9225: the update-mime-database program, but the latter are
9226: package-dependent and must be removed by the package that
9227: installed them in the first place.</p></li>
9228: <li><p>Remove any <code class="filename">share/mime/*</code> directories
9229: from the PLIST. They will be handled by the shared-mime-info
9230: package.</p></li>
9231: </ol></div>
9232: </div>
9233: <div class="sect2" lang="en">
9234: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9235: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9236: <p>If a package uses intltool during its build, add
9237: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9238: which forces it to use the intltool package provided by pkgsrc,
9239: instead of the one bundled with the distribution file.</p>
9240: <p>This tracks intltool's build-time dependencies and uses the
9241: latest available version; this way, the package benefits of any
9242: bug fixes that may have appeared since it was released.</p>
9243: </div>
9244: <div class="sect2" lang="en">
9245: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9246: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9247: <p>If a package contains a rc.d script, it won't be copied into
9248: the startup directory by default, but you can enable it, by adding
9249: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.4 rillig 9250: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9251: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9252: it will automatically remove the scripts when the package is
9253: deinstalled.</p>
9254: </div>
9255: <div class="sect2" lang="en">
9256: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9257: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9258: <p>If a package installs TeX packages into the texmf tree,
9259: the <code class="filename">ls-R</code> database of the tree needs to be
9260: updated.</p>
9261: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9262: <h3 class="title">Note</h3>
9263: <p>Except the main TeX packages such as teTeX-texmf,
9264: packages should install files
9265: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9266: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
9267: </div>
9268: <div class="orderedlist"><ol type="1">
9269: <li><p>Include
9270: <code class="filename">../../print/teTeX/module.mk</code> instead
9271: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9272: takes care of rebuilding the <code class="filename">ls-R</code>
9273: database at installation and deinstallation time.</p></li>
9274: <li>
9275: <p>If your package installs files into a texmf
9276: tree other than the one
9277: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9278: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9279: trees that need database update.</p>
9280: <p>If your package also installs font map files that need
9281: to be registered using <span><strong class="command">updmap</strong></span>,
9282: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9283: such font map files. Then <span><strong class="command">updmap</strong></span> will
9284: be run automatically at installation/deinstallation to
9285: enable/disable font map files for TeX output
9286: drivers.</p>
9287: </li>
9288: <li><p>Make sure that none of <code class="filename">ls-R</code>
9289: databases are included in <code class="filename">PLIST</code>, as
9290: they will be removed only by the teTeX-bin package.</p></li>
9291: </ol></div>
9292: </div>
9293: <div class="sect2" lang="en">
9294: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9295: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9296: emulation</h3></div></div></div>
9297: <p>There are some packages that provide libraries and
9298: executables for running binaries from a one operating system
9299: on a different one (if the latter supports it). One example
9300: is running Linux binaries on NetBSD.</p>
9301: <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>
9302: helps in extracting and packaging Linux rpm packages.</p>
9303: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9304: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9305: if all libraries for each installed executable can be found by
9306: the dynamic linker. Since the standard dynamic linker is run,
9307: this fails for emulation packages, because the libraries used
9308: by the emulation are not in the standard directories.</p>
9309: </div>
9310: <div class="sect2" lang="en">
9311: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9312: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9313: <p>If a package installs images under the
9314: <code class="filename">share/icons/hicolor</code> and/or updates the
9315: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9316: database, you need to take some extra steps to make sure that the
9317: shared theme directory is handled appropriately and that the cache
9318: database is rebuilt:</p>
9319: <div class="orderedlist"><ol type="1">
9320: <li><p>Include
9321: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9322: <li><p>Check the <code class="filename">PLIST</code> and remove the
9323: entry that refers to the theme cache.</p></li>
9324: <li><p>Ensure that the PLIST does not remove the shared icon
9325: directories from the <code class="filename">share/icons/hicolor</code>
9326: hierarchy because they will be handled automatically.</p></li>
9327: </ol></div>
9328: <p>The best way to verify that the PLIST is correct with
9329: respect to the last two points is to regenerate it using
9330: <span><strong class="command">make print-PLIST</strong></span>.</p>
9331: </div>
9332: <div class="sect2" lang="en">
9333: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9334: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9335: <p>If a package installs <code class="filename">.desktop</code> files
9336: under <code class="filename">share/applications</code> and these include
9337: MIME information, you need to take extra steps to ensure that they
9338: are registered into the MIME database:</p>
9339: <div class="orderedlist"><ol type="1">
9340: <li><p>Include
9341: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9342: <li><p>Check the PLIST and remove the entry that refers to the
9343: <code class="filename">share/applications/mimeinfo.cache</code> file.
9344: It will be handled automatically.</p></li>
9345: </ol></div>
9346: <p>The best way to verify that the PLIST is correct with
9347: respect to the last point is to regenerate it using <span><strong class="command">make
9348: print-PLIST</strong></span>.</p>
9349: </div>
9350: </div>
9351: <div class="sect1" lang="en">
9352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9353: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9354: <p>In some cases one does not have the time to solve a problem
9355: immediately. There are currently two ways to declare that one knows
9356: that a package has problems.</p>
9357: <div class="itemizedlist"><ul type="disc">
9358: <li><p>The first way is to plainly mark it as broken. For
9359: this, one just sets the variable <code class="varname">BROKEN</code> to the
9360: reason why the package is broken (similar to the
9361: <code class="varname">RESTRICTED</code> variable). A user trying to build
9362: the package will immediately be shown this message, and the build
9363: will not be even tried.</p></li>
9364: <li><p>After each pkgsrc freeze period (a time when the
9365: tree is stabilized and a new pkgsrc branch is cut), the packages
9366: that were not building in the official branch build on the latest
9367: NetBSD release will be marked as broken on that branch. This is
9368: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9369: branch name (or appending the branch name to it). If a user tries
9370: to build such a package and the build fails, the user gets a
9371: message that says that the package was broken on the respective
9372: branch(es).</p></li>
9373: </ul></div>
9374: <p>Both types of packages are removed from pkgsrc in irregular
9375: intervals.</p>
9376: </div>
9377: </div>
9378: <div class="chapter" lang="en">
9379: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9380: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9381: <p>To check out all the gotchas when building a package, here are
9382: the steps that I do in order to get a package working. Please note
9383: this is basically the same as what was explained in the previous
9384: sections, only with some debugging aids.</p>
9385: <div class="itemizedlist"><ul type="disc">
1.4 rillig 9386: <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 9387: <li>
9388: <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>,
9389: create a directory for a new package, change into it, then run
9390: <span><strong class="command">url2pkg</strong></span>:</p>
9391: <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>
9392: <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>
9393: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9394: </li>
9395: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9396: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9397: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
9398: <li><p>Add any dependencies glimpsed from documentation and the
9399: configure step to the package's
9400: <code class="filename">Makefile</code>.</p></li>
9401: <li>
9402: <p>Make the package compile, doing multiple rounds of</p>
9403: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9404: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9405: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9406: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9407: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9408: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9409: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9410: <p>Doing this step as non-root user will ensure that no files
9411: are modified that shouldn't be, especially during the build
9412: phase. <span><strong class="command">mkpatches</strong></span>,
9413: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
9414: 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>
9415: package.</p>
9416: </li>
9417: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.6 rillig 9418: necessary; see <a href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.1 dsieger 9419: <li>
9420: <p>Generate a <code class="filename">PLIST</code>:</p>
9421: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9422: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9423: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9424: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9425: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9426: <p>You usually need to be <code class="username">root</code> to do
9427: this. Look if there are any files left:</p>
9428: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9429: <p>If this reveals any files that are missing in
9430: <code class="filename">PLIST</code>, add them.</p>
9431: </li>
9432: <li>
9433: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9434: package again and make a binary package:</p>
9435: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9436: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9437: </li>
9438: <li>
9439: <p>Delete the installed package:</p>
9440: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9441: </li>
9442: <li>
9443: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9444: command, which shouldn't find anything now:</p>
9445: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9446: </li>
9447: <li>
9448: <p>Reinstall the binary package:</p>
9449: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9450: </li>
9451: <li><p>Play with it. Make sure everything works.</p></li>
9452: <li>
9453: <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
9454: reports:</p>
9455: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9456: </li>
1.6 rillig 9457: <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 9458: </ul></div>
9459: </div>
9460: <div class="chapter" lang="en">
9461: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9462: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9463: <div class="toc">
9464: <p><b>Table of Contents</b></p>
9465: <dl>
1.6 rillig 9466: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9467: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9468: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9469: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9470: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9471: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9472: </dl>
9473: </div>
9474: <div class="sect1" lang="en">
9475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9476: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9477: <p>Our policy is that we accept binaries only from pkgsrc
9478: developers to guarantee that the packages don't contain any
9479: trojan horses etc. This is not to annoy anyone but rather to
9480: protect our users! You're still free to put up your home-made
9481: binary packages and tell the world where to get them. NetBSD
9482: developers doing bulk builds and wanting to upload them please
1.6 rillig 9483: 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 9484: </div>
9485: <div class="sect1" lang="en">
9486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9487: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9488: <p>First, check that your package is complete, compiles and
1.6 rillig 9489: runs well; see <a href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.1 dsieger 9490: 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>
9491: archive that contains all files that make up the package.
9492: Finally, send this package to the pkgsrc bug tracking system,
9493: 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
9494: that, go to the web page
1.4 rillig 9495: <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.1 dsieger 9496: which contains some instructions and a link to a form, where you
9497: can submit packages.</p>
9498: <p>In the form of the problem report, the category should be
9499: “<span class="quote">pkg</span>”, the synopsis should include the package name
9500: and version number, and the description field should contain a
9501: short description of your package (contents of the COMMENT
9502: variable or DESCR file are OK). The uuencoded package data should
9503: go into the “<span class="quote">fix</span>” field.</p>
9504: <p>If you want to submit several packages, please send a
9505: separate PR for each one, it's easier for us to track things
9506: that way.</p>
9507: <p>Alternatively, you can also import new packages into
9508: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9509: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9510: for details.</p>
9511: </div>
9512: <div class="sect1" lang="en">
9513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9514: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9515: <p>Please note all package additions, updates, moves, and
9516: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9517: important to keep this file up to date and conforming to the
9518: existing format, because it will be used by scripts to
9519: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9520: sites. Additionally, check the
9521: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9522: for the package you updated or removed, in case it was mentioned
9523: there.</p>
9524: <p>When the <code class="varname">PKGREVISION</code> of a package is
9525: bumped, the change should appear in
9526: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9527: related or otherwise relevant. Mass bumps that result from a
9528: dependency being updated should not be mentioned. In all other
9529: cases it's the developer's decision.</p>
9530: <p>There is a make target that helps in creating proper
9531: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
9532: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9533: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9534: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9535: file is up-to-date (to avoid having to resolve conflicts later-on)
9536: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9537: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9538: For new packages, or package moves or removals, set the
9539: <code class="varname">CTYPE</code> variable on the command line to "Added",
9540: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.4 rillig 9541: in <a href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1 dsieger 9542: not the same as your NetBSD login name. Don't forget to commit
9543: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
9544: </div>
9545: <div class="sect1" lang="en">
9546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9547: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1 dsieger 9548: <p>This section is only of interest for pkgsrc developers with write
9549: access to the pkgsrc repository. Please remember that cvs
9550: imports files relative to the current working directory, and that
9551: the pathname that you
9552: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9553: to place the files in the repository. Newly created packages should be
9554: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
9555: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
9556: <pre class="programlisting">
9557: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9558: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9559: </pre>
9560: <p>Remember to move the directory from which you imported out of
9561: the way, or cvs will complain the next time you “<span class="quote">cvs
9562: update</span>” your source tree. Also don't forget to add the new
9563: package to the category's <code class="filename">Makefile</code>.</p>
9564: <p>The commit message of the initial import should include part of the
9565: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9566: what the package is/does.</p>
9567: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
9568: add</span>” because the former gets everything with a single command,
9569: and provides a consistent tag.</p>
9570: </div>
9571: <div class="sect1" lang="en">
9572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9573: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9574: <p>Please always put a concise, appropriate and relevant summary of the
9575: changes between old and new versions into the commit log when updating
9576: a package. There are various reasons for this:</p>
9577: <div class="itemizedlist"><ul type="disc">
9578: <li><p>A URL is volatile, and can change over time. It may go away completely
9579: or its information may be overwritten by newer information.</p></li>
9580: <li><p>Having the change information between old and new versions in our CVS
9581: repository is very useful for people who use either cvs or anoncvs.</p></li>
9582: <li><p>Having the change information between old and new versions in our CVS
9583: repository is very useful for people who read the pkgsrc-changes mailing
9584: list, so that they can make tactical decisions about when to upgrade
9585: the package.</p></li>
9586: </ul></div>
9587: <p>Please also recognize that, just because a new version of a package
9588: has been released, it should not automatically be upgraded in the CVS
9589: repository. We prefer to be conservative in the packages that are
9590: included in pkgsrc - development or beta packages are not really the
9591: best thing for most places in which pkgsrc is used. Please use your
9592: judgement about what should go into pkgsrc, and bear in mind that
9593: stability is to be preferred above new and possibly untested features.</p>
9594: </div>
9595: <div class="sect1" lang="en">
9596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9597: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.1 dsieger 9598: <div class="orderedlist"><ol type="1">
9599: <li><p>Make a copy of the directory somewhere else.</p></li>
9600: <li>
9601: <p>Remove all CVS dirs.</p>
9602: <p>Alternatively to the first two steps you can also do:</p>
9603: <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>
9604: <p>and use that for further work.</p>
9605: </li>
9606: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9607: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9608: instead of “<span class="quote">../../category/package</span>”.</p></li>
9609: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9610: place.</p></li>
9611: <li>
9612: <p>Check if any package depends on it:
9613: </p>
9614: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9615: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9616: </li>
9617: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9618: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
9619: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9620: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9621: <li>
9622: <p>Commit the changed and removed files:</p>
9623: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9624: <p>(and any packages from step 5, of course).</p>
9625: </li>
9626: </ol></div>
9627: </div>
9628: </div>
9629: <div class="chapter" lang="en">
9630: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9631: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9632: <p>This section contains the answers to questions that may
9633: arise when you are writing a package. If you don't find your
9634: question answered here, first have a look in the other chapters,
9635: and if you still don't have the answer, ask on the
9636: <code class="literal">pkgsrc-users</code> mailing list.</p>
9637: <div class="qandaset">
9638: <dl>
1.6 rillig 9639: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9640: MAKEFLAGS, .MAKEFLAGS and
9641: MAKE_FLAGS?</a>
9642: </dt>
1.6 rillig 9643: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9644: MAKE, GMAKE and
9645: MAKE_PROGRAM?</a>
9646: </dt>
1.6 rillig 9647: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9648: CC, PKG_CC and
9649: PKGSRC_COMPILER?</a>
9650: </dt>
1.6 rillig 9651: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9652: BUILDLINK_LDFLAGS,
9653: BUILDLINK_LDADD and
9654: BUILDLINK_LIBS?</a>
9655: </dt>
1.6 rillig 9656: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9657: VARNAME=BUILDLINK_PREFIX.foo
9658: say it's empty?</a>
9659: </dt>
1.6 rillig 9660: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9661: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9662: don't understand the := inside
9663: it.</a>
9664: </dt>
1.6 rillig 9665: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9666: developers?</a>
9667: </dt>
1.6 rillig 9668: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9669: documentation?</a>
9670: </dt>
1.6 rillig 9671: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9672: do?</a>
9673: </dt>
9674: </dl>
9675: <table border="0" summary="Q and A Set">
9676: <col align="left" width="1%">
9677: <tbody>
9678: <tr class="question">
9679: <td align="left" valign="top">
1.7 ! rillig 9680: <a name="devfaq.makeflags"></a><a name="id2713947"></a><b>22.1.</b>
1.1 dsieger 9681: </td>
9682: <td align="left" valign="top"><p>What is the difference between
9683: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9684: <code class="varname">MAKE_FLAGS</code>?</p></td>
9685: </tr>
9686: <tr class="answer">
9687: <td align="left" valign="top"></td>
9688: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9689: 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
9690: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9691: the <code class="varname">MAKE_PROGRAM</code> when building the
9692: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9693: </tr>
9694: <tr class="question">
9695: <td align="left" valign="top">
1.7 ! rillig 9696: <a name="devfaq.make"></a><a name="id2713986"></a><b>22.2.</b>
1.1 dsieger 9697: </td>
9698: <td align="left" valign="top"><p>What is the difference between
9699: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9700: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9701: </tr>
9702: <tr class="answer">
9703: <td align="left" valign="top"></td>
9704: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9705: <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
9706: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9707: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9708: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9709: Make program that is used for building the
9710: package.</p></td>
9711: </tr>
9712: <tr class="question">
9713: <td align="left" valign="top">
1.7 ! rillig 9714: <a name="devfaq.cc"></a><a name="id2714026"></a><b>22.3.</b>
1.1 dsieger 9715: </td>
9716: <td align="left" valign="top"><p>What is the difference between
9717: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9718: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9719: </tr>
9720: <tr class="answer">
9721: <td align="left" valign="top"></td>
9722: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9723: compiler, which can be configured by the pkgsrc user.
9724: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9725: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9726: path to a compiler, but the type of compiler that should be
9727: used. See <code class="filename">mk/compiler.mk</code> for more
9728: information about the latter variable.</p></td>
9729: </tr>
9730: <tr class="question">
9731: <td align="left" valign="top">
1.7 ! rillig 9732: <a name="devfaq.bl3flags"></a><a name="id2714066"></a><b>22.4.</b>
1.1 dsieger 9733: </td>
9734: <td align="left" valign="top"><p>What is the difference between
9735: <code class="varname">BUILDLINK_LDFLAGS</code>,
9736: <code class="varname">BUILDLINK_LDADD</code> and
9737: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9738: </tr>
9739: <tr class="answer">
9740: <td align="left" valign="top"></td>
9741: <td align="left" valign="top"><p>[FIXME]</p></td>
9742: </tr>
9743: <tr class="question">
9744: <td align="left" valign="top">
1.7 ! rillig 9745: <a name="devfaq.bl3prefix"></a><a name="id2714086"></a><b>22.5.</b>
1.1 dsieger 9746: </td>
9747: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9748: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9749: say it's empty?</p></td>
9750: </tr>
9751: <tr class="answer">
9752: <td align="left" valign="top"></td>
9753: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9754: available in the “<span class="quote">wrapper</span>” phase and later. To
9755: “<span class="quote">simulate</span>” the wrapper phase, append
9756: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9757: command.</p></td>
9758: </tr>
9759: <tr class="question">
9760: <td align="left" valign="top">
1.7 ! rillig 9761: <a name="devfaq.master_sites"></a><a name="id2714116"></a><b>22.6.</b>
1.1 dsieger 9762: </td>
9763: <td align="left" valign="top"><p>What does
9764: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9765: don't understand the <code class="literal">:=</code> inside
9766: it.</p></td>
9767: </tr>
9768: <tr class="answer">
9769: <td align="left" valign="top"></td>
9770: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9771: assignment operator, like you might expect at first sight.
9772: Instead, it is a degenerate form of
9773: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9774: 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
9775: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9776: case of <code class="varname">MASTER_SITE_*</code>,
9777: <em class="replaceable"><code>old_string</code></em> is the empty string and
9778: <em class="replaceable"><code>new_string</code></em> is
9779: <code class="literal">package/</code>. That's where the
9780: <code class="literal">:</code> and the <code class="literal">=</code> fall
9781: together.</p></td>
9782: </tr>
9783: <tr class="question">
9784: <td align="left" valign="top">
1.7 ! rillig 9785: <a name="devfaq.mailinglists"></a><a name="id2714261"></a><b>22.7.</b>
1.1 dsieger 9786: </td>
9787: <td align="left" valign="top"><p>Which mailing lists are there for package
9788: developers?</p></td>
9789: </tr>
9790: <tr class="answer">
9791: <td align="left" valign="top"></td>
9792: <td align="left" valign="top"><div class="variablelist"><dl>
1.4 rillig 9793: <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 9794: <dd><p>This is a list for technical discussions related
9795: to pkgsrc development, e.g. soliciting feedback for changes to
9796: pkgsrc infrastructure, proposed new features, questions related
9797: to porting pkgsrc to a new platform, advice for maintaining a
9798: package, patches that affect many packages, help requests moved
9799: from pkgsrc-users when an infrastructure bug is found,
9800: etc.</p></dd>
1.4 rillig 9801: <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 9802: <dd><p>All bug reports in category "pkg" sent with
9803: <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
9804: directly; use one of the other mailing
9805: lists.</p></dd>
9806: </dl></div></td>
9807: </tr>
9808: <tr class="question">
9809: <td align="left" valign="top">
1.7 ! rillig 9810: <a name="devfaq.documentation"></a><a name="id2714299"></a><b>22.8.</b>
1.1 dsieger 9811: </td>
9812: <td align="left" valign="top"><p>Where is the pkgsrc
9813: documentation?</p></td>
9814: </tr>
9815: <tr class="answer">
9816: <td align="left" valign="top"></td>
9817: <td align="left" valign="top">
9818: <p>There are many places where you can find
9819: documentation about pkgsrc:</p>
9820: <div class="itemizedlist"><ul type="disc">
9821: <li><p>The pkgsrc guide (this document) is a collection
9822: of chapters that explain large parts of pkgsrc, but some
9823: chapters tend to be outdated. Which ones they are is hard to
9824: say.</p></li>
9825: <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
9826: about certain features, announcements of new parts of the pkgsrc
9827: infrastructure and sometimes even announcements that a certain
9828: feature has been marked as obsolete. The benefit here is that
9829: each message has a date appended to it.</p></li>
9830: <li><p>Many of the files in the
9831: <code class="filename">mk/</code> directory start with a comment that
9832: describes the purpose of the file and how it can be used by the
9833: pkgsrc user and package authors. An easy way to find this
9834: documentation is to run <span><strong class="command">bmake
9835: help</strong></span>.</p></li>
9836: <li><p>The CVS log messages are a rich source of
9837: information, but they tend to be highly abbreviated, especially
9838: for actions that occur often. Some contain a detailed
9839: description of what has changed, but they are geared towards the
9840: other pkgsrc developers, not towards an average pkgsrc user.
9841: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9842: don't know what has been before, these messages may not be worth
9843: too much to you.</p></li>
9844: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9845: documented</span>”, that is the documentation exists only in the
9846: mind of the developer who wrote the code. To get this
9847: information, use the <span><strong class="command">cvs annotate</strong></span> command
9848: to see who has written it and ask on the
9849: <code class="literal">tech-pkg</code> mailing list, so that others can
9850: find your questions later (see above). To be sure that the
9851: developer in charge reads the mail, you may CC him or
9852: her.</p></li>
9853: </ul></div>
9854: </td>
9855: </tr>
9856: <tr class="question">
9857: <td align="left" valign="top">
1.7 ! rillig 9858: <a name="devfaq.too-much-time"></a><a name="id2714361"></a><b>22.9.</b>
1.1 dsieger 9859: </td>
9860: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9861: do?</p></td>
9862: </tr>
9863: <tr class="answer">
9864: <td align="left" valign="top"></td>
9865: <td align="left" valign="top">
9866: <p>This is not really an FAQ yet, but here's the answer
9867: anyway.</p>
9868: <div class="itemizedlist"><ul type="disc">
9869: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9870: <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
9871: will tell you about newer versions of installed packages that are
9872: available, but not yet updated in pkgsrc.</p></li>
9873: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.6 rillig 9874: — it contains a list of suggested new packages and a list of
1.1 dsieger 9875: cleanups and enhancements for pkgsrc that would be nice to
9876: have.</p></li>
9877: <li><p>Review packages for which review was requested on
9878: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9879: mailing list.</p></li>
9880: </ul></div>
9881: </td>
9882: </tr>
9883: </tbody>
9884: </table>
9885: </div>
9886: </div>
9887: <div class="chapter" lang="en">
9888: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9889: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 9890: <div class="toc">
9891: <p><b>Table of Contents</b></p>
9892: <dl>
1.6 rillig 9893: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9894: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9895: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9896: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 9897: </dl>
9898: </div>
9899: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9900: site</a>:</p>
9901: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9902: environment, an intuitive and attractive desktop for users, and the
9903: GNOME development platform, an extensive framework for building
9904: applications that integrate into the rest of the desktop.</p></blockquote></div>
9905: <p>pkgsrc provides a seamless way to automatically build and install
9906: a complete GNOME environment <span class="emphasis"><em>under many different
9907: platforms</em></span>. We can say with confidence that pkgsrc is one of
9908: the most advanced build and packaging systems for GNOME due to its
9909: included technologies buildlink3, the wrappers and tools framework and
9910: automatic configuration file management. Lots of efforts are put into
9911: achieving a completely clean deinstallation of installed software
9912: components.</p>
9913: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9914: the above also means that great efforts are put into making GNOME work
9915: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9916: pkgsrc as its preferred packaging system, contributing lots of
9917: portability fixes to make GNOME build and install under it.</p>
9918: <p>This chapter is aimed at pkgsrc developers and other people
9919: interested in helping our GNOME porting and packaging efforts. It
9920: provides instructions on how to manage the existing packages and some
9921: important information regarding their internals.</p>
9922: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9923: <h3 class="title">We need your help!</h3>
9924: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9925: and GNOME and are willing to learn new exciting stuff, please jump
9926: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9927: work</a> list! There is still a long way to go to get a
9928: fully-functional GNOME desktop under NetBSD and we need your help to
9929: achieve it!</p>
9930: </div>
9931: <div class="sect1" lang="en">
9932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9933: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 9934: <p>pkgsrc includes three GNOME-related meta packages:</p>
9935: <div class="itemizedlist"><ul type="disc">
9936: <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
9937: the core GNOME desktop environment. It only includes the necessary
9938: bits to get it to boot correctly, although it may lack important
9939: functionality for daily operation. The idea behind this package is
9940: to let end users build their own configurations on top of this one,
9941: first installing this meta package to achieve a functional setup and
9942: then adding individual applications.</p></li>
9943: <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
9944: complete installation of the GNOME platform and desktop as defined
9945: by the GNOME project; this is based on the components distributed in
9946: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9947: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9948: official FTP server. Developer-only tools found in those
9949: directories are not installed unless required by some other
9950: component to work properly. Similarly, packages from the bindings
9951: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9952: in unless required as a dependency for an end-user component. This
9953: 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>
9954: <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>:
9955: Installs all the tools required to build a GNOME component when
9956: fetched from the CVS repository. These are required to let the
9957: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9958: </ul></div>
9959: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9960: sorted in a way that eases updates: a package may depend on other
9961: packages listed before it but not on any listed after it. It is very
9962: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9963: change it to alphabetical sorting!</em></span></p>
9964: </div>
9965: <div class="sect1" lang="en">
9966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9967: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 9968: <p>Almost all GNOME applications are written in C and use a common
9969: set of tools as their build system. Things get different with the new
9970: bindings to other languages (such as Python), but the following will
9971: give you a general idea on the minimum required tools:</p>
9972: <div class="itemizedlist"><ul type="disc">
9973: <li>
9974: <p>Almost all GNOME applications use the GNU Autotools as their
9975: build system. As a general rule you will need to tell this to your
9976: package:</p>
9977: <pre class="programlisting">
9978: GNU_CONFIGURE=yes
9979: USE_LIBTOOL=yes
9980: USE_TOOLS+=gmake
9981: </pre>
9982: </li>
9983: <li>
9984: <p>If the package uses pkg-config to detect dependencies, add this
9985: tool to the list of required utilities:</p>
9986: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9987: <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
9988: the end of the build process to ensure that you did not miss to
9989: specify any dependency in your package and that the version
9990: requirements are all correct.</p>
9991: </li>
9992: <li><p>If the package uses intltool, be sure to add
9993: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9994: to handle dependencies and to force the package to use the latest
9995: available version.</p></li>
9996: <li>
9997: <p>If the package uses gtk-doc (a documentation generation
9998: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9999: tool is rather big and the distfile should come with pregenerated
10000: documentation anyway; if it does not, it is a bug that you ought to
10001: report. For such packages you should disable gtk-doc (unless it is
10002: the default):</p>
10003: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
10004: <p>The default location of installed HTML files
10005: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
10006: and should not be changed unless the package insists on installing
10007: them somewhere else. Otherwise programs as
10008: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
10009: do that with an entry similar to:</p>
10010: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
10011: </li>
10012: </ul></div>
10013: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
10014: files under the installation prefix to maintain databases. In this
10015: context, shared means that those exact same directories and files are
10016: used among several different packages, leading to conflicts in the
10017: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
10018: handle the most common cases, so you have to forget about using
10019: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
10020: omitting shared files from them. If you find yourself doing those,
10021: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
10022: <p>The following table lists the common situations that result in
10023: using shared directories or files. For each of them, the appropriate
10024: solution is given. After applying the solution be sure to
10025: <span class="emphasis"><em>regenerate the package's file list</em></span> with
10026: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
10027: <div class="table">
1.6 rillig 10028: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 10029: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
10030: <colgroup>
10031: <col>
10032: <col>
10033: </colgroup>
10034: <thead><tr>
10035: <th>If the package...</th>
10036: <th>Then...</th>
10037: </tr></thead>
10038: <tbody>
10039: <tr>
10040: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.6 rillig 10041: <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 10042: </tr>
10043: <tr>
10044: <td>Installs icons under the
10045: <code class="filename">share/icons/hicolor</code> hierarchy or updates
10046: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.6 rillig 10047: <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 10048: </tr>
10049: <tr>
10050: <td>Installs files under
10051: <code class="filename">share/mime/packages</code>.</td>
1.6 rillig 10052: <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 10053: </tr>
10054: <tr>
10055: <td>Installs <code class="filename">.desktop</code> files under
10056: <code class="filename">share/applications</code> and these include MIME
10057: information.</td>
1.6 rillig 10058: <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 10059: </tr>
10060: </tbody>
10061: </table></div>
10062: </div>
10063: <br class="table-break">
10064: </div>
10065: <div class="sect1" lang="en">
10066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10067: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 10068: <p>When seeing GNOME as a whole, there are two kinds of
10069: updates:</p>
10070: <div class="variablelist"><dl>
10071: <dt><span class="term">Major update</span></dt>
10072: <dd>
10073: <p>Given that there is still a very long way for GNOME 3 (if it
10074: ever appears), we consider a major update one that goes from a
10075: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10076: where <code class="literal">Y</code> is even and greater than
10077: <code class="literal">X</code>. These are hard to achieve because they
10078: introduce lots of changes in the components' code and almost all
10079: GNOME distfiles are updated to newer versions. Some of them can
10080: even break API and ABI compatibility with the previous major
10081: version series. As a result, the update needs to be done all at
10082: once to minimize breakage.</p>
10083: <p>A major update typically consists of around 80 package
10084: updates and the addition of some new ones.</p>
10085: </dd>
10086: <dt><span class="term">Minor update</span></dt>
10087: <dd>
10088: <p>We consider a minor update one that goes from a
10089: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10090: one where <code class="literal">Y</code> is greater than
10091: <code class="literal">X</code>. These are easy to achieve because they do
10092: not update all GNOME components, can be done in an incremental way
10093: and do not break API nor ABI compatibility.</p>
10094: <p>A minor update typically consists of around 50 package
10095: updates, although the numbers here may vary a lot.</p>
10096: </dd>
10097: </dl></div>
10098: <p>In order to update the GNOME components in pkgsrc to a new stable
10099: release (either major or minor), the following steps should be
10100: followed:</p>
10101: <div class="orderedlist"><ol type="1">
10102: <li>
10103: <p>Get a list of all the tarballs that form the new release by
10104: using the following commands. These will leave the full list of the
10105: components's distfiles into the <code class="filename">list.txt</code>
10106: file:</p>
10107: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10108: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10109: awk '{ print $9 }' >list.txt</code></strong>
10110: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10111: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10112: awk '{ print $9 }' >>list.txt</code></strong></pre>
10113: </li>
10114: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10115: bump their version to the release you are updating them to. The
10116: three meta packages should be always consistent with versioning.
10117: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10118: in them.</p></li>
10119: <li>
10120: <p>For each meta package, update all its
10121: <code class="varname">DEPENDS</code> lines to match the latest versions as
10122: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10123: newer version (even if found in the FTP) because the meta packages
10124: are supposed to list the exact versions that form a specific GNOME
10125: release. Exceptions are permitted here if a newer version solves a
10126: serious issue in the overall desktop experience; these typically
10127: come in the form of a revision bump in pkgsrc, not in newer versions
10128: from the developers.</p>
10129: <p>Packages not listed in the <code class="filename">list.txt</code> file
10130: should be updated to the latest version available (if found in
10131: pkgsrc). This is the case, for example, of the dependencies on the
10132: 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>
10133: </li>
10134: <li>
10135: <p>Generate a patch from the modified meta packages and extract the
10136: list of "new" lines. This will provide you an outline on what
10137: packages need to be updated in pkgsrc and in what order:</p>
10138: <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>
10139: </li>
10140: <li><p>For major desktop updates it is recommended to zap all your
10141: installed packages and start over from scratch at this point.</p></li>
10142: <li><p>Now comes the longest step by far: iterate over the contents
10143: of <code class="filename">todo.txt</code> and update the packages listed in
10144: it in order. For major desktop updates none of these should be
10145: committed until the entire set is completed because there are chances
10146: of breaking not-yet-updated packages.</p></li>
10147: <li><p>Once the packages are up to date and working, commit them to
10148: the tree one by one with appropriate log messages. At the end,
10149: commit the three meta package updates and all the corresponding
10150: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10151: <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>
10152: </ol></div>
10153: </div>
10154: <div class="sect1" lang="en">
10155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10156: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10157: <p>GNOME is a very big component in pkgsrc which approaches 100
10158: packages. Please, it is very important that you always, always,
10159: <span class="strong"><strong>always</strong></span> feed back any portability
1.6 rillig 10160: 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 10161: their attention on portability issues and to ensure that future versions
10162: can be built out-of-the box on NetBSD. The less custom patches in
10163: pkgsrc, the easier further updates are. Those developers in charge of
10164: issuing major GNOME updates will be grateful if you do that.</p>
10165: <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
10166: Bugzilla</a>. Not all components use these to track bugs, but most
10167: of them do. Do not be short on your reports: always provide detailed
10168: explanations of the current failure, how it can be improved to achieve
10169: maximum portability and, if at all possible, provide a patch against CVS
10170: head. The more verbose you are, the higher chances of your patch being
10171: accepted.</p>
10172: <p>Also, please avoid using preprocessor magic to fix portability
10173: issues. While the FreeBSD GNOME people are doing a great job in porting
10174: GNOME to their operating system, the official GNOME sources are now
10175: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10176: and similar macros. This hurts portability. Please see our patching
1.6 rillig 10177: guidelines (<a href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10178: details.</p>
10179: </div>
10180: </div>
10181: </div>
10182: <div class="part" lang="en">
10183: <div class="titlepage"><div><div><h1 class="title">
10184: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10185: <div class="partintro" lang="en">
10186: <div></div>
10187: <p>This part of the guide deals with everything
10188: from the infrastructure that is behind the interfaces described
10189: in the developer's guide. A casual package maintainer should not
10190: need anything from this part.</p>
10191: <div class="toc">
10192: <p><b>Table of Contents</b></p>
10193: <dl>
1.6 rillig 10194: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10195: <dd><dl>
1.6 rillig 10196: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10197: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10198: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10199: <dd><dl>
1.6 rillig 10200: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10201: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10202: </dl></dd>
1.6 rillig 10203: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10204: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10205: <dd><dl>
1.6 rillig 10206: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10207: <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 10208: </dl></dd>
1.6 rillig 10209: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10210: <dd><dl>
1.6 rillig 10211: <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>
10212: <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 10213: </dl></dd>
10214: </dl></dd>
1.6 rillig 10215: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10216: <dd><dl>
1.6 rillig 10217: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10218: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10219: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10220: <dd><dl>
1.6 rillig 10221: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10222: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10223: </dl></dd>
10224: </dl></dd>
1.6 rillig 10225: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10226: <dd><dl>
1.6 rillig 10227: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10228: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10229: </dl></dd>
10230: </dl>
10231: </div>
10232: </div>
10233: <div class="chapter" lang="en">
10234: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10235: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10236: <div class="toc">
10237: <p><b>Table of Contents</b></p>
10238: <dl>
1.6 rillig 10239: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10240: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10241: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10242: <dd><dl>
1.6 rillig 10243: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10244: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10245: </dl></dd>
1.6 rillig 10246: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10247: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10248: <dd><dl>
1.6 rillig 10249: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10250: <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 10251: </dl></dd>
1.6 rillig 10252: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10253: <dd><dl>
1.6 rillig 10254: <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>
10255: <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 10256: </dl></dd>
10257: </dl>
10258: </div>
10259: <p>The pkgsrc infrastructure consists of many small Makefile
10260: fragments. Each such fragment needs a properly specified
10261: interface. This chapter explains how such an interface looks
10262: like.</p>
10263: <div class="sect1" lang="en">
10264: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10265: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10266: <p>Whenever a variable is defined in the pkgsrc
10267: infrastructure, the location and the way of definition provide
10268: much information about the intended use of that variable.
10269: Additionally, more documentation may be found in a header
10270: comment or in this pkgsrc guide.</p>
10271: <p>A special file is
10272: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10273: variables that are intended to be user-defined. They are either
10274: defined using the <code class="literal">?=</code> operator or they are
10275: left undefined because defining them to anything would
10276: effectively mean “<span class="quote">yes</span>”. All these variables may be
10277: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10278: file.</p>
10279: <p>Outside this file, the following conventions apply:
10280: Variables that are defined using the <code class="literal">?=</code>
10281: operator may be overridden by a package.</p>
10282: <p>Variables that are defined using the <code class="literal">=</code>
10283: operator may be used read-only at run-time.</p>
10284: <p>Variables whose name starts with an underscore must not be
10285: accessed outside the pkgsrc infrastructure at all. They may
10286: change without further notice.</p>
10287: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10288: <h3 class="title">Note</h3>
10289: <p>These conventions are currently not applied
10290: consistently to the complete pkgsrc
10291: infrastructure.</p>
10292: </div>
10293: </div>
10294: <div class="sect1" lang="en">
10295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10296: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10297: <p>All variables that contain lists of things should default
10298: to being empty. Two examples that do not follow this rule are
10299: <code class="varname">USE_LANGUAGES</code> and
10300: <code class="varname">DISTFILES</code>. These variables cannot simply be
10301: modified using the <code class="literal">+=</code> operator in package
10302: <code class="filename">Makefile</code>s (or other files included by
10303: them), since there is no guarantee whether the variable is
10304: already set or not, and what its value is. In the case of
10305: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10306: the default value and just define it as in the following
10307: example.</p>
10308: <pre class="programlisting">
10309: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10310: </pre>
10311: <p>Because of the selection of this default value, the same
10312: value appears in many package Makefiles. Similarly for
10313: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10314: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10315: doesn't stand out. Nevertheless it is mentioned in many
10316: files.</p>
10317: </div>
10318: <div class="sect1" lang="en">
10319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10320: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.1 dsieger 10321: <div class="sect2" lang="en">
10322: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10323: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10324: <p>Variable evaluation takes place either at load time or at
10325: runtime, depending on the context in which they occur. The
10326: contexts where variables are evaluated at load time are:</p>
10327: <div class="itemizedlist"><ul type="disc">
10328: <li><p>The right hand side of the <code class="literal">:=</code>
10329: and <code class="literal">!=</code> operators,</p></li>
10330: <li><p>Make directives like <code class="literal">.if</code> or
10331: <code class="literal">.for</code>,</p></li>
10332: <li><p>Dependency lines.</p></li>
10333: </ul></div>
10334: <p>A special exception are references to the iteration
10335: variables of <code class="literal">.for</code> loops, which are expanded
10336: inline, no matter in which context they appear.</p>
10337: <p>As the values of variables may change during load time,
10338: care must be taken not to evaluate them by accident. Typical
10339: examples for variables that should not be evaluated at load time
10340: are <code class="varname">DEPENDS</code> and
10341: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10342: clear, here is an example:</p>
10343: <pre class="programlisting">
10344: CONFIGURE_ARGS= # none
10345: CFLAGS= -O
10346: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10347:
10348: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10349:
10350: CFLAGS+= -Wall
10351: </pre>
10352: <p>This code shows how the use of the <code class="literal">:=</code>
10353: operator can quickly lead to unexpected results. The first
10354: paragraph is fairly common code. The second paragraph evaluates
10355: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10356: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10357: <code class="literal">-Wall</code> is appended to the
10358: <code class="varname">CFLAGS</code>, but this addition will not appear in
10359: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10360: paragraphs from above typically occur in completely unrelated
10361: files.</p>
10362: </div>
10363: <div class="sect2" lang="en">
10364: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10365: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10366: <p>After all the files have been loaded, the values of the
10367: variables cannot be changed anymore. Variables that are used in
10368: the shell commands are expanded at this point.</p>
10369: </div>
10370: </div>
10371: <div class="sect1" lang="en">
10372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10373: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10374: <p>There are many ways in which the definition and use of a
10375: variable can be restricted in order to detect bugs and
10376: violations of the (mostly unwritten) policies. See the
10377: <code class="literal">pkglint</code> developer's documentation for further
10378: details.</p>
10379: </div>
10380: <div class="sect1" lang="en">
10381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10382: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10383: <p>Most of the <code class="filename">.mk</code> files fall into one
10384: of the following classes. Cases where a file falls into more
10385: than one class should be avoided as it often leads to subtle
10386: bugs.</p>
10387: <div class="sect2" lang="en">
10388: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10389: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10390: <p>In a traditional imperative programming language some of
10391: the <code class="filename">.mk</code> files could be described as
1.6 rillig 10392: procedures. They take some input parameters and—after
10393: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10394: variables in <code class="filename">Makefile</code>s have global scope
10395: care must be taken not to use parameter names that have already
10396: another meaning. For example, <code class="varname">PKGNAME</code> is a
10397: bad choice for a parameter name.</p>
10398: <p>Procedures are completely evaluated at preprocessing time.
10399: That is, when calling a procedure all input parameters must be
10400: completely resolvable. For example,
10401: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10402: parameter since it is very likely that further text will be
10403: added after calling the procedure, which would effectively apply
10404: the procedure to only a part of the variable. Also, references
10405: to other variables wit will be modified after calling the
10406: procedure.</p>
10407: <p>A procedure can declare its output parameters either as
10408: suitable for use in preprocessing directives or as only
10409: available at runtime. The latter alternative is for variables
10410: that contain references to other runtime variables.</p>
10411: <p>Procedures shall be written such that it is possible to
10412: call the procedure more than once. That is, the file must not
10413: contain multiple-inclusion guards.</p>
10414: <p>Examples for procedures are
10415: <code class="filename">mk/bsd.options.mk</code> and
10416: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10417: that the parameters are evaluated at load time, they should be
10418: assigned using the <code class="literal">:=</code> operator, which should
10419: be used only for this purpose.</p>
10420: </div>
10421: <div class="sect2" lang="en">
10422: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10423: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10424: <p>Action files take some input parameters and may define
10425: runtime variables. They shall not define loadtime variables.
10426: There are action files that are included implicitly by the
10427: pkgsrc infrastructure, while other must be included
10428: explicitly.</p>
10429: <p>An example for action files is
10430: <code class="filename">mk/subst.mk</code>.</p>
10431: </div>
10432: </div>
10433: <div class="sect1" lang="en">
10434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10435: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10436: <p>Package <code class="filename">Makefile</code>s usually consist of
10437: a set of variable definitions, and include the file
10438: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10439: Before that, they may also include various other
10440: <code class="filename">*.mk</code> files if they need to query the
10441: availability of certain features like the type of compiler or
10442: the X11 implementation. Due to the heavy use of preprocessor
10443: directives like <code class="literal">.if</code> and
10444: <code class="literal">.for</code>, the order in which the files are loaded
10445: matters.</p>
10446: <p>This section describes at which point the various files
10447: are loaded and gives reasons for that order.</p>
10448: <div class="sect2" lang="en">
10449: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10450: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10451: </h3></div></div></div>
10452: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10453: is to define some essential variables like
10454: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10455: <code class="varname">MACHINE_ARCH</code>.</p>
10456: <p>Then, the user settings are loaded from the file specified
1.4 rillig 10457: in <code class="varname">MAKECONF</code>, which is usually <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
10458: After that, those variables
1.1 dsieger 10459: that have not been overridden by the user are loaded from
10460: <code class="filename">mk/defaults/mk.conf</code>.</p>
10461: <p>After the user settings, the system settings and platform
10462: settings are loaded, which may override the user
10463: settings.</p>
10464: <p>Then, the tool definitions are loaded. The tool wrappers
10465: are not yet in effect. This only happens when building a
10466: package, so the proper variables must be used instead of the
10467: direct tool names.</p>
10468: <p>As the last steps, some essential variables from the
10469: wrapper and the package system flavor are loaded, as well as the
10470: variables that have been cached in earlier phases of a package
10471: build.</p>
10472: </div>
10473: <div class="sect2" lang="en">
10474: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10475: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10476: </h3></div></div></div>
10477: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10478: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10479: loaded, which fill default values for those variables that have
10480: not been defined by the package. These variables may later
10481: be used even in unrelated files.</p>
10482: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10483: provides the target <code class="literal">error-check</code> that is added
10484: as a special dependency to all other targets that use
10485: <code class="varname">DELAYED_ERROR_MSG</code> or
10486: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10487: <p>Then, the package-specific hacks from
10488: <code class="filename">hacks.mk</code> are included.</p>
10489: <p>Then, various other files follow. Most of them don't have
10490: any dependencies on what they need to have included before or
10491: after them, though some do.</p>
10492: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10493: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10494: restricts the use of these variables to all the files that have
10495: been included before. Appearances in later files will be
10496: silently ignored.</p>
10497: <p>Then, the files for the main targets are included, in the
10498: order of later execution, though the actual order should not
10499: matter.</p>
10500: <p>At last, some more files are included that don't set any
10501: interesting variables but rather just define make targets to be
10502: executed.</p>
10503: </div>
10504: </div>
10505: </div>
10506: <div class="chapter" lang="en">
10507: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10508: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10509: <div class="toc">
10510: <p><b>Table of Contents</b></p>
10511: <dl>
1.6 rillig 10512: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10513: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10514: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10515: <dd><dl>
1.6 rillig 10516: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10517: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10518: </dl></dd>
10519: </dl>
10520: </div>
10521: <p>The pkgsrc infrastructure consists of a large codebase,
10522: and there are many corners where every little bit of a file is
10523: well thought out, making pkgsrc likely to fail as soon as
10524: anything is changed near those parts. To prevent most changes
10525: from breaking anything, a suite of regression tests should go
10526: along with every important part of the pkgsrc infrastructure.
10527: This chapter describes how regression tests work in pkgsrc and
10528: how you can add new tests.</p>
10529: <div class="sect1" lang="en">
10530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10531: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10532: <p></p>
10533: </div>
10534: <div class="sect1" lang="en">
10535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10536: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10537: <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
10538: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10539: can simply run that command, which will run all tests in the
10540: <code class="filename">regress</code> category.</p>
10541: </div>
10542: <div class="sect1" lang="en">
10543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10544: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10545: <p>Every directory in the <code class="filename">regress</code>
10546: category that contains a file called <code class="filename">spec</code>
10547: is considered a regression test. This file is a shell program
10548: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10549: The following functions can be overridden to suit your
10550: needs.</p>
10551: <div class="sect2" lang="en">
10552: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10553: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10554: <p>These functions do not take any parameters. They are all
10555: called in “<span class="quote">set -e</span>” mode, so you should be careful
10556: to check the exitcodes of any commands you run in the
10557: test.</p>
10558: <div class="variablelist"><dl>
10559: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10560: <dd><p>This function prepares the environment for the
10561: test. By default it does nothing.</p></dd>
10562: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10563: <dd><p>This function runs the actual test. By default,
10564: it calls <code class="varname">TEST_MAKE</code> with the arguments
10565: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10566: error messages into the file
10567: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10568: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10569: <dd><p>This function is run after the test and is
10570: typically used to compare the actual output from the one that is
10571: expected. It can make use of the various helper functions from
10572: the next section.</p></dd>
10573: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10574: <dd><p>This function cleans everything up after the
10575: test has been run. By default it does nothing.</p></dd>
10576: </dl></div>
10577: </div>
10578: <div class="sect2" lang="en">
10579: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10580: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1 dsieger 10581: <div class="variablelist"><dl>
10582: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10583: <dd><p>This function compares the exitcode of the
10584: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10585: If they differ, the test will fail.</p></dd>
10586: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10587: <dd><p>This function checks for each of its parameters
10588: if the output from <span><strong class="command">do_test()</strong></span> matches the
10589: extended regular expression. If it does not, the test will
10590: fail.</p></dd>
10591: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10592: <dd><p>This function checks for each of its parameters
10593: if the output from <span><strong class="command">do_test()</strong></span> does
10594: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10595: If any of the regular expressions matches, the test will
10596: fail.</p></dd>
10597: </dl></div>
10598: </div>
10599: </div>
10600: </div>
10601: <div class="chapter" lang="en">
10602: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10603: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10604: <div class="toc">
10605: <p><b>Table of Contents</b></p>
10606: <dl>
1.6 rillig 10607: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10608: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10609: </dl>
10610: </div>
10611: <p>The pkgsrc system has already been ported to many
10612: operating systems, hardware architectures and compilers. This
10613: chapter explains the necessary steps to make pkgsrc even more
10614: portable.</p>
10615: <div class="sect1" lang="en">
10616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10617: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10618: <p>To port pkgsrc to a new operating system (called
10619: <code class="literal">MyOS</code> in this example), you need to touch the
10620: following files:</p>
10621: <div class="variablelist"><dl>
10622: <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>
10623: <dd><p>This file contains some basic definitions, for
10624: example the name of the C
10625: compiler.</p></dd>
10626: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10627: <dd><p>Insert code that defines the variables
10628: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10629: <code class="varname">LOWER_OS_VERSION</code>,
10630: <code class="varname">LOWER_VENDOR</code>,
10631: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10632: <code class="varname">APPEND_ELF</code>, and the other variables that
10633: appear in this file.</p></dd>
10634: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10635: <dd><p>This file contains the platform-specific
10636: definitions that are used by pkgsrc. Start by copying one of the
10637: other files and edit it to your
10638: needs.</p></dd>
10639: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10640: <dd><p>This file contains a list of directories,
10641: together with their permission bits and ownership. These
10642: directories will be created automatically with every package
10643: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10644: be removed.</p></dd>
10645: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10646: <dd><p>Just copy one of the pre-existing x11.dist files
10647: to your
10648: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10649: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10650: <dd><p>On some operating systems, the tools that are
10651: provided with the base system are not good enough for pkgsrc.
10652: 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
10653: narrow limit on the line length they can process. Therefore
10654: pkgsrc brings its own tools, which can be enabled
10655: here.</p></dd>
10656: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10657: <dd><p>This file defines the paths to all the tools
10658: that are needed by one or the other package in pkgsrc, as well
10659: as by pkgsrc itself. Find out where these tools are on your
10660: platform and add them.</p></dd>
10661: </dl></div>
10662: <p>Now, you should be able to build some basic packages, like
10663: <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>
10664: </div>
10665: <div class="sect1" lang="en">
10666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10667: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10668: <p>TODO</p>
10669: </div>
10670: </div>
10671: </div>
10672: <div class="appendix" lang="en">
10673: <div class="titlepage"><div><div><h2 class="title">
10674: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10675: <div class="toc">
10676: <p><b>Table of Contents</b></p>
10677: <dl>
10678: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10679: <dd><dl>
10680: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10681: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10682: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10683: <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>
10684: </dl></dd>
10685: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10686: </dl>
10687: </div>
10688: <p>We checked to find a piece of software that wasn't in the packages
10689: collection, and picked GNU bison. Quite why someone would want to have
10690: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10691: present in the tree is beyond us, but it's useful for the purposes of
10692: this exercise.</p>
10693: <div class="sect1" lang="en">
10694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10695: <a name="example-files"></a>A.1. files</h2></div></div></div>
10696: <div class="sect2" lang="en">
10697: <div class="titlepage"><div><div><h3 class="title">
10698: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10699: <pre class="programlisting">
10700: # $NetBSD$
10701: #
10702:
10703: DISTNAME= bison-1.25
10704: CATEGORIES= devel
10705: MASTER_SITES= ${MASTER_SITE_GNU}
10706:
10707: MAINTAINER= thorpej@NetBSD.org
10708: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10709: COMMENT= GNU yacc clone
10710:
10711: GNU_CONFIGURE= yes
10712: INFO_FILES= bison.info
10713:
10714: .include "../../mk/bsd.pkg.mk"
10715: </pre>
10716: </div>
10717: <div class="sect2" lang="en">
10718: <div class="titlepage"><div><div><h3 class="title">
10719: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10720: <pre class="programlisting">
10721: GNU version of yacc. Can make re-entrant parsers, and numerous other
10722: 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
10723: of the NetBSD source tree is beyond me.
10724: </pre>
10725: </div>
10726: <div class="sect2" lang="en">
10727: <div class="titlepage"><div><div><h3 class="title">
10728: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10729: <pre class="programlisting">
10730: @comment $NetBSD$
10731: bin/bison
10732: man/man1/bison.1.gz
10733: share/bison.simple
10734: share/bison.hairy
10735: </pre>
10736: </div>
10737: <div class="sect2" lang="en">
10738: <div class="titlepage"><div><div><h3 class="title">
10739: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10740: </h3></div></div></div>
10741: <p>The NetBSD package system comes with
10742: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10743: which helps to check the contents of these
10744: files. After installation it is quite easy to use, just change to the
10745: directory of the package you wish to examine and execute
10746: <span><strong class="command">pkglint</strong></span>:</p>
10747: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10748: looks fine.</pre>
10749: <p>Depending on the supplied command line arguments (see pkglint(1)),
10750: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10751: -Wall</strong></span> for a very thorough check.</p>
10752: </div>
10753: </div>
10754: <div class="sect1" lang="en">
10755: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10756: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10757: <p>Create the directory where the package lives,
10758: plus any auxiliary directories:</p>
10759: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10760: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10761: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10762: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10763: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.6 rillig 10764: <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 10765: then continue with fetching the distfile:</p>
10766: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10767: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10768: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10769: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10770: ftp: Error retrieving file: 500 Internal error
10771:
10772: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10773: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10774: ftp: Error retrieving file: 500 Internal error
10775:
10776: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10777: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10778: Successfully retrieved file.</pre>
10779: <p>Generate the checksum of the distfile into
10780: <code class="filename">distinfo</code>:</p>
10781: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10782: <p>Now compile:</p>
10783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10784: >> Checksum OK for bison-1.25.tar.gz.
10785: ===> Extracting for bison-1.25
10786: ===> Patching for bison-1.25
10787: ===> Ignoring empty patch directory
10788: ===> Configuring for bison-1.25
10789: creating cache ./config.cache
10790: checking for gcc... cc
10791: checking whether we are using GNU C... yes
10792: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10793: checking how to run the C preprocessor... cc -E
10794: checking for minix/config.h... no
10795: checking for POSIXized ISC... no
10796: checking whether cross-compiling... no
10797: checking for ANSI C header files... yes
10798: checking for string.h... yes
10799: checking for stdlib.h... yes
10800: checking for memory.h... yes
10801: checking for working const... yes
10802: checking for working alloca.h... no
10803: checking for alloca... yes
10804: checking for strerror... yes
10805: updating cache ./config.cache
10806: creating ./config.status
10807: creating Makefile
10808: ===> Building for bison-1.25
10809: 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
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 allocate.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 closure.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 conflicts.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 derives.c
10814: 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
10815: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.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 reduce.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 symtab.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 warshall.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 version.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 getopt.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 getopt1.c
10830: 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
10831: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10832: rm -f bison.s1
10833: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10834: <p>Everything seems OK, so install the files:</p>
10835: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10836: >> Checksum OK for bison-1.25.tar.gz.
10837: ===> Installing for bison-1.25
10838: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10839: rm -f /usr/pkg/bin/bison
10840: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10841: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10842: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10843: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10844: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10845: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10846: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10847: ===> Registering installation for bison-1.25</pre>
10848: <p>You can now use bison, and also - if you decide so - remove it with
10849: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10850: binary package, do this now:</p>
10851: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10852: >> Checksum OK for bison-1.25.tar.gz.
10853: ===> Building package for bison-1.25
10854: Creating package bison-1.25.tgz
10855: Registering depends:.
10856: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10857: <p>Now that you don't need the source and object files
10858: any more, clean up:</p>
10859: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10860: ===> Cleaning for bison-1.25</pre>
10861: </div>
10862: </div>
10863: <div class="appendix" lang="en">
10864: <div class="titlepage"><div><div><h2 class="title">
10865: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10866: <div class="toc">
10867: <p><b>Table of Contents</b></p>
10868: <dl>
10869: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10870: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10871: </dl>
10872: </div>
10873: <div class="sect1" lang="en">
10874: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10875: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10876: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10877: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10878: => figlet221.tar.gz doesn't seem to exist on this system.
10879: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10880: => [172219 bytes]
10881: Connected to ftp.plig.net.
10882: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10883: 331 Guest login ok, send your complete e-mail address as password.
10884: 230-You are user #5 of 500 simultaneous users allowed.
10885: 230-
10886: 230- ___ _ _ _
10887: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
10888: 230- | _| _| . |_| . | | | . |_| . | _| . |
10889: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10890: 230- |_| |_| |___| |___|
10891: 230-
10892: 230-** Welcome to ftp.plig.org **
10893: 230-
10894: 230-Please note that all transfers from this FTP site are logged. If you
10895: 230-do not like this, please disconnect now.
10896: 230-
10897: 230-This arhive is available via
10898: 230-
10899: 230-HTTP: http://ftp.plig.org/
10900: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10901: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10902: 230-
10903: 230-Please email comments, bug reports and requests for packages to be
10904: 230-mirrored to ftp-admin@plig.org.
10905: 230-
10906: 230-
10907: 230 Logged in anonymously.
10908: Remote system type is UNIX.
10909: Using binary mode to transfer files.
10910: 200 Type okay.
10911: 250 "/pub" is new cwd.
10912: 250-"/pub/figlet" is new cwd.
10913: 250-
10914: 250-Welcome to the figlet archive at ftp.figlet.org
10915: 250-
10916: 250- ftp://ftp.figlet.org/pub/figlet/
10917: 250-
10918: 250-The official FIGlet web page is:
10919: 250- http://www.figlet.org/
10920: 250-
10921: 250-If you have questions, please mailto:info@figlet.org. If you want to
10922: 250-contribute a font or something else, you can email us.
10923: 250
10924: 250 "/pub/figlet/program" is new cwd.
10925: 250 "/pub/figlet/program/unix" is new cwd.
10926: local: figlet221.tar.gz remote: figlet221.tar.gz
10927: 502 Unimplemented command.
10928: 227 Entering Passive Mode (195,40,6,41,246,104)
10929: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10930: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10931: 226 Transfer completed.
10932: 172219 bytes received in 00:02 (75.99 KB/s)
10933: 221 Goodbye.
10934: => Checksum OK for figlet221.tar.gz.
10935: ===> Extracting for figlet-2.2.1nb2
10936: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10937: ===> Patching for figlet-2.2.1nb2
10938: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10939: ===> Overriding tools for figlet-2.2.1nb2
10940: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10941: ===> Configuring for figlet-2.2.1nb2
10942: ===> Building for figlet-2.2.1nb2
10943: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10944: chmod a+x figlet
10945: gcc -O2 -o chkfont chkfont.c
10946: => Unwrapping files-to-be-installed.
10947: <code class="prompt">#</code>
10948: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10949: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10950: ===> Installing for figlet-2.2.1nb2
10951: install -d -o root -g wheel -m 755 /usr/pkg/bin
10952: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10953: mkdir -p /usr/pkg/share/figlet
10954: cp figlet /usr/pkg/bin
10955: cp chkfont /usr/pkg/bin
10956: chmod 555 figlist showfigfonts
10957: cp figlist /usr/pkg/bin
10958: cp showfigfonts /usr/pkg/bin
10959: cp fonts/*.flf /usr/pkg/share/figlet
10960: cp fonts/*.flc /usr/pkg/share/figlet
10961: cp figlet.6 /usr/pkg/man/man6
10962: ===> Registering installation for figlet-2.2.1nb2
10963: <code class="prompt">#</code></pre>
10964: </div>
10965: <div class="sect1" lang="en">
10966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10967: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10968: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10969: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10970: ===> Packaging figlet-2.2.1nb2
10971: ===> Building binary package for figlet-2.2.1nb2
10972: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10973: Using SrcDir value of /usr/pkg
10974: Registering depends:.
10975: <code class="prompt">#</code></pre>
10976: </div>
10977: </div>
10978: <div class="appendix" lang="en">
10979: <div class="titlepage"><div><div><h2 class="title">
10980: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10981: <div class="toc">
10982: <p><b>Table of Contents</b></p>
10983: <dl>
10984: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10985: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10986: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10987: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.3 rillig 10988: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.1 dsieger 10989: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
10990: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10991: source packages</a></span></dt>
10992: </dl>
10993: </div>
10994: <p>As in other big projects, the directory layout of pkgsrc
10995: is quite complex for newbies. This chapter explains where you
10996: find things on the FTP server. The base directory on
10997: <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>.
10998: On other servers it may be different, but inside this directory,
10999: everything should look the same, no matter on which server you
11000: are. This directory contains some subdirectories, which are
11001: explained below.</p>
11002: <div class="sect1" lang="en">
11003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11004: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
11005: <p>For those who only want to manage binary packages on
11006: systems other than NetBSD, we provide the package management
11007: tools in a separate, small tar file.</p>
11008: </div>
11009: <div class="sect1" lang="en">
11010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11011: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
11012: <p>The directory <code class="filename">distfiles</code> contains lots
11013: of archive files from all pkgsrc packages, which are mirrored
11014: here. The subdirectories are called after their package names
11015: and are used when the distributed files have names that don't
11016: explicitly contain a version number or are otherwise too generic
11017: (for example <code class="filename">release.tar.gz</code>).</p>
11018: </div>
11019: <div class="sect1" lang="en">
11020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11021: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
11022: <p>This directory is currently not in use.</p>
11023: </div>
11024: <div class="sect1" lang="en">
11025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11026: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
11027: <p>This directory contains things that individual pkgsrc
11028: developers find worth publishing.</p>
11029: </div>
11030: <div class="sect1" lang="en">
11031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3 rillig 11032: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
11033: <p>This directory contains binary packages for the various
11034: platforms that are supported by pkgsrc.
11035: 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>
11036: <div class="itemizedlist"><ul type="disc">
11037: <li><p><code class="varname">OPSYS</code> is the name of the operating system for which the packages have been built,</p></li>
11038: <li><p><code class="varname">ARCH</code> is the hardware architecture,</p></li>
11039: <li><p><code class="varname">OSVERSION</code> is the version of the operating system,</p></li>
11040: <li><p><code class="varname">TAG</code> is either <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code> for a stable branch, or <code class="literal">head</code> for packages built from the HEAD branch.</p></li>
11041: </ul></div>
11042: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11043: can quickly click through the directories on the
11044: server and find the best binary packages for their machines. Since they
11045: usually know the operating system and the hardware architecture, OPSYS
11046: and ARCH are placed first. After these choices, they can select the
11047: best combination of OSVERSION and TAG together, since it is usually the
11048: case that packages stay compatible between different version of the
11049: operating system.</p>
11050: <p>In each of these directories, there is a
11051: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 11052: <code class="filename">All</code> which contains all binary packages.
11053: Besides that, there are various category directories that
11054: contain symbolic links to the real binary packages.</p>
11055: </div>
11056: <div class="sect1" lang="en">
11057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11058: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
11059: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11060: source packages</h2></div></div></div>
11061: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
11062: that is the files that define how to create binary packages from
11063: source archives.</p>
11064: <p>The directory <code class="filename">pkgsrc</code> contains a
11065: snapshot of the CVS repository, which is updated regularly. The
11066: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11067: directory, ready to be downloaded as a whole.</p>
11068: <p>In the directories for the quarterly branches, there is an
11069: additional file called
11070: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
11071: which contains the state of pkgsrc when it was branched.</p>
11072: </div>
11073: </div>
11074: <div class="appendix" lang="en">
11075: <div class="titlepage"><div><div><h2 class="title">
11076: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11077: <div class="toc">
11078: <p><b>Table of Contents</b></p>
11079: <dl>
11080: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11081: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11082: </dl>
11083: </div>
11084: <p>This section contains information on editing the pkgsrc
11085: guide itself.</p>
11086: <div class="sect1" lang="en">
11087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11088: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11089: <p>The pkgsrc guide's source code is stored in
11090: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11091: are created from it:</p>
11092: <div class="itemizedlist"><ul type="disc">
11093: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11094: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.2 rillig 11095: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11096: <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 11097: The PDF version of the pkgsrc guide.</p></li>
1.2 rillig 11098: <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 11099: PostScript version of the pkgsrc guide.</p></li>
11100: </ul></div>
11101: </div>
11102: <div class="sect1" lang="en">
11103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11104: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11105: <p>The procedure to edit the pkgsrc guide is:</p>
11106: <div class="procedure"><ol type="1">
11107: <li><p>Make sure you have the packages needed to
11108: regenerate the pkgsrc guide (and other XML-based NetBSD
11109: 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
11110: 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
11111: PostScript and PDF versions. You will need both packages
11112: installed, to make sure documentation is consistent across all
11113: formats.</p></li>
11114: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
11115: right directory. All further steps will take place
11116: here.</p></li>
11117: <li><p>Edit the XML file(s) in
11118: <code class="filename">files/</code>.</p></li>
11119: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
11120: guide for valid XML and to build the final output files. If you
11121: get any errors at this stage, you can just edit the files, as
11122: there are only symbolic links in the working directory, pointing
11123: to the files in <code class="filename">files/</code>.</p></li>
11124: <li><p><span><strong class="command">(cd files && cvs
11125: commit)</strong></span></p></li>
11126: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
11127: regenerate the output files with the proper RCS
11128: Ids.</p></li>
11129: <li>
11130: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
11131: commit the files in both <code class="filename">pkgsrc/doc</code> and
11132: <code class="filename">htdocs</code>.</p>
11133: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11134: <h3 class="title">Note</h3>
11135: <p>If you have added, removed or renamed some chapters,
11136: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
11137: <span><strong class="command">cvs delete</strong></span> in the htdocs
11138: directory.</p>
11139: </div>
11140: </li>
11141: </ol></div>
11142: </div>
11143: </div>
11144: </div></body>
11145: </html>
CVSweb <webmaster@jp.NetBSD.org>