Annotation of pkgsrc/doc/pkgsrc.html, revision 1.105
1.75 rillig 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
1.1 grant 3: <head>
1.75 rillig 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.101 rillig 6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75 rillig 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91 rillig 8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75 rillig 9: </head>
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.104 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.25 2007/08/15 06:32:38 rillig Exp $</p></div>
1.76 rillig 35: <div><div class="abstract">
1.75 rillig 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
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>
1.82 rillig 52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
1.75 rillig 56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
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>
1.97 rillig 69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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>
1.82 rillig 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>
1.75 rillig 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.103 wiz 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.88 wiz 118: <dd><dl>
1.103 wiz 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.88 wiz 122: </dl></dd>
1.103 wiz 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.75 rillig 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>
130: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
131: <dd><dl>
132: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
133: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
134: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
135: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
136: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
137: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
138: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
139: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
140: </dl></dd>
141: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
143: </dl></dd>
1.90 rillig 144: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
1.75 rillig 145: <dd><dl>
1.91 rillig 146: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 147: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
148: </dl></dd>
149: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
150: <dd><dl>
151: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
152: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
153: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
154: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
155: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103 wiz 156: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
157: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
158: <dt><span class="sect1"><a href="#passive-ftp">8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
159: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
160: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.10. What does “<span class="quote">Don't know how to make
1.75 rillig 161: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.103 wiz 162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
164: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
165: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
166: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
167: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build. What shall I do?</a></span></dt>
168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 169: </dl></dd>
170: </dl></dd>
171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
172: <dd><dl>
1.90 rillig 173: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 174: <dd><dl>
175: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
176: <dd><dl>
177: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
178: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
179: </dl></dd>
180: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
181: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
182: </dl></dd>
1.90 rillig 183: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 184: <dd><dl>
1.90 rillig 185: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
186: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
187: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
188: <dd><dl>
1.93 rillig 189: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
190: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
191: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
192: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
193: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 194: </dl></dd>
195: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
196: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
197: <dd><dl>
198: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
199: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
200: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
201: </dl></dd>
202: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
203: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
204: </dl></dd>
205: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
206: <dd><dl>
1.97 rillig 207: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
208: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
209: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
210: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
211: <dd><dl>
212: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
213: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
214: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
215: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
216: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90 rillig 217: </dl></dd>
218: </dl></dd>
219: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
220: <dd><dl>
221: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
222: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
223: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
224: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
225: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
226: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
227: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
228: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
229: </dl></dd>
230: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
231: <dd><dl>
232: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
233: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
234: <dd><dl>
235: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
236: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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>
237: </dl></dd>
238: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
239: <dd><dl>
240: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
241: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
242: </dl></dd>
243: </dl></dd>
244: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
245: <dd><dl>
246: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
247: <dd><dl>
248: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
249: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
250: </dl></dd>
251: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
252: <dd><dl>
253: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
254: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
255: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
256: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
257: </dl></dd>
258: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
259: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
260: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
261: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
262: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
263: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
264: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
265: </dl></dd>
266: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
267: <dd><dl>
268: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
269: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
270: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
271: </dl></dd>
272: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
273: <dd><dl>
274: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
275: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
276: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
277: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
278: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
279: <dd><dl>
280: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
281: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
282: </dl></dd>
283: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
284: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
285: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
286: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
288: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
289: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
290: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
291: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
292: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
294: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
295: </dl></dd>
296: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
297: <dd><dl>
298: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
299: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
300: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 301: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 302: </dl></dd>
303: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
304: <dd><dl>
305: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
308: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
309: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
310: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
311: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
312: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
313: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
314: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
315: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
316: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
317: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
318: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
319: </dl></dd>
320: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
321: <dd><dl>
322: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
323: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
324: </dl></dd>
325: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
326: <dd><dl>
327: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
328: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
329: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
330: </dl></dd>
331: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
332: <dd><dl>
333: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
334: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
335: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
336: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
337: </dl></dd>
338: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
339: <dd><dl>
340: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
341: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
342: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
343: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
344: </dl></dd>
345: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
346: <dd><dl>
347: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
348: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 349: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103 wiz 350: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
351: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
352: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
353: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
354: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
355: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
356: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
357: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
358: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
359: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
360: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
361: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
362: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
363: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
364: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87 wiz 365: emulation</a></span></dt>
1.103 wiz 366: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
367: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 368: </dl></dd>
1.90 rillig 369: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 370: </dl></dd>
1.90 rillig 371: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
372: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 373: <dd><dl>
1.90 rillig 374: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
375: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
376: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
377: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
378: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
379: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
380: </dl></dd>
381: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
382: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
383: <dd><dl>
384: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
385: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
386: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
387: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 388: </dl></dd>
1.75 rillig 389: </dl></dd>
390: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
391: <dd><dl>
1.90 rillig 392: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 393: <dd><dl>
1.90 rillig 394: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
395: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
396: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 397: <dd><dl>
1.90 rillig 398: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
399: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 400: </dl></dd>
1.90 rillig 401: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
402: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 403: <dd><dl>
1.90 rillig 404: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
405: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 406: </dl></dd>
1.90 rillig 407: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 408: <dd><dl>
1.90 rillig 409: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
410: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 411: </dl></dd>
412: </dl></dd>
1.90 rillig 413: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 414: <dd><dl>
1.90 rillig 415: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
416: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
417: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 418: <dd><dl>
1.90 rillig 419: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
420: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 421: </dl></dd>
422: </dl></dd>
1.90 rillig 423: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 424: <dd><dl>
1.90 rillig 425: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
426: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 427: </dl></dd>
428: </dl></dd>
429: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
430: <dd><dl>
431: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
432: <dd><dl>
433: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
434: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
435: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
436: <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>
437: </dl></dd>
438: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
439: </dl></dd>
440: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
443: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
444: </dl></dd>
1.76 rillig 445: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
446: <dd><dl>
447: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
448: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
449: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
450: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102 rillig 451: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.76 rillig 452: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 453: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 454: source packages</a></span></dt>
455: </dl></dd>
1.75 rillig 456: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
457: <dd><dl>
1.79 rillig 458: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 459: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
460: </dl></dd>
461: </dl>
462: </div>
1.82 rillig 463: <div class="list-of-tables">
464: <p><b>List of Tables</b></p>
465: <dl>
466: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
467: </dt>
468: <dt>3.1. <a href="#binary-kits">Binary kits and available packages</a>
469: </dt>
1.90 rillig 470: <dt>10.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 471: </dt>
1.90 rillig 472: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 473: </dt>
1.82 rillig 474: </dl>
475: </div>
1.75 rillig 476: <div class="chapter" lang="en">
477: <div class="titlepage"><div><div><h2 class="title">
478: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
479: <div class="toc">
480: <p><b>Table of Contents</b></p>
481: <dl>
482: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 483: <dd><dl>
484: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
485: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
486: </dl></dd>
1.75 rillig 487: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
488: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 489: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75 rillig 490: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
491: </dl>
492: </div>
493: <div class="sect1" lang="en">
494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
495: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 496: <p>There is a lot of software freely available for Unix-based
497: systems, which is usually available in form of the source code. Before
498: such software can be used, it needs to be configured to the local
499: system, compiled and installed, and this is exactly what The NetBSD
500: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
501: to handle binary packages, so that not every user has to build the
502: packages for himself, which is a time-costly task.</p>
1.75 rillig 503: <p>pkgsrc currently contains several thousand packages,
504: including:</p>
505: <div class="itemizedlist"><ul type="disc">
1.91 rillig 506: <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
1.75 rillig 507: web server</p></li>
1.91 rillig 508: <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
1.75 rillig 509: web browser</p></li>
1.91 rillig 510: <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
1.75 rillig 511: Desktop Environment</p></li>
1.91 rillig 512: <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
1.75 rillig 513: Desktop Environment</p></li>
514: </ul></div>
515: <p>...just to name a few.</p>
516: <p>pkgsrc has built-in support for handling varying dependencies,
517: such as pthreads and X11, and extended features such as IPv6 support on
518: a range of platforms.</p>
1.82 rillig 519: <div class="sect2" lang="en">
520: <div class="titlepage"><div><div><h3 class="title">
521: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
522: <p>
523: pkgsrc provides the following key features:
524: </p>
525: <div class="itemizedlist"><ul type="disc">
526: <li><p>Easy building of software from source as well as the creation
527: and installation of binary packages. The source and latest
528: patches are retrieved from a master or mirror download site, checksum
529: verified, then built on your system. Support for binary-only
530: distributions is available for both native platforms and NetBSD
531: emulated platforms.</p></li>
532: <li><p>All packages are installed in a consistent directory tree,
533: including binaries, libraries, man pages and other
534: documentation.</p></li>
535: <li><p>Package dependencies, including when performing package updates,
536: are handled automatically. The configuration files of various
537: packages are handled automatically during updates, so local changes
538: are preserved.</p></li>
539: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
540: consists of highly portable code. This allows the greatest speed of
541: development when porting to new a platform. This portability also
542: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
543: platforms</em></span>.</p></li>
544: <li><p>The installation prefix, acceptable software licenses,
545: international encryption requirements and build-time options for a
546: large number of packages are all set in a simple, central
547: configuration file.</p></li>
548: <li><p>The entire source (not including the distribution files) is
549: freely available under a BSD license, so you may extend and adapt
550: pkgsrc to your needs. Support for local packages and patches is
551: available right out of the box, so you can configure it specifically
552: for your environment.</p></li>
553: </ul></div>
1.91 rillig 554: <p>The following principles are basic to pkgsrc:</p>
555: <div class="itemizedlist"><ul type="disc">
556: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.105 ! weinem 557: — That means, if a package contains bugs, it's better to find
1.91 rillig 558: them and to complain about them rather than to just install the package
559: and hope that it works. There are numerous checks in pkgsrc that try to
560: 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
561: of shell scripts), and post-installation checks (installed files,
562: references to shared libraries, script interpreters).</p></li>
563: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.105 ! weinem 564: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 565: pkgsrc has been ported to many operating systems. Care is taken that
566: packages behave the same on all platforms.</p></li>
567: </ul></div>
1.82 rillig 568: </div>
569: <div class="sect2" lang="en">
570: <div class="titlepage"><div><div><h3 class="title">
571: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
572: <p>pkgsrc consists of both a source distribution and a binary
573: distribution for these operating systems. After retrieving the required
574: source or binaries, you can be up and running with pkgsrc in just
575: minutes!</p>
1.75 rillig 576: <p>pkgsrc was derived from FreeBSD's ports system, and
577: initially developed for NetBSD only. Since then, pkgsrc has
578: grown a lot, and now supports the following platforms:</p>
1.82 rillig 579: <div class="table">
580: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 581: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 582: <colgroup>
583: <col>
584: <col>
585: </colgroup>
586: <thead><tr>
587: <th>Platform</th>
588: <th>Date Support Added</th>
589: </tr></thead>
590: <tbody>
591: <tr>
592: <td><a href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
593: <td align="center">Aug 1997</td>
594: </tr>
595: <tr>
596: <td><a href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
597: <td align="center">Mar 1999</td>
598: </tr>
599: <tr>
600: <td><a href="http://www.kernel.org/" target="_top">Linux</a></td>
601: <td align="center">Jun 1999</td>
602: </tr>
603: <tr>
604: <td>
605: <a href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
606: (<a href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
607: </td>
608: <td align="center">Oct 2001</td>
609: </tr>
610: <tr>
611: <td><a href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
612: <td align="center">Nov 2002</td>
613: </tr>
614: <tr>
615: <td><a href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
616: <td align="center">Nov 2002</td>
617: </tr>
618: <tr>
619: <td><a href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
620: <td align="center">Dec 2002</td>
621: </tr>
622: <tr>
623: <td>BSD/OS</td>
624: <td align="center">Dec 2003</td>
625: </tr>
626: <tr>
627: <td><a href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
628: <td align="center">Dec 2003</td>
629: </tr>
630: <tr>
631: <td>
632: <a href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
633: (Microsoft Windows Services for Unix)
634: </td>
635: <td align="center">Mar 2004</td>
636: </tr>
637: <tr>
638: <td><a href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
639: <td align="center">Oct 2004</td>
640: </tr>
641: <tr>
642: <td><a href="http://www.tru64.org/" target="_top">OSF/1</a></td>
643: <td align="center">Nov 2004</td>
644: </tr>
1.98 wiz 645: <tr>
646: <td><a href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
647: <td align="center">Apr 2007</td>
648: </tr>
1.82 rillig 649: </tbody>
1.91 rillig 650: </table></div>
1.82 rillig 651: </div>
1.91 rillig 652: <br class="table-break">
1.82 rillig 653: </div>
1.75 rillig 654: </div>
655: <div class="sect1" lang="en">
656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
657: <a name="overview"></a>1.2. Overview</h2></div></div></div>
658: <p>This document is divided into three parts. The first,
659: <a href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
660: describes how one can use one of the packages in the Package
661: Collection, either by installing a precompiled binary package,
1.93 rillig 662: or by building one's own copy using the NetBSD package system.
1.75 rillig 663: 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
664: package so it can be easily built by other NetBSD users without
665: knowing about the package's building details. The third part,
666: <a href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
667: is intended for those who want to understand how pkgsrc is
668: implemented.</p>
669: <p>This document is available in various formats:
670: <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>
671: </div>
672: <div class="sect1" lang="en">
673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
674: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
675: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
676: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
677: terminology used within this document.</p>
678: <div class="variablelist"><dl>
679: <dt><span class="term">Package</span></dt>
680: <dd><p>A set of files and building instructions
681: that describe what's necessary
682: to build a certain piece of software using
683: pkgsrc. Packages are traditionally stored under
1.76 rillig 684: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 685: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 686: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
687: is part of the NetBSD operating system and can be bootstrapped
688: to run on non-NetBSD operating systems as well. It handles
689: building (compiling), installing, and removing of
690: packages.</p></dd>
1.75 rillig 691: <dt><span class="term">Distfile</span></dt>
692: <dd><p>This term describes the file or files that are
693: provided by the author of the piece of software to
694: distribute his work. All the changes necessary to build on
695: NetBSD are reflected in the corresponding package. Usually
696: the distfile is in the form of a compressed tar-archive,
697: but other types are possible, too. Distfiles are usually
698: stored below
1.76 rillig 699: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 700: <dt><span class="term">Port</span></dt>
701: <dd><p>This is the term used by FreeBSD and OpenBSD people
702: for what we call a package.
703: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
704: architecture.</p></dd>
705: <dt><span class="term">Precompiled/binary package</span></dt>
706: <dd>
707: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 708: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 709: file so it can be installed on machines of the same
710: machine architecture without the need to
711: recompile. Packages are usually generated in
1.76 rillig 712: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.75 rillig 713: an archive on <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
714: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
715: especially in the context of precompiled packages.</p>
716: </dd>
717: <dt><span class="term">Program</span></dt>
1.88 wiz 718: <dd><p>The piece of software to be installed which will be
719: constructed from all the files in the distfile by the
720: actions defined in the corresponding package.</p></dd>
1.75 rillig 721: </dl></div>
722: <div class="sect2" lang="en">
723: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 724: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 725: <div class="variablelist"><dl>
726: <dt><span class="term">pkgsrc users</span></dt>
727: <dd>
728: <p>The
729: pkgsrc users are people who use the packages provided by pkgsrc.
730: Typically they are system administrators. The people using the
731: software that is inside the packages (maybe called “<span class="quote">end
732: users</span>”) are not covered by the pkgsrc guide.</p>
733: <p>There are two kinds of pkgsrc users: Some only want to
734: install pre-built binary packages. Others build the pkgsrc
735: packages from source, either for installing them directly or for
736: 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
737: documentation.</p>
738: </dd>
739: <dt><span class="term">package maintainers</span></dt>
740: <dd><p>A
741: 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>
742: <dt><span class="term">infrastructure developers</span></dt>
743: <dd><p>These people are involved in all those files
1.76 rillig 744: that live in the <code class="filename">mk/</code> directory and below.
1.75 rillig 745: 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,
746: too.</p></dd>
747: </dl></div>
748: </div>
749: </div>
750: <div class="sect1" lang="en">
751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
752: <a name="typography"></a>1.4. Typography</h2></div></div></div>
753: <p>When giving examples for commands, shell prompts are used to
754: show if the command should/can be issued as root, or if
755: “<span class="quote">normal</span>” user privileges are sufficient. We use a
756: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
757: shell prompt, assuming they use the C-shell or tcsh.</p>
758: </div>
759: </div>
760: <div class="part" lang="en">
761: <div class="titlepage"><div><div><h1 class="title">
762: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
763: <div class="toc">
764: <p><b>Table of Contents</b></p>
765: <dl>
766: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
767: <dd><dl>
768: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
769: <dd><dl>
770: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
771: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 772: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 773: </dl></dd>
774: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
775: <dd><dl>
776: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
777: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
778: </dl></dd>
779: </dl></dd>
780: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
781: <dd><dl>
1.82 rillig 782: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
783: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
784: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
785: <dd><dl>
786: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
787: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
788: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
789: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
790: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
791: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
792: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 793: </dl></dd>
794: </dl></dd>
795: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
796: <dd><dl>
797: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
798: <dd><dl>
799: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
800: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 801: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
802: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
803: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
804: <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>
805: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
806: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 807: </dl></dd>
808: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
809: <dd><dl>
810: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
811: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
812: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
813: </dl></dd>
814: </dl></dd>
815: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
816: <dd><dl>
817: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
818: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.103 wiz 819: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
820: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 821: <dd><dl>
1.103 wiz 822: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
823: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
824: <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.88 wiz 825: </dl></dd>
1.103 wiz 826: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
827: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 828: </dl></dd>
829: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
830: <dd><dl>
831: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
832: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
833: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
834: <dd><dl>
835: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
836: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
837: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
838: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
839: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
840: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
841: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
842: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
843: </dl></dd>
844: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
845: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
846: </dl></dd>
1.90 rillig 847: <dt><span class="chapter"><a href="#files">7. Directory layout of the installed files</a></span></dt>
848: <dd><dl>
1.91 rillig 849: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 850: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
851: </dl></dd>
852: <dt><span class="chapter"><a href="#faq">8. Frequently Asked Questions</a></span></dt>
1.75 rillig 853: <dd><dl>
1.90 rillig 854: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
855: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
856: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
857: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
858: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103 wiz 859: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
860: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
861: <dt><span class="sect1"><a href="#passive-ftp">8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
862: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
863: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.10. What does “<span class="quote">Don't know how to make
1.75 rillig 864: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.103 wiz 865: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
866: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
867: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
868: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
869: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
870: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build. What shall I do?</a></span></dt>
871: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 872: </dl></dd>
873: </dl>
874: </div>
875: <div class="chapter" lang="en">
876: <div class="titlepage"><div><div><h2 class="title">
877: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
878: <div class="toc">
879: <p><b>Table of Contents</b></p>
880: <dl>
881: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
882: <dd><dl>
883: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
884: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 885: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 886: </dl></dd>
887: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
888: <dd><dl>
889: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
890: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
891: </dl></dd>
892: </dl>
893: </div>
1.91 rillig 894: <p>Before you download and extract the files, you need to decide
895: where you want to extract them. When using pkgsrc as root user, pkgsrc
896: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
897: free to install the sources and binary packages wherever you want in
898: your filesystem, provided that the pathname does not contain white-space
899: or other characters that are interpreted specially by the shell and some
900: other programs. A safe bet is to use only letters, digits, underscores
901: and dashes.</p>
1.75 rillig 902: <div class="sect1" lang="en">
903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
904: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
905: <p>Before you download any pkgsrc files, you should decide
906: whether you want the <span class="emphasis"><em>current</em></span> branch or the
907: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
908: quarterly basis from the current branch and only gets modified
909: for security updates. The names of the stable branches are built
910: from the year and the quarter, for example
1.98 wiz 911: <code class="literal">2007Q1</code>.</p>
1.75 rillig 912: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
913: want to download pkgsrc. You can get it as a tar file, via SUP,
914: or via CVS. All three ways are described here.</p>
915: <div class="sect2" lang="en">
916: <div class="titlepage"><div><div><h3 class="title">
917: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
918: <p>The primary download location for all pkgsrc files is
919: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
920: number of subdirectories for different purposes, which are
1.76 rillig 921: 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>
1.75 rillig 922: <p>The tar file for the current branch is in the directory
1.76 rillig 923: <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>.
1.75 rillig 924: It is autogenerated daily.</p>
1.98 wiz 925: <p>The tar file for the stable branch 2007Q1 is in the
926: 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>
1.75 rillig 927: <p>After downloading the tar file, change to the directory
928: where you want to have pkgsrc. This is usually
1.91 rillig 929: <code class="filename">/usr</code>. Then, run <span><strong class="command">gzcat
930: pkgsrc.tar.gz | tar xf -</strong></span> to extract the files.</p>
1.75 rillig 931: </div>
932: <div class="sect2" lang="en">
933: <div class="titlepage"><div><div><h3 class="title">
934: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
935: <p>As an alternative to the tar file, you can get pkgsrc via
936: the Software Update Protocol, SUP. To do so, make sure your
937: supfile has a line
1.1 grant 938:
1.75 rillig 939: </p>
940: <pre class="programlisting">
1.100 rillig 941: release=pkgsrc
1.1 grant 942: </pre>
1.75 rillig 943: <p>
1.1 grant 944:
1.75 rillig 945: in it, see the examples in
1.76 rillig 946: <code class="filename">/usr/share/examples/supfiles</code>, and that the
947: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.75 rillig 948: run <span><strong class="command">sup -v
949: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
950: </div>
951: <div class="sect2" lang="en">
952: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 953: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.75 rillig 954: <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>
955: installed. To do an initial (full) checkout of pkgsrc, you first
956: have to set some environment variables. For the C-Shell,
957: type:</p>
958: <pre class="screen">
959: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
960: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
961: </pre>
962: <p>Or, the same for the bourne shell:</p>
963: <pre class="screen">
964: <code class="prompt">$</code> <strong class="userinput"><code>CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
965: <code class="prompt">$</code> <strong class="userinput"><code>CVS_RSH="ssh"</code></strong>
966: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT CVS_RSH</code></strong>
967: </pre>
1.101 rillig 968: <p>By default, cvs doesn't do things like most people would
969: expect it to do, and this is unlikely to change. But there is a
970: way to convince cvs, by creating a file called
971: <code class="filename">.cvsrc</code> in your home directory and saving
972: the following lines to it. This file will save you lots of
973: headache and some bug reports, so we strongly recommend it. You
974: can find an explanation of this file in the CVS
975: documentation.</p>
976: <pre class="programlisting">
977: # recommended CVS configuration file from the pkgsrc guide
978: checkout -P
1.103 wiz 979: update -dP
1.101 rillig 980: release -d
1.103 wiz 981: diff -upN
1.101 rillig 982: cvs -q -z3
983: rdiff -u
984: </pre>
1.75 rillig 985: <p>Then, you change to the directory where you want to have
986: your copy of pkgsrc. In most cases this is
1.76 rillig 987: <code class="filename">/usr</code>. In that directory you run the
1.75 rillig 988: checkout command, which is <span><strong class="command">cvs -q checkout -P
989: pkgsrc</strong></span> for the current branch and <span><strong class="command">cvs -q
1.98 wiz 990: checkout -rpkgsrc-2007Q1 -P pkgsrc</strong></span> for the stable
1.75 rillig 991: branch. This command will create a directory called
1.76 rillig 992: <code class="filename">pkgsrc</code> with all the pkgsrc files in
1.75 rillig 993: it.</p>
994: </div>
995: </div>
996: <div class="sect1" lang="en">
997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
998: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
999: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1000: (which also works if you have first installed it via a tar
1001: file). It saves bandwidth and hard disk activity, compared to
1002: downloading the tar file again.</p>
1003: <div class="sect2" lang="en">
1004: <div class="titlepage"><div><div><h3 class="title">
1005: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1006: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1007: <h3 class="title">Warning</h3>
1.77 rillig 1008: <p>When updating from a tar file, you first need to
1009: completely remove the old pkgsrc directory. Otherwise those
1010: files that have been removed from pkgsrc in the mean time will
1011: not be removed on your local disk, resulting in inconsistencies.
1012: When removing the old files, any changes that you have done to
1013: the pkgsrc files will be lost after updating. Therefore updating
1014: via CVS is strongly recommended.</p>
1.75 rillig 1015: </div>
1.82 rillig 1016: <p>Note that by default the distfiles and the binary packages
1017: are saved in the pkgsrc tree, so don't forget to rescue them
1018: before updating. You can also configure pkgsrc to use other than
1019: the default directories by setting the
1020: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1021: variables. See <a href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1022: <p>To update pkgsrc from a tar file, download the tar file as
1023: explained above. Then, make sure that you have not made any
1024: changes to the files in the pkgsrc directory. Remove the pkgsrc
1025: directory and extract the new tar file. Done.</p>
1026: </div>
1027: <div class="sect2" lang="en">
1028: <div class="titlepage"><div><div><h3 class="title">
1029: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1030: <p>To update pkgsrc via CVS, make sure the environment
1031: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1032: change to the pkgsrc directory and run <span><strong class="command">cvs -q update
1.77 rillig 1033: -dP</strong></span>.</p>
1.75 rillig 1034: <div class="sect3" lang="en">
1035: <div class="titlepage"><div><div><h4 class="title">
1036: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1037: <p>When updating pkgsrc, the CVS program keeps track of the
1038: branch you selected. But if you, for whatever reason, want to
1039: switch from the stable branch to the current one, you can do it
1040: by adding the option “<span class="quote">-A</span>” after the
1041: “<span class="quote">update</span>” keyword. To switch from the current branch
1042: back to the stable branch, add the
1.98 wiz 1043: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1.75 rillig 1044: </div>
1045: <div class="sect3" lang="en">
1046: <div class="titlepage"><div><div><h4 class="title">
1047: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1048: <p>When you update pkgsrc, the CVS program will only touch
1049: those files that are registered in the CVS repository. That
1050: means that any packages that you created on your own will stay
1051: unmodified. If you change files that are managed by CVS, later
1052: updates will try to merge your changes with those that have been
1053: done by others. See the CVS manual, chapter
1054: “<span class="quote">update</span>” for details.</p>
1055: </div>
1056: </div>
1057: </div>
1058: </div>
1059: <div class="chapter" lang="en">
1060: <div class="titlepage"><div><div><h2 class="title">
1061: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1062: <div class="toc">
1063: <p><b>Table of Contents</b></p>
1064: <dl>
1.82 rillig 1065: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1066: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1067: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1068: <dd><dl>
1069: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1070: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1071: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1072: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1073: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1074: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1075: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1076: </dl></dd>
1077: </dl>
1078: </div>
1079: <div class="sect1" lang="en">
1080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1081: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1082: <p>
1083: We provide a bootstrap kit in both source and binary form for other
1084: platforms than NetBSD, consisting of the pkg administration tools and other
1085: tools required to use pkgsrc and build packages.
1086: </p>
1087: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1088: <h3 class="title">Note</h3>
1089: <p>
1090: Older binary snapshots are available in the
1091: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/archive/" target="_top">bootstrap-pkgsrc/archive</a>
1092: directory on ftp.NetBSD.org.</p>
1093: </div>
1094: <div class="table">
1095: <a name="binary-kits"></a><p class="title"><b>Table 3.1. Binary kits and available packages</b></p>
1.91 rillig 1096: <div class="table-contents"><table summary="Binary kits and available packages" border="1">
1.82 rillig 1097: <colgroup>
1098: <col>
1099: <col>
1100: <col>
1101: <col>
1102: </colgroup>
1103: <thead><tr>
1104: <th>Platform</th>
1105: <th>Latest snapshot</th>
1106: <th>Binary kit</th>
1107: <th>Binary packages</th>
1108: </tr></thead>
1109: <tbody>
1110: <tr>
1111: <td class="osname">Darwin 5.5/powerpc (Mac OS X 10.1.5)</td>
1112: <td class="date">20021209</td>
1113: <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>
1114: <td class="binary-pkgs-url"> </td>
1115: </tr>
1116: <tr>
1117: <td class="osname">Darwin 6.6/powerpc (Mac OS X 10.2.6)</td>
1118: <td class="date">20030623</td>
1119: <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>
1120: <td class="binary-pkgs-url"> </td>
1121: </tr>
1122: <tr>
1123: <td class="osname">Darwin 7.6/powerpc (Mac OS X 10.3.6)</td>
1124: <td class="date">20041219</td>
1125: <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>
1126: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/Darwin-7.6/" target="_top">binary packages</a></td>
1127: </tr>
1128: <tr>
1129: <td class="osname">Darwin 7.8/powerpc (Mac OS X 10.3.8)</td>
1130: <td class="date">20050320</td>
1131: <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>
1132: <td class="binary-pkgs-url"> </td>
1133: </tr>
1134: <tr>
1135: <td class="osname">Darwin 8.1/powerpc (Mac OS X 10.4.1)</td>
1136: <td class="date">20050625</td>
1137: <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>
1138: <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>
1139: </tr>
1140: <tr>
1141: <td class="osname">Debian GNU Linux/i386</td>
1142: <td class="date">20031023</td>
1143: <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>
1144: <td class="binary-pkgs-url"> </td>
1145: </tr>
1146: <tr>
1147: <td class="osname">Fedora Core 2 Linux/i386</td>
1148: <td class="date">20050618</td>
1149: <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>
1150: <td class="binary-pkgs-url"> </td>
1151: </tr>
1152: <tr>
1153: <td class="osname">Fedora Core 4 Linux/i386</td>
1154: <td class="date">20060105</td>
1155: <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>
1156: <td class="binary-pkgs-url"> </td>
1157: </tr>
1158: <tr>
1159: <td class="osname">FreeBSD 3.5/i386</td>
1160: <td class="date">20030411</td>
1161: <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>
1162: <td class="binary-pkgs-url"> </td>
1163: </tr>
1164: <tr>
1165: <td class="osname">FreeBSD 4.7/i386</td>
1166: <td class="date">20021211</td>
1167: <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>
1168: <td class="binary-pkgs-url"> </td>
1169: </tr>
1170: <tr>
1171: <td class="osname">FreeBSD 5.0/i386</td>
1172: <td class="date">20030411</td>
1173: <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>
1174: <td class="binary-pkgs-url"> </td>
1175: </tr>
1176: <tr>
1177: <td class="osname">FreeBSD 5.1/i386</td>
1178: <td class="date">20030630</td>
1179: <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>
1180: <td class="binary-pkgs-url"> </td>
1181: </tr>
1182: <tr>
1183: <td class="osname">FreeBSD 5.2.1/i386</td>
1184: <td class="date">20040227</td>
1185: <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>
1186: <td class="binary-pkgs-url"> </td>
1187: </tr>
1188: <tr>
1189: <td class="osname">FreeBSD 5.3/i386</td>
1190: <td class="date">20050119</td>
1191: <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>
1192: <td class="binary-pkgs-url"> </td>
1193: </tr>
1194: <tr>
1.98 wiz 1195: <td class="osname">HP-UX 11.11/hppa</td>
1196: <td class="date">20070421</td>
1197: <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>
1198: <td class="binary-pkgs-url"> </td>
1199: </tr>
1200: <tr>
1.82 rillig 1201: <td class="osname">Interix 3.5</td>
1.93 rillig 1202: <td class="date">20061106</td>
1203: <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>
1204: <td class="binary-pkgs-url"> </td>
1.82 rillig 1205: </tr>
1206: <tr>
1207: <td class="osname">IRIX 6.5 n32-bit ABI</td>
1208: <td class="date">20040911</td>
1209: <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>
1210: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/n32/" target="_top">binary packages</a></td>
1211: </tr>
1212: <tr>
1213: <td class="osname">IRIX 6.5 64-bit ABI</td>
1214: <td class="date">20040912</td>
1215: <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>
1216: <td class="binary-pkgs-url"><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/IRIX-6.5/64/" target="_top">binary packages</a></td>
1217: </tr>
1218: <tr>
1219: <td class="osname">OpenBSD 3.2/i386</td>
1220: <td class="date">20030420</td>
1221: <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>
1222: <td class="binary-pkgs-url"> </td>
1223: </tr>
1224: <tr>
1225: <td class="osname">OpenBSD 3.3/i386</td>
1226: <td class="date">20030503</td>
1227: <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>
1228: <td class="binary-pkgs-url"> </td>
1229: </tr>
1230: <tr>
1231: <td class="osname">OpenBSD 3.5/i386</td>
1.93 rillig 1232: <td class="date">20040703</td>
1.82 rillig 1233: <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>
1234: <td class="binary-pkgs-url"> </td>
1235: </tr>
1236: <tr>
1.98 wiz 1237: <td class="osname">OSF1 5.1/alpha</td>
1238: <td class="date">20070420</td>
1239: <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>
1240: <td class="binary-pkgs-url"> </td>
1241: </tr>
1242: <tr>
1.82 rillig 1243: <td class="osname">Slackware Linux 8.1/i386</td>
1244: <td class="date">20030417</td>
1245: <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>
1246: <td class="binary-pkgs-url"> </td>
1247: </tr>
1248: <tr>
1249: <td class="osname">Slackware Linux 9/i386</td>
1.93 rillig 1250: <td class="date">20040703</td>
1.82 rillig 1251: <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>
1252: <td class="binary-pkgs-url"> </td>
1253: </tr>
1254: <tr>
1255: <td class="osname">Solaris 8/sparc</td>
1256: <td class="date">20050220</td>
1257: <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>
1258: <td class="binary-pkgs-url"> </td>
1259: </tr>
1260: <tr>
1261: <td class="osname">Solaris 8/i386</td>
1262: <td class="date">20050220</td>
1263: <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>
1264: <td class="binary-pkgs-url"> </td>
1265: </tr>
1266: <tr>
1267: <td class="osname">Solaris 9/sparc</td>
1.93 rillig 1268: <td class="date">20060713</td>
1269: <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>
1270: <td class="binary-pkgs-url"> </td>
1.82 rillig 1271: </tr>
1272: <tr>
1273: <td class="osname">Solaris 9/i386</td>
1274: <td class="date">20030411</td>
1275: <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>
1276: <td class="binary-pkgs-url"> </td>
1277: </tr>
1278: </tbody>
1.91 rillig 1279: </table></div>
1.82 rillig 1280: </div>
1.91 rillig 1281: <br class="table-break"><p>
1.82 rillig 1282: Simply download the binary kit for your platform, and extract it into
1283: <code class="filename">/</code> e.g.
1284: </p>
1285: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
1286: <code class="prompt">#</code> <strong class="userinput"><code>gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1287: | tar -xpf -</code></strong></pre>
1288: <p>
1289: Of course, as with any binary distributions, you should verify the
1290: checksum against the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/SUM" target="_top">SUM</a>
1291: or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/bootstrap-pkgsrc/CKSUM" target="_top">CKSUM</a>
1292: file and inspect the contents before extracting it.
1293: </p>
1294: </div>
1295: <div class="sect1" lang="en">
1296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1297: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1298: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1299: <pre class="screen">
1300: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1301: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1302: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1303: </pre>
1.75 rillig 1304: <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
1.87 wiz 1305: pkgsrc before bootstrapping. The given
1306: <span><strong class="command">bootstrap</strong></span> command will use the defaults of
1307: <code class="filename">/usr/pkg</code> for the
1308: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1309: and <code class="filename">/var/db/pkg</code> for the package database
1310: directory where pkgsrc will do its internal bookkeeping.
1311: However, these can also be set using command-line
1312: arguments.</p>
1.75 rillig 1313: <p>Binary packages for the pkgsrc tools and an initial set of packages is
1.87 wiz 1314: available for supported platforms. An up-to-date list of these can be
1315: found on <a href="http://www.pkgsrc.org/" target="_top">www.pkgsrc.org</a>.
1316: Note that this only works for privileged builds that install
1317: into <code class="filename">/usr/pkg</code>.</p>
1.75 rillig 1318: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1319: <h3 class="title">Note</h3>
1320: <p>The bootstrap installs a <span><strong class="command">bmake</strong></span> tool.
1.87 wiz 1321: Use this <span><strong class="command">bmake</strong></span> when building via pkgsrc.
1322: For examples in this guide, use <span><strong class="command">bmake</strong></span>
1323: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1324: </div>
1325: </div>
1326: <div class="sect1" lang="en">
1327: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1328: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1329: <p>Here are some platform-specific notes you should be aware of.</p>
1330: <div class="sect2" lang="en">
1331: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1332: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1333: <p>Darwin 5.x and up are supported. There are two methods of using
1.82 rillig 1334: pkgsrc on Mac OS X, by using a <a href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1.89 rillig 1335: image</a>, or a <a href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75 rillig 1336: partition</a>.</p>
1337: <p>Before you start, you will need to download and install the Mac OS X Developer
1.87 wiz 1338: Tools from Apple's Developer Connection. See <a href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1339: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1340: from <a href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1341: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1342: <p>If you already have a UFS or HFSX partition, or have a spare partition
1343: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1344: the disk image. It'll be somewhat faster and will mount automatically
1345: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1346: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1347: <h3 class="title">Note</h3>
1.85 jmmv 1348: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1349: 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>
1.75 rillig 1350: </div>
1351: <div class="sect3" lang="en">
1352: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1353: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1354: <p>Create the disk image:</p>
1355: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95 tron 1356: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85 jmmv 1357: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1358: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1359: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1360: <h3 class="title">Note</h3>
1.89 rillig 1361: <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>
1.85 jmmv 1362: </div>
1.89 rillig 1363: <p>Allow suid:</p>
1364: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105 ! weinem 1365: <p>Changing the build directory:</p>
! 1366: <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>
! 1367: <pre class="programlisting">
! 1368: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
! 1369: </pre>
1.75 rillig 1370: </div>
1371: <div class="sect3" lang="en">
1372: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1373: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1374: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1375: system, normally HFS+. It is possible to use the default
1376: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1377: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1378: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1379: place the package database directory outside the
1380: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1381: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1382: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1383: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1384: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1385: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1386: to ensure that the partition map correctly reflects
1.89 rillig 1387: “<span class="quote">Apple_UFS</span>” or “<span class="quote">Apple_HFSX</span>” and not “<span class="quote">Apple_HFS</span>”.</p>
1.75 rillig 1388: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1389: disk that is booted from. You can unmount the partition, but even if
1390: you newfs it, the partition type will be incorrect and the
1391: automounter won't mount it. It can be mounted manually, but it won't
1392: appear in Finder.</p>
1.75 rillig 1393: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1394: the Installation program starts, go up to the menu and select Disk
1395: Utility. Now, you will be able to select the partition you want
1.89 rillig 1396: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1397: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1398: will appear in Finder.</p>
1.75 rillig 1399: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1400: by root only.</p>
1.75 rillig 1401: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1402: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1403: </div>
1404: </div>
1405: <div class="sect2" lang="en">
1406: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1407: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1408: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1409: other versions may work.</p>
1.75 rillig 1410: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1411: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1412: <div class="orderedlist"><ol type="1">
1413: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1414: <code class="filename">/var/db/pkg</code>. It is therefore
1415: recommended that you choose a different location (e.g.
1416: <code class="filename">/usr/pkgdb</code>) by
1417: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1418: <li>
1419: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1420: good idea to move them out of the way to avoid confusion, e.g.</p>
1421: <pre class="screen">
1422: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1423: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1424: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1425: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1426: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1427: </pre>
1.75 rillig 1428: </li>
1.104 rillig 1429: <li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1430: <code class="filename">/etc/mk.conf.example</code> file
1431: when you use the bootstrap script.</p></li>
1.75 rillig 1432: </ol></div>
1433: </div>
1434: <div class="sect2" lang="en">
1435: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1436: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1437: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1438: providing a Unix-like environment with a tighter kernel integration than
1439: available with Cygwin. It is part of the Windows Services for Unix
1440: package, available for free for any licensed copy of Windows 2000, XP
1441: (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>
1.93 rillig 1442: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1443: are not officially supported. (The main difference in 3.0/3.1 is lack
1444: of pthreads, but other parts of libc may also be lacking.)</p>
1445: <p>Services for Unix Applications (aka SUA) is an integrated component
1446: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1447: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1448: <div class="sect3" lang="en">
1449: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1450: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1451: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1452: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1453: <div class="itemizedlist"><ul type="disc">
1454: <li><p>Utilities -> Base Utilities</p></li>
1455: <li><p>Interix GNU Components -> (all)</p></li>
1456: <li><p>Remote Connectivity</p></li>
1457: <li><p>Interix SDK</p></li>
1458: </ul></div>
1459: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1460: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1461: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1462: pkgsrc (or from a binary package).</p>
1.75 rillig 1463: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1464: not need to be installed, but Remote Connectivity itself should be
1465: installed in order to have a working inetd.</p>
1.75 rillig 1466: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1467: behavior for Interix programs, and whether to make pathnames default to
1468: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1469: enabled. (Without case-sensitivity, a large number of packages including
1470: perl will not build.)</p>
1.75 rillig 1471: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1472: works (via the Data Execution Prevention feature). In order to use
1473: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1474: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1475: must be installed. Hotfixes are available from Microsoft through a
1476: support contract; however, a NetBSD developer has made most Interix
1477: 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>
1.93 rillig 1478: <p>In addition to the hotfix noted above, it may be necessary to
1479: disable Data Execution Prevention entirely to make Interix functional.
1480: This may happen only with certain types of CPUs; the cause is not fully
1481: understood at this time. If gcc or other applications still segfault
1482: repeatedly after installing one of the hotfixes note above, the
1483: following option can be added to the appropriate "boot.ini" line on the
1484: Windows boot drive: /NoExecute=AlwaysOff
1485: (WARNING, this will disable DEP completely, which may be a security
1486: risk if applications are often run as a user in the Administrators
1487: group!)</p>
1.75 rillig 1488: </div>
1489: <div class="sect3" lang="en">
1490: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1491: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75 rillig 1492: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1493: with pkgsrc, note the following things.</p>
1.75 rillig 1494: <div class="itemizedlist"><ul type="disc">
1495: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1496: Windows Services for UNIX, then click Change. In the installer, choose
1497: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1498: <li>
1499: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1500: change the following registry key:</p>
1.75 rillig 1501: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1502: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1503: </li>
1504: <li>
1505: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1506: following registry key:</p>
1.75 rillig 1507: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1508: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1509: </li>
1510: </ul></div>
1511: </div>
1512: <div class="sect3" lang="en">
1513: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1514: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1515: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1516: running "pkg_add") must be a member of the local Administrators
1517: group. Such a user must also be used to run the bootstrap. This is
1518: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1519: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1520: automatically complain if this is not the case. This ensures that
1521: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1522: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1523: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1524: NOT be used in conjunction with pkgsrc. If you choose to use them at
1525: the same time as the pkgsrc packages, ensure that you use the proper
1526: pkg_* tools for each type of binary package.</p>
1.75 rillig 1527: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1528: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1529: don't have a termcap/terminfo entry for it, but the following .termcap
1530: entry provides adequate emulation in most cases:</p>
1.75 rillig 1531: <pre class="programlisting">
1.100 rillig 1532: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1533: </pre>
1.75 rillig 1534: </div>
1535: <div class="sect3" lang="en">
1536: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1537: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1538: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1539: for a full Unix-like platform, it has some drawbacks that should
1540: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1541: <div class="itemizedlist"><ul type="disc">
1542: <li>
1543: <p><span class="strong"><strong>X11:</strong></span></p>
1544: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1545: and can run X11 based applications, but it does
1546: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1547: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1548: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1549: (available in a trimmed version for Interix from Interop Systems as the
1550: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1551: and the free X11 server included with
1552: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1553: </li>
1554: <li>
1555: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1556: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1557: Win32 applications, it does not currently support various X11
1558: protocol extensions for acceleration (such as MIT-SHM or DGA).
1559: Most interactive applications to a local X server will run
1560: reasonably fast, but full motion video and other graphics
1561: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1562: </li>
1563: <li>
1564: <p><span class="strong"><strong>Audio:</strong></span></p>
1565: <p>Interix has no native support for audio output. For audio
1.87 wiz 1566: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1567: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1568: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.87 wiz 1569: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1570: server component. To output audio via an Interix host, the
1.91 rillig 1571: <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
1.87 wiz 1572: must also be installed.</p>
1.75 rillig 1573: </li>
1574: <li>
1575: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1576: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1577: is not currently possible to access CD/DVD drives, USB devices,
1578: or SCSI devices through non-filesystem means. Among other things,
1579: this makes it impossible to use Interix directly for CD/DVD
1580: burning.</p>
1.75 rillig 1581: </li>
1582: <li>
1583: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1584: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1585: drives are also not directly accessible in Interix. However,
1586: support is in work to make tape drive access possible by using
1587: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1588: esound server).</p>
1.75 rillig 1589: </li>
1590: </ul></div>
1591: </div>
1592: <div class="sect3" lang="en">
1593: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1594: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1595: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1596: Windows system; any member of the local Administrators group will
1597: suffice. However, some packages currently assume that the user
1598: named "root" is the privileged user. To accommodate these, you
1599: may create such a user; make sure it is in the local group
1600: Administrators (or your language equivalent).</p>
1601: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1602: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1603: time being, install packages as the local Administrator (or
1604: your language equivalent), or run the following command after
1605: installing a package to work around the issue:</p>
1.75 rillig 1606: <pre class="screen">
1.87 wiz 1607: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1608: </pre>
1.75 rillig 1609: </div>
1610: </div>
1611: <div class="sect2" lang="en">
1612: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1613: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1614: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1615: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1616: according to your preference. If you do not have a license for the MIPSpro
1617: compiler suite, you can download a gcc tardist file from <a href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1618: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1619: 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>,
1620: etc.</p>
1.86 schwarz 1621: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1622: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1623: you start out using "abi=n32", that's what all your packages will be built
1624: with.</p>
1625: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1626: <code class="varname">CFLAGS</code> in your environment or the
1.104 rillig 1627: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1628: try to link n32 object files with lib64 or vice versa. Check your
1629: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1630: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1631: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1632: as it appears that IRIX linker occasionally runs into issues when trying to
1633: link over a network-mounted file system.</p>
1.75 rillig 1634: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1635: as imake(1), but you may want to set some options depending on your local
1636: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1637: course, your compiler's man pages for details.</p>
1.75 rillig 1638: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1639:
1.87 wiz 1640: </p>
1.75 rillig 1641: <pre class="programlisting">
1.100 rillig 1642: PKGSRC_COMPILER= mipspro
1.87 wiz 1643: </pre>
1.75 rillig 1644: <p>
1.1 grant 1645:
1.104 rillig 1646: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1647: are using gcc and may end up passing invalid flags to the compiler. Note that
1648: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1649: default.</p>
1.75 rillig 1650: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1651: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1652: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1653: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1654: '--preserve-path' flag.</p>
1.75 rillig 1655: </div>
1656: <div class="sect2" lang="en">
1657: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1658: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1659: <p>Some versions of Linux (for example Debian GNU/Linux) need
1660: either libtermcap or libcurses (libncurses). Installing the
1661: distributions libncurses-dev package (or equivalent) should fix
1662: the problem.</p>
1663: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1664: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1665: i386 have been tested.</p>
1.75 rillig 1666: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1667: directory:</p>
1.75 rillig 1668: <pre class="programlisting">
1.100 rillig 1669: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1670: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1671: </pre>
1.75 rillig 1672: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1673: <h3 class="title">Note</h3>
1674: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1675: </div>
1676: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1677: function, which icc does not support. #undef'ing __attribute__ has the
1678: unfortunate side-effect of breaking many of the Linux header files, which
1679: cannot be compiled properly without __attribute__. The test must be
1680: overridden so that __attribute__ is assumed supported by the
1681: compiler.</p>
1.75 rillig 1682: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.104 rillig 1683: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1684: <pre class="programlisting">
1.100 rillig 1685: PKGSRC_COMPILER= icc
1.87 wiz 1686: </pre>
1.75 rillig 1687: <p>The default installation directory for icc is
1.87 wiz 1688: <code class="filename">/opt/intel_cc_80</code>, which
1689: is also the pkgsrc default. If you have installed it into a different
1690: directory, set <code class="varname">ICCBASE</code> in
1.104 rillig 1691: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1692: <pre class="programlisting">
1.100 rillig 1693: ICCBASE= /opt/icc
1.87 wiz 1694: </pre>
1.75 rillig 1695: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1696: provided by icc, so binaries can be run on other systems which do not
1697: have the shared libraries installed.</p>
1698: <p>Libtool, however, extracts a list of libraries from the
1699: <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
1700: records it, throwing away the -Bstatic and -Bdynamic options
1701: interspersed between the libraries. This means that
1702: libtool-linked C++ shared libraries will have a runtime
1703: dependency on the icc libraries until this is fixed in
1704: libtool.</p>
1.75 rillig 1705: </div>
1706: <div class="sect2" lang="en">
1707: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1708: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1709: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1710: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1711: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1712: <div class="orderedlist"><ol type="1">
1713: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1714: <code class="filename">/var/db/pkg</code>. It is therefore
1715: recommended that you choose a different location (e.g.
1716: <code class="filename">/usr/pkgdb</code>) by
1717: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1718: <li>
1719: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1720: good idea to move them out of the way to avoid confusion, e.g.</p>
1721: <pre class="screen">
1722: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1723: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1724: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1725: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1726: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1727: </pre>
1.75 rillig 1728: </li>
1729: <li>
1.104 rillig 1730: <p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1731: <code class="filename">/etc/mk.conf.example</code> file
1732: when you use the bootstrap script. OpenBSD's make program uses
1.104 rillig 1733: <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1734: as well. You can work around this by enclosing all the pkgsrc-specific parts
1735: of the file with:</p>
1736: <pre class="programlisting">
1.100 rillig 1737: .ifdef BSD_PKG_MK
1738: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1739: .else
1740: # OpenBSD stuff
1741: .endif
1.87 wiz 1742: </pre>
1.75 rillig 1743: </li>
1744: </ol></div>
1745: </div>
1746: <div class="sect2" lang="en">
1747: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1748: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1749: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1750: You will need a working C compiler. Both gcc 2.95.3 and
1751: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1752: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1753: process and to build packages.</p>
1.75 rillig 1754: <div class="itemizedlist"><ul type="disc">
1755: <li><p>SUNWsprot</p></li>
1756: <li><p>SUNWarc</p></li>
1757: <li><p>SUNWbtool</p></li>
1758: <li><p>SUNWtoo</p></li>
1759: <li><p>SUNWlibm</p></li>
1760: </ul></div>
1.78 rillig 1761: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1762: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1763: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1764: your $prefix are in your <code class="varname">PATH</code>. This includes
1765: <code class="filename">/usr/ccs/{bin,lib}</code>
1766: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1767: <div class="sect3" lang="en">
1768: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1769: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1770: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1771: for building all packages.</p>
1.75 rillig 1772: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1773: then either build gcc from
1.91 rillig 1774: <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
1.87 wiz 1775: package, then remove gcc used during bootstrapping.</p>
1.93 rillig 1776: <p>Binary packages of gcc can be found through <a href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1777: </div>
1778: <div class="sect3" lang="en">
1779: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1780: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1781: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1782: 5.0)</p>
1.75 rillig 1783: <div class="itemizedlist"><ul type="disc">
1784: <li><p>SPROcc
1.87 wiz 1785: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1786: <li><p>SPROcpl
1.87 wiz 1787: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1788: <li><p>SPROild
1.87 wiz 1789: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1790: <li><p>SPROlang
1.87 wiz 1791: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1792: </ul></div>
1.96 rillig 1793: <p>You should set the following variables in your
1.104 rillig 1794: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1795: <pre class="programlisting">
1.100 rillig 1796: CC= cc
1797: CXX= CC
1798: CPP= cc -E
1799: CXXCPP= CC -E
1.96 rillig 1800: </pre>
1801: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1802: <h3 class="title">Note</h3>
1803: <p>The <code class="varname">CPP</code> setting might break some
1804: packages that use the C preprocessor for processing things other
1805: than C source code.</p>
1806: </div>
1.75 rillig 1807: </div>
1808: <div class="sect3" lang="en">
1809: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1810: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1811: <p>To build 64-bit packages, you just need to have the
1.104 rillig 1812: following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1813: <pre class="programlisting">
1.100 rillig 1814: PKGSRC_COMPILER= sunpro
1815: ABI= 64
1.96 rillig 1816: </pre>
1817: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1818: <h3 class="title">Note</h3>
1819: <p>This setting has been tested for the SPARC
1820: architecture. Intel and AMD machines need some more
1821: work.</p>
1822: </div>
1.75 rillig 1823: </div>
1824: <div class="sect3" lang="en">
1825: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1826: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1827: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1828: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1829: The workaround is to use another shell for the configure
1.91 rillig 1830: 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.104 rillig 1831: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1832: <pre class="programlisting">
1.100 rillig 1833: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1834: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1835: </pre>
1.91 rillig 1836: <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>
1.75 rillig 1837: </div>
1838: </div>
1839: </div>
1840: </div>
1841: <div class="chapter" lang="en">
1842: <div class="titlepage"><div><div><h2 class="title">
1843: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1844: <div class="toc">
1845: <p><b>Table of Contents</b></p>
1846: <dl>
1847: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1848: <dd><dl>
1849: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1850: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1851: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1852: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1853: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1854: <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>
1855: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1856: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1857: </dl></dd>
1858: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1859: <dd><dl>
1860: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1861: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1862: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1863: </dl></dd>
1864: </dl>
1865: </div>
1866: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1867: is to only install the package tools and to use binary packages
1868: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1869: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1870: of pkgsrc, too. Then you are able to build your own packages,
1871: and you can still use binary packages from someone else.</p>
1.75 rillig 1872: <div class="sect1" lang="en">
1873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1874: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.105 ! weinem 1875: <p>To use binary packages, you need some tools to manage them. On
! 1876: NetBSD, these tools are already installed. On all other operating
! 1877: systems, you need to install them first. For some platforms, these
! 1878: tools are already packages in an archive, ready to be extracted in the
! 1879: <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>
! 1880: directory of the FTP server.</p>
1.82 rillig 1881: <p>These pre-built package tools use
1.88 wiz 1882: <code class="filename">/usr/pkg</code> for the base directory, and
1883: <code class="filename">/var/db/pkg</code> for the database of installed
1884: packages. If you cannot use these directories for whatever
1885: reasons (maybe because you're not root), you have to build the
1886: package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.75 rillig 1887: <div class="sect2" lang="en">
1888: <div class="titlepage"><div><div><h3 class="title">
1889: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 ! weinem 1890: <p>To install binary packages, you first need to know from where
! 1891: to get them. The first place where you should look is on the main
! 1892: 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>
! 1893: <p>This directory contains binary packages for multiple
! 1894: platforms. First, select your operating system. (Ignore the
! 1895: directories with version numbers attached to it, they just exist for
! 1896: legacy reasons.) Then, select your hardware architecture, and in the
! 1897: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.
! 1898: This directory contains a subdirectory called
! 1899: <code class="filename">All</code>, where (almost) all binary packages are
! 1900: stored. Almost, because vulnerable packages are moved to the
! 1901: <code class="filename">vulnerable</code> directory so they don't get
! 1902: installed accidentally.</p>
1.75 rillig 1903: </div>
1904: <div class="sect2" lang="en">
1905: <div class="titlepage"><div><div><h3 class="title">
1906: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1907: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1908: your hard disk, you can install them with the following command
1909: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1910: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1911: <p>If you have FTP access and you don't want to download the
1.88 wiz 1912: packages via FTP prior to installation, you can do this
1913: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.105 ! weinem 1914: <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.75 rillig 1915: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1916: package in question will be installed, too, assuming they are
1917: present where you install from.</p>
1.75 rillig 1918: <p>To save some typing, you can set the
1.88 wiz 1919: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1920: list of paths (including remote URLs); trailing slashes are not allowed.
1921: </p>
1.76 rillig 1922: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1923: there exists a <code class="filename">vulnerable</code> directory to
1924: which binary packages with known vulnerabilities are
1925: moved, since removing them could cause missing dependencies. To
1926: use these packages, add the <code class="filename">vulnerable</code>
1927: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 rillig 1928: <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,
1.88 wiz 1929: especially after installing new packages, and verify that the
1930: vulnerabilities are acceptable for your configuration. An example
1931: <code class="varname">PKG_PATH</code> would be:
1932: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1933: Please note that semicolon (';') is a shell meta-character, so
1934: you'll probably have to quote it.</p>
1.75 rillig 1935: <p>After you've installed packages, be sure to have
1.88 wiz 1936: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1937: <code class="varname">PATH</code> so you can actually start the just
1938: installed program.</p>
1.75 rillig 1939: </div>
1940: <div class="sect2" lang="en">
1941: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1942: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1943: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1944: installed from source code or from a binary package. The
1945: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1946: To delete a package, you can just run <span><strong class="command">pkg_delete
1947: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1948: name can be given with or without version number. Wildcards can
1949: also be used to deinstall a set of packages, for example
1950: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1951: so that the shell does not expand them before
1952: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1953: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1954: removes all the packages that require the package in question
1955: and then removes the package itself. For example:
1.82 rillig 1956:
1.88 wiz 1957: </p>
1.82 rillig 1958: <pre class="screen">
1.88 wiz 1959: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1960: </pre>
1.82 rillig 1961: <p>
1962:
1.88 wiz 1963: will remove jpeg and all the packages that used it; this allows
1964: upgrading the jpeg package.</p>
1.82 rillig 1965: </div>
1966: <div class="sect2" lang="en">
1967: <div class="titlepage"><div><div><h3 class="title">
1968: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1969: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 1970: installed packages or binary package files.</p>
1.82 rillig 1971: </div>
1972: <div class="sect2" lang="en">
1973: <div class="titlepage"><div><div><h3 class="title">
1974: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1975: <p>
1.88 wiz 1976: The NetBSD Security-Officer and Packages Groups maintain a list of
1977: known security vulnerabilities to packages which are (or have been)
1978: included in pkgsrc. The list is available from the NetBSD
1979: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1980: </p>
1.82 rillig 1981: <p>
1.93 rillig 1982: 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>,
1.88 wiz 1983: this list can be downloaded
1984: automatically, and a security audit of all packages installed on a system
1985: can take place.
1986: </p>
1.82 rillig 1987: <p>
1.93 rillig 1988: There are two components to
1.91 rillig 1989: <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
1.88 wiz 1990: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
1991: the list of vulnerabilities from the NetBSD FTP site. The second
1992: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
1993: installed packages are vulnerable. If a package is vulnerable, you
1994: will see output similar to the following:
1995: </p>
1.82 rillig 1996: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1997: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1998: <p>
1.91 rillig 1999: One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.88 wiz 2000: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2001: file daily, and include a package audit in the daily security script.
2002: 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>
1.91 rillig 2003: 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>.
1.88 wiz 2004: </p>
1.82 rillig 2005: </div>
2006: <div class="sect2" lang="en">
2007: <div class="titlepage"><div><div><h3 class="title">
2008: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2009: <p>
1.93 rillig 2010: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a> and run
1.88 wiz 2011: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2012: argument to check if your packages are up-to-date, e.g.
2013: </p>
2014: <pre class="screen">
2015: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2016: ...
1.88 wiz 2017: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2018: </pre>
1.82 rillig 2019: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2020: package on your system and rebuild any dependencies.
2021: </p>
1.82 rillig 2022: </div>
2023: <div class="sect2" lang="en">
2024: <div class="titlepage"><div><div><h3 class="title">
2025: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2026: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2027: administrative functions on the package system.</p>
1.82 rillig 2028: </div>
2029: <div class="sect2" lang="en">
2030: <div class="titlepage"><div><div><h3 class="title">
2031: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2032: <p>Please pay very careful attention to the warnings
1.88 wiz 2033: 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
2034: inherent dangers of installing binary packages which you did
2035: not create yourself, and the security holes that can be
2036: introduced onto your system by indiscriminate adding of such
2037: files.</p>
1.75 rillig 2038: <p>The same warning of course applies to every package you
1.88 wiz 2039: install from source when you haven't completely read and
2040: understood the source code of the package, the compiler that
2041: is used to build the package and all the other tools that are
2042: involved.</p>
1.75 rillig 2043: </div>
2044: </div>
2045: <div class="sect1" lang="en">
2046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2047: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2048: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2049: directory now contains a set of packages, organized into
2050: categories. You can browse the online index of packages, or run
2051: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2052: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 2053: 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>
1.88 wiz 2054: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2055: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2056: should do so by setting <code class="varname">LOCALBASE</code> in
1.104 rillig 2057: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 2058: different <code class="varname">LOCALBASE</code> definitions on the same
2059: system (inside a chroot is an exception). </p>
2060: <p>The rest of this chapter assumes that the package is already
2061: 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
2062: instructions how to create your own packages.</p>
1.75 rillig 2063: <div class="sect2" lang="en">
2064: <div class="titlepage"><div><div><h3 class="title">
2065: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2066: <p>To build packages from source, you need a working C
1.88 wiz 2067: compiler. On NetBSD, you need to install the
2068: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2069: sets. If you want to build X11-related packages, the
2070: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2071: sets are required, too.</p>
1.75 rillig 2072: </div>
2073: <div class="sect2" lang="en">
2074: <div class="titlepage"><div><div><h3 class="title">
2075: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2076: <p>The first step for building a package is downloading the
1.88 wiz 2077: distfiles (i.e. the unmodified source). If they have not yet been
2078: downloaded, pkgsrc will fetch them automatically.</p>
2079: <p>If you have all files that you need in the
2080: <code class="filename">distfiles</code> directory,
2081: you don't need to connect. If the distfiles are on CD-ROM, you can
2082: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2083: </p>
1.82 rillig 2084: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2085: <p>
1.104 rillig 2086: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 2087: <p>By default a list of distribution sites will be randomly
2088: intermixed to prevent huge load on servers which holding popular
2089: packages (for example, SourceForge.net mirrors). Thus, every
2090: time when you need to fetch yet another distfile all the mirrors
2091: will be tried in new (random) order. You can turn this feature
2092: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2093: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2094: <p>You can overwrite some of the major distribution sites to
2095: fit to sites that are close to your own. By setting one or two
2096: variables you can modify the order in which the master sites are
2097: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2098: delimited list of domain suffixes.
2099: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2100: contains a whitespace delimited list of regular expressions. It
2101: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2102: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2103: some examples. This may save some of your bandwidth and
2104: time.</p>
1.75 rillig 2105: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2106: if you want to keep the settings, by editing the
1.104 rillig 2107: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 2108: and adding the definitions there.</p>
1.82 rillig 2109: <p>
1.88 wiz 2110: If a package depends on many other packages (such as
1.93 rillig 2111: <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
1.88 wiz 2112: alternate between periods of
2113: downloading source, and compiling. To ensure you have all the source
2114: downloaded initially you can run the command:
2115: </p>
1.82 rillig 2116: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2117: <p>
1.88 wiz 2118: which will output and run a set of shell commands to fetch the
2119: necessary files into the <code class="filename">distfiles</code> directory. You can
2120: also choose to download the files manually.
2121: </p>
1.75 rillig 2122: </div>
2123: <div class="sect2" lang="en">
2124: <div class="titlepage"><div><div><h3 class="title">
2125: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2126: <p>
1.88 wiz 2127: Once the software has downloaded, any patches will be applied, then it
2128: will be compiled for you. This may take some time depending on your
2129: computer, and how many other packages the software depends on and their
2130: compile time.
2131: </p>
1.75 rillig 2132: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2133: <h3 class="title">Note</h3>
2134: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2135: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2136: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2137: </div>
1.87 wiz 2138: <p>For example, type</p>
1.88 wiz 2139: <pre class="screen">
2140: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2141: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2142: </pre>
1.75 rillig 2143: <p>at the shell prompt to build the various components of the
1.88 wiz 2144: package.</p>
1.82 rillig 2145: <p>The next stage is to actually install the newly compiled
1.88 wiz 2146: program onto your system. Do this by entering:
1.82 rillig 2147:
1.88 wiz 2148: </p>
1.82 rillig 2149: <pre class="screen">
1.88 wiz 2150: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2151: </pre>
1.82 rillig 2152: <p>
2153:
1.88 wiz 2154: while you are still in the directory for whatever package you
2155: are installing.</p>
1.82 rillig 2156: <p>Installing the package on your system may require you to
1.88 wiz 2157: be root. However, pkgsrc has a
2158: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2159: to only become root for the actual installation step.</p>
1.82 rillig 2160: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2161: You can now enter:
1.82 rillig 2162:
1.88 wiz 2163: </p>
1.82 rillig 2164: <pre class="screen">
1.88 wiz 2165: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2166: </pre>
1.82 rillig 2167: <p>
2168:
1.88 wiz 2169: to remove the compiled files in the work directory, as you shouldn't need
2170: them any more. If other packages were also added to your system
2171: (dependencies) to allow your program to compile, you can tidy these up
2172: also with the command:</p>
1.82 rillig 2173: <pre class="screen">
1.88 wiz 2174: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2175: </pre>
1.75 rillig 2176: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2177: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2178: <p>The program is installed under the default root of the
2179: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2180: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2181: variable in your environment, and it will use that value as the
2182: root of your packages tree. So, to use
2183: <code class="filename">/usr/local</code>, set
2184: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2185: Please note that you should use a directory which is dedicated to
2186: packages and not shared with other programs (i.e., do not try and
2187: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2188: to add any of your own files or directories (such as
2189: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2190: <code class="filename">pkgsrc/</code>) below the
2191: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2192: conflicts between programs and other files installed by the
2193: package system and whatever else may have been installed
2194: there.</p>
1.104 rillig 2195: <p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2196: alter some configuration options at build time. Have a look at
2197: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2198: of what will be set there by default. Environment variables such
2199: as <code class="varname">LOCALBASE</code> can be set in
1.104 rillig 2200: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2201: set them each time you want to use pkgsrc.</p>
2202: <p>Occasionally, people want to “<span class="quote">look under the
2203: covers</span>” to see what is going on when a package is building
2204: or being installed. This may be for debugging purposes, or out of
2205: simple curiosity. A number of utility values have been added to
2206: help with this.</p>
1.75 rillig 2207: <div class="orderedlist"><ol type="1">
2208: <li>
1.88 wiz 2209: <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
2210: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2211: information will be displayed. For example,</p>
1.75 rillig 2212: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2213: <p>will show all the commands that are invoked, up to and
2214: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2215: </li>
2216: <li>
1.88 wiz 2217: <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>
2218: definition, then the <code class="varname">VARNAME</code> definition
2219: should be used, in conjunction with the show-var
2220: 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>
2221: variable <code class="varname">LOCALBASE</code>:</p>
2222: <pre class="screen">
2223: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2224: /usr/pkg
2225: <code class="prompt">%</code>
1.88 wiz 2226: </pre>
1.75 rillig 2227: </li>
2228: </ol></div>
2229: <p>If you want to install a binary package that you've either
1.88 wiz 2230: created yourself (see next section), that you put into
2231: pkgsrc/packages manually or that is located on a remote FTP
2232: server, you can use the "bin-install" target. This target will
2233: 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>,
2234: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2235: sites searched is kept in the variable
2236: <code class="varname">BINPKG_SITES</code>, which defaults to
2237: 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>
2238: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2239: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2240: details.</p>
2241: <p>A final word of warning: If you set up a system that has a
2242: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2243: set that before any packages are installed, as you cannot use
2244: several directories for the same purpose. Doing so will result in
2245: pkgsrc not being able to properly detect your installed packages,
2246: and fail miserably. Note also that precompiled binary packages are
2247: usually built with the default <code class="varname">LOCALBASE</code> of
2248: <code class="filename">/usr/pkg</code>, and that you should
2249: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2250: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2251: </div>
2252: </div>
2253: </div>
2254: <div class="chapter" lang="en">
2255: <div class="titlepage"><div><div><h2 class="title">
2256: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2257: <div class="toc">
2258: <p><b>Table of Contents</b></p>
2259: <dl>
2260: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2261: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.103 wiz 2262: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
2263: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2264: <dd><dl>
1.103 wiz 2265: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2266: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2267: <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.88 wiz 2268: </dl></dd>
1.103 wiz 2269: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2270: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2271: </dl>
2272: </div>
1.104 rillig 2273: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2274: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2275: that file depends on the installation. On NetBSD, when you use
2276: <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
2277: <code class="filename">/etc/</code>. In all other cases the default location is
2278: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2279: bootstrap program to install the binary packages.</p>
2280: <p>During the bootstrap, an example configuration file is created. To
2281: use that, you have to create the directory
2282: <code class="filename">${PREFIX}/etc</code> and copy the example file
2283: there.</p>
2284: <p>The format of the configuration file is that of the usual
2285: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2286: is done by setting variables in this file. Note that you can define all
2287: kinds of variables, and no special error checking (for example for
2288: spelling mistakes) takes place, so you have to try it out to see if it
2289: works.</p>
1.75 rillig 2290: <div class="sect1" lang="en">
2291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2292: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2293: <p>In this section, you can find some variables that apply to all
1.89 rillig 2294: pkgsrc packages. A complete list of the variables that can be
2295: configured by the user is available in
2296: <code class="filename">mk/defaults/mk.conf</code>, together with some
2297: comments that describe each variable's intent.</p>
1.75 rillig 2298: <div class="itemizedlist"><ul type="disc">
2299: <li><p><code class="varname">LOCALBASE</code>: Where
2300: packages will be installed. The default is
1.76 rillig 2301: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2302: with different <code class="varname">LOCALBASE</code>s!</p></li>
2303: <li><p><code class="varname">CROSSBASE</code>: Where
2304: “<span class="quote">cross</span>” category packages will be
2305: installed. The default is
1.76 rillig 2306: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2307: <li><p><code class="varname">X11BASE</code>: Where
2308: X11 is installed on the system. The default is
1.76 rillig 2309: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2310: <li><p><code class="varname">DISTDIR</code>: Where to store the
2311: downloaded copies of the original source distributions used
2312: for building pkgsrc packages. The default is
1.76 rillig 2313: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2314: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2315: database about installed packages is stored. The default is
2316: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2317: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2318: If set, override the packages'
2319: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2320: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2321: Backup location(s) for distribution files and patch files
2322: if not found locally or in
1.76 rillig 2323: <code class="filename">${MASTER_SITES}</code> or
2324: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2325: The defaults are
1.76 rillig 2326: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2327: and
1.76 rillig 2328: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2329: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2330: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2331: <em class="replaceable"><code>arch</code></em> are replaced with OS
2332: release (“<span class="quote">2.0</span>”, etc.) and architecture
2333: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2334: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2335: List of acceptable licenses. Whenever you try to build a package
2336: whose license is not in this list, you will get an error message
2337: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2338: </ul></div>
2339: </div>
2340: <div class="sect1" lang="en">
2341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2342: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2343: <p>XXX
2344: </p>
2345: <div class="itemizedlist"><ul type="disc">
2346: <li><p><code class="varname">PACKAGES</code>: The top level
2347: directory for the binary packages. The default is
1.76 rillig 2348: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2349: <li><p><code class="varname">WRKOBJDIR</code>:
2350: The top level directory where, if defined, the separate
2351: working directories will get created, and symbolically
1.76 rillig 2352: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2353: This is useful for building packages on several
1.76 rillig 2354: architectures, then <code class="filename">${PKGSRCDIR}</code>
2355: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2356: is local to every architecture. (It should be noted that
2357: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.105 ! weinem 2358: — it is an internal definition which refers to the
1.75 rillig 2359: root of the pkgsrc tree. It is possible to have many
2360: pkgsrc tree instances.)</p></li>
2361: <li><p><code class="varname">LOCALPATCHES</code>:
2362: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2363: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.93 rillig 2364: information.</p></li>
1.75 rillig 2365: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.104 rillig 2366: the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2367: BSD-style Makefile. If this is not set,
2368: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2369: <code class="filename">/dev/null</code> to avoid picking up
2370: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2371: <li><p><code class="varname">DEPENDS_TARGET</code>:
2372: By default, dependencies are only installed, and no binary
2373: package is created for them. You can set this variable to
2374: <code class="literal">package</code> to automatically create binary
2375: packages after installing dependencies.</p></li>
1.75 rillig 2376: </ul></div>
2377: </div>
2378: <div class="sect1" lang="en">
2379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2380: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installion process</h2></div></div></div>
2381: <p>A growing number of packages support installation into a
2382: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2383: to be built, before the actual filesystem is touched. DESTDIR
2384: support exists in two variations:</p>
2385: <div class="itemizedlist"><ul type="disc">
2386: <li><p>Basic DESTDIR support means that the package
2387: installation and packaging is still run as
2388: root.</p></li>
2389: <li><p>Full DESTDIR support can run the complete build,
2390: installation and packaging as normal user. Root privileges are
2391: only needed to add packages.</p></li>
2392: </ul></div>
2393: <p>To use the DESTDIR support, set either
2394: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2395: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2396: get the full support with fallback to basic
2397: 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
2398: newer). It might become the default DESTDIR support later.</p>
2399: <p>DESTDIR support changes the behaviour of various targets
2400: slightly. To install a package after building it, use
2401: <code class="literal">package-install</code>. <code class="literal">package</code> and
2402: <code class="literal">install</code> don't do that any
2403: longer. <code class="literal">package-install</code> can be used as
2404: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2405: will ask for the root password to install the package and fail,
2406: <code class="literal">package-install</code> will ask again.</p>
2407: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2408: clean</code></strong> needs to be run as root.</p>
2409: </div>
2410: <div class="sect1" lang="en">
2411: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2412: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78 rillig 2413: <div class="sect2" lang="en">
2414: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2415: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2416: <p>By default, pkgsrc will use GCC to build packages. This may be
2417: overridden by setting the following variables in /etc/mk.conf:</p>
2418: <div class="variablelist"><dl>
2419: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2420: <dd>
2421: <p>This is a list of values specifying the chain of
2422: compilers to invoke when building packages. Valid values
2423: are:</p>
2424: <div class="itemizedlist"><ul type="disc">
2425: <li><p><code class="varname">distcc</code>:
2426: distributed C/C++ (chainable)</p></li>
2427: <li><p><code class="varname">ccache</code>:
2428: compiler cache (chainable)</p></li>
2429: <li><p><code class="varname">gcc</code>:
2430: GNU C/C++ Compiler</p></li>
2431: <li><p><code class="varname">mipspro</code>:
2432: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2433: <li><p><code class="varname">mipspro</code>:
2434: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2435: <li><p><code class="varname">sunpro</code>:
2436: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2437: </ul></div>
2438: <p>The default is
2439: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2440: <code class="varname">ccache</code> and/or
2441: <code class="varname">distcc</code> with an appropriate
2442: <code class="varname">PKGSRC_COMPILER</code> setting,
2443: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2444: variable should always be terminated with a value for
2445: a real compiler. Note that only one real compiler
2446: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2447: is not allowed).</p>
1.89 rillig 2448: </dd>
2449: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2450: <dd><p>This specifies the minimum version of GCC to use
2451: when building packages. If the system GCC doesn't
2452: satisfy this requirement, then pkgsrc will build and
2453: install one of the GCC packages to use instead.</p></dd>
2454: </dl></div>
2455: </div>
2456: <div class="sect2" lang="en">
2457: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2458: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78 rillig 2459: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2460: please make sure to use the <code class="literal">+=</code> operator
2461: instead of the <code class="literal">=</code> operator:</p>
2462: <pre class="programlisting">
1.100 rillig 2463: CFLAGS+= -your -flags
1.78 rillig 2464: </pre>
2465: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2466: “<span class="quote">+</span>”) may lead to problems with packages that need
2467: to add their own flags. Also, you may want to take a look at
1.91 rillig 2468: 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
1.78 rillig 2469: you're interested in optimization for the current CPU.</p>
2470: </div>
1.88 wiz 2471: <div class="sect2" lang="en">
2472: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2473: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88 wiz 2474: <p>If you want to pass flags to the linker, both in the configure
2475: step and the build step, you can do this in two ways. Either set
2476: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2477: between the two is that <code class="varname">LIBS</code> will be appended to
2478: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2479: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2480: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2481: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2482: <code class="varname">CFLAGS</code>, if you do not wish to override these
2483: settings, use the <code class="literal">+=</code> operator:</p>
2484: <pre class="programlisting">
1.100 rillig 2485: LDFLAGS+= -your -linkerflags
1.88 wiz 2486: </pre>
2487: </div>
1.78 rillig 2488: </div>
2489: <div class="sect1" lang="en">
2490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2491: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2492: <p>XXX
2493: </p>
2494: <div class="itemizedlist"><ul type="disc">
2495: <li>
2496: <p><code class="varname">PKG_DEVELOPER</code>:
2497: Run some sanity checks that package developers want:
2498: </p>
2499: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2500: <li><p>make sure patches apply with zero
2501: fuzz</p></li>
2502: <li><p>run check-shlibs to see that all
2503: binaries will find their shared libs.</p></li>
1.75 rillig 2504: </ul></div>
2505: <p>
1.87 wiz 2506: </p>
1.75 rillig 2507: </li>
1.88 wiz 2508: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2509: of debugging output which is displayed whilst making and
2510: installing the package. The default value for this is 0,
2511: which will not display the commands as they are executed
2512: (normal, default, quiet operation); the value 1 will display
2513: all shell commands before their invocation, and the value 2
2514: will display both the shell commands before their invocation,
2515: and their actual execution progress with <span><strong class="command">set
2516: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2517: </ul></div>
2518: <p>
2519: </p>
2520: </div>
2521: <div class="sect1" lang="en">
2522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2523: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2524: <p>Some packages have build time options, usually to select
2525: between different dependencies, enable optional support for big
2526: dependencies or enable experimental features.</p>
1.75 rillig 2527: <p>To see which options, if any, a package supports, and which
1.88 wiz 2528: options are mutually exclusive, run <span><strong class="command">make
2529: show-options</strong></span>, for example:</p>
1.75 rillig 2530: <pre class="programlisting">
2531: The following options are supported by this package:
2532: ssl Enable SSL support.
2533: Exactly one of the following gecko options is required:
2534: firefox Use firefox as gecko rendering engine.
2535: mozilla Use mozilla as gecko rendering engine.
2536: At most one of the following database options may be selected:
2537: mysql Enable support for MySQL database.
2538: pgsql Enable support for PostgreSQL database.
1.1 grant 2539:
1.75 rillig 2540: These options are enabled by default: firefox
2541: These options are currently enabled: mozilla ssl
1.1 grant 2542: </pre>
1.75 rillig 2543: <p>The following variables can be defined in
1.104 rillig 2544: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2545: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2546: which can be used to select or disable options for all packages
2547: that support them, and
2548: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2549: which can be used to select or disable options specifically for
2550: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2551: these variables are selected, options preceded by “<span class="quote">-</span>”
2552: are disabled. A few examples:</p>
1.75 rillig 2553: <pre class="screen">
1.104 rillig 2554: <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.75 rillig 2555: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2556: PKG_OPTIONS.kdebase= debug -sasl
2557: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2558: <p>The following settings are consulted in the order given, and
2559: the last setting that selects or disables an option is
2560: used:</p>
1.75 rillig 2561: <div class="orderedlist"><ol type="1">
2562: <li><p>the default options as suggested by the package
1.88 wiz 2563: maintainer</p></li>
1.75 rillig 2564: <li><p>the options implied by the settings of legacy
1.88 wiz 2565: variables (see below)</p></li>
1.75 rillig 2566: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2567: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2568: </ol></div>
2569: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2570: selected is used, all others are automatically disabled. If an
2571: option of the group is explicitly disabled, the previously
2572: selected option, if any, is used. It is an error if no option
2573: from a required group of options is selected, and building the
2574: package will fail.</p>
2575: <p>Before the options framework was introduced, build options
2576: were selected by setting a variable (often named
2577: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.104 rillig 2578: <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2579: transition to the options framework for the user, these legacy
2580: variables are converted to the appropriate options setting
2581: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2582: automatically. A warning is issued to prompt the user to update
1.104 rillig 2583: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2584: directly. Support for the legacy variables will be removed
2585: eventually.</p>
1.75 rillig 2586: </div>
2587: </div>
2588: <div class="chapter" lang="en">
2589: <div class="titlepage"><div><div><h2 class="title">
2590: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2591: <div class="toc">
2592: <p><b>Table of Contents</b></p>
2593: <dl>
2594: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2595: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2596: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2597: <dd><dl>
2598: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2599: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2600: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2601: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2602: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2603: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2604: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2605: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2606: </dl></dd>
2607: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2608: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2609: </dl>
2610: </div>
2611: <div class="sect1" lang="en">
2612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2613: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2614: <p>Once you have built and installed a package, you can create
2615: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2616: 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
2617: the same package on a group of hosts and wasting CPU time. It also
2618: provides a simple means for others to install your package, should
2619: you distribute it.</p>
2620: <p>To create a binary package, change into the appropriate
2621: directory in pkgsrc, and run <span><strong class="command">make
2622: package</strong></span>:</p>
2623: <pre class="screen">
2624: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2625: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2626: </pre>
2627: <p>This will build and install your package (if not already done),
2628: and then build a binary package from what was installed. You can
2629: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2630: it. Binary packages are created by default in
2631: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2632: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2633: 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.90 rillig 2634: <p>See <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2635: such a binary package.</p>
1.75 rillig 2636: </div>
2637: <div class="sect1" lang="en">
2638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2639: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2640: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2641: </div>
2642: <div class="sect1" lang="en">
2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2644: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2645: <p>If you want to get a full set of precompiled binary
1.87 wiz 2646: packages, this section describes how to get them. Beware that
2647: the bulk build will remove all currently installed packages from
2648: your system!</p>
1.75 rillig 2649: <p>Having an FTP server configured either on the
1.87 wiz 2650: machine doing the bulk builds or on a nearby NFS server can help
2651: to make the packages available to other machines that can then
2652: save time by installing only the binary packages. See <a href="http://netbsd.gw.com/cgi-bin/man-cgi?ftpd+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftpd</span>(8)</span></a> for
2653: more information. If you use a remote NFS server's storage, be
2654: sure to not actually compile on NFS storage, as this slows
2655: things down a lot.</p>
1.75 rillig 2656: <div class="sect2" lang="en">
2657: <div class="titlepage"><div><div><h3 class="title">
2658: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2659: <div class="sect3" lang="en">
2660: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2661: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
2662: </h4></div></div></div>
1.76 rillig 2663: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2664: configuration file for bulk builds. You can configure how your
2665: copy of pkgsrc is kept up to date, how the distfiles are
2666: downloaded, how the packages are built and how the report is
2667: generated. You can find an annotated example file in
2668: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2669: it, copy <code class="filename">build.conf-example</code> to
2670: <code class="filename">build.conf</code> and edit it, following the
2671: comments in that file.</p>
1.75 rillig 2672: </div>
2673: <div class="sect3" lang="en">
2674: <div class="titlepage"><div><div><h4 class="title">
1.104 rillig 2675: <a name="binary.mk.conf"></a>6.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
2676: </h4></div></div></div>
2677: <p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2678: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2679: details of the default settings. You will want to ensure that
2680: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2681: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104 rillig 2682: completely bypasses the license check.</p>
1.87 wiz 2683: <pre class="programlisting">
1.100 rillig 2684: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2685: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2686: BSDSRCDIR= /usr/src
2687: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2688: OBJHOSTNAME?= yes # use work.`hostname`
2689: FAILOVER_FETCH= yes # insist on the correct checksum
2690: PKG_DEVELOPER?= yes
2691: _ACCEPTABLE= yes
2692: </pre>
1.75 rillig 2693: <p>Some options that are especially useful for bulk builds
2694: can be found at the top lines of the file
1.76 rillig 2695: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2696: options of these are briefly described here.</p>
2697: <div class="itemizedlist"><ul type="disc">
2698: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2699: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2700: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2701: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2702: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2703: to the directory where all log files are created. Otherwise the
2704: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2705: <li><p>Another important variable is
1.87 wiz 2706: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2707: should be always available while building other
2708: packages.</p></li>
1.75 rillig 2709: </ul></div>
2710: <p>Some other options are scattered in the pkgsrc
2711: infrastructure:</p>
2712: <div class="itemizedlist"><ul type="disc">
2713: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2714: should be set to <code class="literal">yes</code>. The purpose of the bulk
2715: builds is creating binary packages, no matter if they are
2716: vulnerable or not. When uploading the packages to a public
2717: server, the vulnerable packages will be put into a directory of
2718: their own. Leaving this variable unset would prevent the bulk
2719: build system from even trying to build them, so possible
2720: building errors would not show up.</p></li>
1.75 rillig 2721: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2722: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2723: “<span class="quote">yes</span>” to check that the installed set of files
2724: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2725: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2726: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2727: “<span class="quote">yes</span>” to check that the installed
2728: “<span class="quote">#!</span>”-scripts will find their
2729: interpreter.</p></li>
1.91 rillig 2730: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2731: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2732: package's self-test before installing it. Note that some
2733: packages make heavy use of “<span class="quote">good</span>” random
2734: numbers, so you need to assure that the machine on which you
2735: are doing the bulk builds is not completely idle. Otherwise
2736: some test programs will seem to hang, while they are just
2737: waiting for new random data to be
2738: available.</p></li>
1.75 rillig 2739: </ul></div>
2740: </div>
2741: <div class="sect3" lang="en">
2742: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2743: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
2744: </h4></div></div></div>
1.75 rillig 2745: <p>It is possible to configure the bulk build to perform
1.87 wiz 2746: certain site-specific tasks at the end of the pre-build
2747: stage. If the file
2748: <code class="filename">pre-build.local</code> exists in
2749: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2750: (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
2751: stage. An example use of
2752: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2753: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2754: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2755: <p>to prevent the system from trying to build a particular package
1.87 wiz 2756: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2757: </div>
2758: </div>
2759: <div class="sect2" lang="en">
2760: <div class="titlepage"><div><div><h3 class="title">
2761: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2762: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2763: deleted at the start of bulk builds, make sure your login
2764: shell is placed somewhere else. Either drop it into
2765: <code class="filename">/usr/local/bin</code> (and adjust your login
2766: shell in the passwd file), or (re-)install it via
2767: <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
2768: you can login after a reboot (remember that your current
2769: process won't die if the package is removed, you just can't
2770: start any new instances of the shell any more). Also, if you
2771: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2772: version of ssh for some reason, be sure to install ssh before
2773: starting it from <code class="filename">rc.local</code>:</p>
2774: <pre class="programlisting">
1.100 rillig 2775: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2776: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2777: /usr/pkg/etc/rc.d/sshd
2778: fi
2779: </pre>
1.75 rillig 2780: <p>Not doing so will result in you being not able to log in
1.87 wiz 2781: via ssh after the bulk build is finished or if the machine
2782: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2783: </div>
2784: <div class="sect2" lang="en">
2785: <div class="titlepage"><div><div><h3 class="title">
2786: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2787: <p>Make sure you don't need any of the packages still
1.87 wiz 2788: installed.</p>
1.75 rillig 2789: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2790: <h3 class="title">Warning</h3>
1.99 rillig 2791: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2792: configuration files and some more files from
2793: <code class="filename">/var</code>, <code class="filename">/home</code> and
2794: possibly other locations will be removed! So don't run a bulk
2795: build with privileges that might harm your
2796: system.</em></span></p>
1.75 rillig 2797: </div>
2798: <p>Be sure to remove all other things that might
1.87 wiz 2799: interfere with builds, like some libs installed in
2800: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2801: <pre class="screen">
2802: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2803: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2804: </pre>
1.75 rillig 2805: <p>If for some reason your last build didn't complete (power
1.87 wiz 2806: failure, system panic, ...), you can continue it by
2807: running:</p>
1.75 rillig 2808: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2809: <p>At the end of the bulk build, you will get a summary via mail,
2810: and find build logs in the directory specified by
2811: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2812: file.</p>
1.75 rillig 2813: </div>
2814: <div class="sect2" lang="en">
2815: <div class="titlepage"><div><div><h3 class="title">
2816: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2817: <p>The bulk builds consist of three steps:</p>
2818: <div class="variablelist"><dl>
2819: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2820: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2821: cleans out any broken distfiles, and removes all
2822: packages installed.</p></dd>
1.75 rillig 2823: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2824: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2825: an optimised order in which packages will be
2826: built. Packages that don't require other packages will
2827: be built first, and packages with many dependencies will
2828: be built later.</p></dd>
1.75 rillig 2829: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2830: <dd><p>Generates a report that's placed in the directory
2831: specified in the <code class="filename">build.conf</code> file
2832: named <code class="filename">broken.html</code>, a short version
2833: of that report will also be mailed to the build's
2834: admin.</p></dd>
1.75 rillig 2835: </dl></div>
1.87 wiz 2836: <p>During the build, a list of broken packages will be compiled
2837: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2838: <code class="filename">.../.broken.${MACHINE}</code> if
2839: <code class="varname">OBJMACHINE</code> is set), individual build logs
2840: of broken builds can be found in the package's
2841: directory. These files are used by the bulk-targets to mark
2842: broken builds to not waste time trying to rebuild them, and
2843: they can be used to debug these broken package builds
2844: later.</p>
1.75 rillig 2845: </div>
2846: <div class="sect2" lang="en">
2847: <div class="titlepage"><div><div><h3 class="title">
2848: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2849: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2850: NetBSD 2.0/i386:</p>
1.75 rillig 2851: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2852: <li><p>10 GB - distfiles (NFS ok)</p></li>
2853: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2854: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2855: </ul></div>
2856: <p>Note that all pkgs will be de-installed as soon as they are
2857: turned into a binary package, and that sources are removed,
2858: so there is no excessively huge demand to disk
2859: space. Afterwards, if the package is needed again, it will
2860: 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
2861: there are no cycles wasted by recompiling.</p>
1.75 rillig 2862: </div>
2863: <div class="sect2" lang="en">
2864: <div class="titlepage"><div><div><h3 class="title">
2865: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2866: <p>If you don't want all the packages nuked from a machine
2867: (rendering it useless for anything but pkg compiling), there
2868: is the possibility of doing the package bulk build inside a
2869: chroot environment.</p>
2870: <p>The first step is to set up a chroot sandbox,
2871: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2872: using null mounts, or manually.</p>
2873: <p>There is a shell script called
2874: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2875: up the sandbox environment using null mounts. It will also
2876: create a script called <code class="filename">sandbox</code> in the
2877: root of the sandbox environment, which will allow the null
2878: mounts to be activated using the <span><strong class="command">sandbox
2879: mount</strong></span> command and deactivated using the
2880: <span><strong class="command">sandbox umount</strong></span> command.</p>
2881: <p>To set up a sandbox environment by hand, after extracting all
2882: the sets from a NetBSD installation or doing a <span><strong class="command">make
2883: distribution DESTDIR=/usr/sandbox</strong></span> in
2884: <code class="filename">/usr/src/etc</code>, be sure the following items
2885: are present and properly configured:</p>
1.75 rillig 2886: <div class="procedure"><ol type="1">
2887: <li>
2888: <p>Kernel</p>
2889: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2890: </li>
2891: <li>
1.76 rillig 2892: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2893: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2894: </li>
2895: <li>
1.91 rillig 2896: <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>
1.75 rillig 2897: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2898: </li>
2899: <li>
2900: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2901: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2902: </li>
2903: <li>
1.91 rillig 2904: <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>
1.75 rillig 2905: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2906: </li>
2907: <li>
1.76 rillig 2908: <p><code class="filename">/usr/src</code> (system sources,
1.105 ! weinem 2909: 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.75 rillig 2910: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2911: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2912: </li>
2913: <li>
1.76 rillig 2914: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2915: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2916: </li>
2917: <li>
1.76 rillig 2918: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2919: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2920: </li>
2921: <li>
2922: <p>Checkout pkgsrc via cvs into
1.87 wiz 2923: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2924: <pre class="screen">
2925: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2926: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2927: </pre>
1.75 rillig 2928: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2929: you do development in, as this will likely cause problems!</p>
1.75 rillig 2930: </li>
2931: <li><p>Make
1.87 wiz 2932: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2933: <code class="filename">.../distfiles</code> point somewhere
2934: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.104 rillig 2935: <li><p>Edit <a href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a href="#binary.mk.conf" title="6.3.1.2. mk.conf">Section 6.3.1.2, “<code class="filename">mk.conf</code>”</a>.</p></li>
1.76 rillig 2936: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2937: </ol></div>
2938: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2939: the build with the following steps:</p>
2940: <pre class="screen">
2941: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2942: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2943: </pre>
2944: <p>This will just jump inside the sandbox and start building. At
2945: the end of the build, mail will be sent with the results of
2946: the build. Created binary pkgs will be in
2947: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2948: (wherever that points/mounts to/from).</p>
1.75 rillig 2949: </div>
2950: <div class="sect2" lang="en">
2951: <div class="titlepage"><div><div><h3 class="title">
2952: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2953: <p>In addition to building a complete set of all packages in
2954: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2955: may be used to build a subset of the packages contained in
2956: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.104 rillig 2957: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75 rillig 2958: <div class="itemizedlist"><ul type="disc">
2959: <li><p>SITE_SPECIFIC_PKGS</p></li>
2960: <li><p>HOST_SPECIFIC_PKGS</p></li>
2961: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2962: <li><p>USER_SPECIFIC_PKGS</p></li>
2963: </ul></div>
1.87 wiz 2964: <p>will define the set of packages which should be built.
2965: The bulk build code will also include any packages which are
2966: needed as dependencies for the explicitly listed packages.</p>
2967: <p>One use of this is to do a bulk build with
2968: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2969: periodically to have a complete set of the binary packages
2970: needed for your site available without the overhead of
2971: building extra packages that are not needed.</p>
1.75 rillig 2972: </div>
2973: <div class="sect2" lang="en">
2974: <div class="titlepage"><div><div><h3 class="title">
2975: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2976: <p>This section describes how pkgsrc developers can upload binary
2977: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2978: <p>If you would like to automatically create checksum files for the
2979: binary packages you intend to upload, remember to set
2980: <code class="varname">MKSUMS=yes</code> in your
2981: <code class="filename">mk/bulk/build.conf</code>.</p>
2982: <p>If you would like to PGP sign the checksum files (highly
2983: recommended!), remember to set
2984: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2985: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2986: your GPG password to sign the files before uploading everything.</p>
2987: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2988: set properly in your <code class="filename">mk/bulk/build.conf</code>
2989: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 2990: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
2991: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 2992: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2993: is different from your local login, write your login directly
2994: into the variable, e.g. my local account is "feyrer", but for my
2995: login "hubertf", I use:</p>
1.93 rillig 2996: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2997: <p>A separate <code class="filename">upload</code> directory is used
2998: here to allow "closing" the directory during upload. To do
2999: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 3000: <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>
1.87 wiz 3001: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3002: only appropriate for packages for the NetBSD operating
3003: system. Binary packages for other operating systems should go
3004: into <code class="filename">/pub/pkgsrc</code>.</p>
3005: <p>Before uploading the binary pkgs, ssh authentication needs
3006: to be set up. This example shows how to set up temporary keys
3007: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3008: (assuming that no keys should be present there usually):</p>
3009: <pre class="screen">
3010: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 3011: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3012: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 3013: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3014: </pre>
3015: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3016: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3017: file on ftp.NetBSD.org. You can remove the key after the
3018: upload is done!</p>
3019: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3020: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3021: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3022: <p>Now after all this works, you can exit the sandbox and start
3023: the upload:</p>
3024: <pre class="screen">
3025: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3026: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3027: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3028: </pre>
3029: <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
3030: <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
3031: upload. The upload script will take care of not uploading
3032: restricted packages and putting vulnerable packages into the
3033: <code class="filename">vulnerable</code> subdirectory.</p>
3034: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3035: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3036: Gdd:x! </pre>
3037: <p>Use whatever is needed to remove the key you've entered
3038: before! Last, move the uploaded packages out of the
3039: <code class="filename">upload</code> directory to have them accessible
3040: to everyone:</p>
3041: <pre class="screen">
1.93 rillig 3042: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3043: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3044: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3045: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3046: </pre>
1.75 rillig 3047: </div>
3048: </div>
3049: <div class="sect1" lang="en">
3050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3051: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3052: <p>After your pkgsrc bulk-build has completed, you may wish to
3053: create a CD-ROM set of the resulting binary packages to assist
3054: in installing packages on other machines. The
1.91 rillig 3055: <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
1.87 wiz 3056: a simple tool for creating the ISO 9660 images.
3057: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3058: way that keeps all the dependencies for a given package on the same
3059: CD as that package.</p>
1.75 rillig 3060: <div class="sect2" lang="en">
3061: <div class="titlepage"><div><div><h3 class="title">
3062: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3063: <p>Complete documentation for cdpack is found in the cdpack(1)
3064: man page. The following short example assumes that the binary
3065: packages are left in
3066: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3067: sufficient disk space exists in <code class="filename">/u2</code> to
3068: hold the ISO 9660 images.</p>
3069: <pre class="screen">
3070: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3071: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3072: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3073: </pre>
3074: <p>If you wish to include a common set of files
3075: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3076: etc.) on each CD in the collection, then you need to create a
3077: directory which contains these files. e.g.</p>
3078: <pre class="screen">
3079: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3080: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3081: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3082: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3083: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3084: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3085: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3086: </pre>
1.75 rillig 3087: <p>Now create the images:</p>
3088: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76 rillig 3089: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3090: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3091: in their root directories.</p>
1.75 rillig 3092: </div>
3093: </div>
3094: </div>
3095: <div class="chapter" lang="en">
3096: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3097: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3098: <div class="toc">
3099: <p><b>Table of Contents</b></p>
3100: <dl>
1.91 rillig 3101: <dt><span class="sect1"><a href="#files.localbase">7.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
1.90 rillig 3102: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3103: </dl>
3104: </div>
3105: <p>The files that are installed by pkgsrc are organized in a way that
3106: is similar to what you find in the <code class="filename">/usr</code> directory
3107: of the base system. But some details are different. This is because
3108: pkgsrc initially came from FreeBSD and had adopted its file system
3109: hierarchy. Later it was largely influenced by NetBSD. But no matter
3110: which operating system you are using pkgsrc with, you can expect the
3111: same layout for pkgsrc.</p>
1.91 rillig 3112: <p>There are mainly four root directories for pkgsrc, which are all
3113: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3114: When pkgsrc has been installed as root, the default locations
3115: are:</p>
3116: <pre class="programlisting">
1.100 rillig 3117: LOCALBASE= /usr/pkg
3118: PKG_SYSCONFBASE= /usr/pkg/etc
3119: VARBASE= /var
3120: PKG_DBDIR= /var/db/pkg
1.91 rillig 3121: </pre>
3122: <p>In unprivileged mode (when pkgsrc has been installed as any other
3123: user), the default locations are:</p>
3124: <pre class="programlisting">
1.100 rillig 3125: LOCALBASE= ${HOME}/pkg
3126: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3127: VARBASE= ${HOME}/pkg/var
3128: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3129: </pre>
3130: <p>What these four directories are for, and what they look like is
3131: explained below.</p>
1.90 rillig 3132: <div class="itemizedlist"><ul type="disc">
3133: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3134: <code class="filename">/usr</code> directory in the base system. It is the
3135: “<span class="quote">main</span>” directory where the files are installed and contains
3136: the well-known subdirectories like <code class="filename">bin</code>,
3137: <code class="filename">include</code>, <code class="filename">lib</code>,
3138: <code class="filename">share</code> and
3139: <code class="filename">sbin</code>.</p></li>
3140: <li><p><code class="varname">VARBASE</code> corresponds to
3141: <code class="filename">/var</code> in the base system. Some programs (especially
3142: games, network daemons) need write access to it during normal
3143: operation.</p></li>
3144: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3145: <code class="filename">/etc</code> in the base system. It contains configuration
1.104 rillig 3146: files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 3147: itself.</p></li>
3148: </ul></div>
3149: <div class="sect1" lang="en">
3150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3151: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
3152: </h2></div></div></div>
1.90 rillig 3153: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3154: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3155: <div class="variablelist"><dl>
3156: <dt><span class="term"><code class="filename">bin</code></span></dt>
3157: <dd><p>Contains executable programs that are intended to be
3158: directly used by the end user.</p></dd>
3159: <dt><span class="term"><code class="filename">emul</code></span></dt>
3160: <dd><p>Contains files for the emulation layers of various other
3161: operating systems, especially for
3162: NetBSD.</p></dd>
3163: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3164: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3165: <dd><p>Contains
3166: the configuration files.</p></dd>
3167: <dt><span class="term"><code class="filename">include</code></span></dt>
3168: <dd><p>Contains headers for the C and C++ programming
3169: languages.</p></dd>
3170: <dt><span class="term"><code class="filename">info</code></span></dt>
3171: <dd><p>Contains GNU info files of various
3172: packages.</p></dd>
3173: <dt><span class="term"><code class="filename">lib</code></span></dt>
3174: <dd><p>Contains shared and static
3175: libraries.</p></dd>
3176: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3177: <dd><p>Contains data files that don't change after
3178: installation. Other data files belong into
3179: <code class="filename">${VARBASE}</code>.</p></dd>
3180: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3181: <dd><p>Contains programs that are not intended to be used by
3182: end users, such as helper programs or network
3183: daemons.</p></dd>
3184: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3185: <dd><p>Contains programs that are intended to be executed as
3186: CGI scripts by a web server.</p></dd>
3187: <dt><span class="term"><code class="filename">man</code> (the usual value of
3188: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3189: <dd><p>Contains brief
3190: documentation in form of manual pages.</p></dd>
3191: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3192: <dd><p>Contains programs that are intended to be used only by
3193: the super-user.</p></dd>
3194: <dt><span class="term"><code class="filename">share</code></span></dt>
3195: <dd><p>Contains platform-independent data files that don't
3196: change after installation.</p></dd>
3197: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3198: <dd><p>Contains documentation files provided by the
3199: packages.</p></dd>
3200: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3201: <dd><p>Contains example files provided by the packages. Among
3202: others, the original configuration files are saved here and copied to
3203: <code class="filename">${PKG_SYSCONFDIR}</code> during
3204: installation.</p></dd>
3205: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3206: <dd><p>Contains the original files for rc.d
3207: scripts.</p></dd>
3208: <dt><span class="term"><code class="filename">var</code> (the usual location of
3209: <code class="filename">${VARBASE}</code>)</span></dt>
3210: <dd><p>Contains files
3211: that may be modified after
3212: installation.</p></dd>
3213: </dl></div>
3214: </div>
3215: <div class="sect1" lang="en">
3216: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3217: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
3218: </h2></div></div></div>
1.90 rillig 3219: <div class="variablelist"><dl>
3220: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3221: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3222: <dd><p>Contains
3223: information about the currently installed
3224: packages.</p></dd>
3225: <dt><span class="term"><code class="filename">games</code></span></dt>
3226: <dd><p>Contains highscore
3227: files.</p></dd>
3228: <dt><span class="term"><code class="filename">log</code></span></dt>
3229: <dd><p>Contains log files.</p></dd>
3230: <dt><span class="term"><code class="filename">run</code></span></dt>
3231: <dd><p>Contains informational files about daemons that are
3232: currently running.</p></dd>
3233: </dl></div>
3234: </div>
3235: </div>
3236: <div class="chapter" lang="en">
3237: <div class="titlepage"><div><div><h2 class="title">
3238: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3239: <div class="toc">
3240: <p><b>Table of Contents</b></p>
3241: <dl>
1.90 rillig 3242: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3243: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3244: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3245: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3246: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103 wiz 3247: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">8.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
3248: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
3249: <dt><span class="sect1"><a href="#passive-ftp">8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</a></span></dt>
3250: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
3251: <dt><span class="sect1"><a href="#tmac.andoc-missing">8.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3252: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.103 wiz 3253: <dt><span class="sect1"><a href="#bsd.own.mk-missing">8.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
3254: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
3255: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
3256: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
3257: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3258: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build. What shall I do?</a></span></dt>
3259: <dt><span class="sect1"><a href="#faq.rcs-conflicts">8.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 3260: </dl>
3261: </div>
3262: <p>This section contains hints, tips & tricks on special things in
3263: pkgsrc that we didn't find a better place for in the previous chapters, and
3264: it contains items for both pkgsrc users and developers.</p>
3265: <div class="sect1" lang="en">
3266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3267: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3268: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3269: <div class="itemizedlist"><ul type="disc">
1.103 wiz 3270: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3271: This is a general purpose list for most issues regarding
3272: pkgsrc, regardless of platform, e.g. soliciting user help
3273: for pkgsrc configuration, unexpected build failures, using
3274: particular packages, upgrading pkgsrc installations,
3275: questions regarding the pkgsrc release branches, etc. General announcements or
3276: proposals for changes that impact the pkgsrc user community,
3277: e.g. major infrastructure changes, new features, package
3278: removals, etc., may also be posted.</p></li>
1.103 wiz 3279: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3280: A list where the results of pkgsrc bulk builds are sent and
3281: discussed.</p></li>
1.103 wiz 3282: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3283: This list is for those who are interested in getting a
3284: commit message for every change committed to pkgsrc. It is
3285: also available in digest form, meaning one daily message
3286: containing all commit messages for changes to the package
3287: source tree in that 24 hour period.</p></li>
3288: </ul></div>
3289: <p>To subscribe, do:</p>
3290: <pre class="programlisting">
1.100 rillig 3291: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3292: </pre>
3293: <p>Archives for all these mailing lists are available from
3294: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3295: </div>
3296: <div class="sect1" lang="en">
3297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3298: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3299: <p>Pkgviews is tightly integrated with buildlink. You can find a
3300: pkgviews User's guide in
1.76 rillig 3301: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3302: </div>
3303: <div class="sect1" lang="en">
3304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3305: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3306: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3307: a number of useful utilities for both users and developers of pkgsrc. This
3308: section attempts only to make the reader aware of the utilities and when
3309: they might be useful, and not to duplicate the documentation that comes
3310: with each package.</p>
3311: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3312: <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>:
1.75 rillig 3313: Symlinks for use by buildlink.</p></li></ul></div>
3314: <p>OS tool augmentation (automatically installed when needed):</p>
3315: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3316: <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>:
1.75 rillig 3317: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3318: <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>:
1.75 rillig 3319: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3320: <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
1.87 wiz 3321: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3322: <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>:
1.75 rillig 3323: Up-to-date replacement for
1.76 rillig 3324: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3325: systems where pkg_install is not present.</p></li>
3326: </ul></div>
3327: <p>Utilities used by pkgsrc (not automatically installed):</p>
3328: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3329: <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>:
1.75 rillig 3330: Create a binary package from an
3331: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3332: save the old package.</p></li>
1.91 rillig 3333: <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>:
1.75 rillig 3334: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3335: from multiple locations. It currently supports the following
3336: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3337: <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
1.75 rillig 3338: packages someplace else (enabled by default).</p></li>
1.91 rillig 3339: <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
1.75 rillig 3340: best compiler flags to optimise code for your current CPU and
3341: compiler.</p></li>
3342: </ul></div>
3343: <p>Utilities for keeping track of installed packages, being up to date,
3344: etc:</p>
3345: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3346: <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
1.75 rillig 3347: packages whose installed versions do not match the latest pkgsrc
3348: entries.</p></li>
1.91 rillig 3349: <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
1.75 rillig 3350: dependency graphs of packages, to aid in choosing a strategy for
3351: updating.</p></li>
1.91 rillig 3352: <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
3353: 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>
3354: <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
1.75 rillig 3355: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3356: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3357: <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
1.75 rillig 3358: packages you have installed.</p></li>
3359: </ul></div>
3360: <p>Utilities for people maintaining or creating individual packages:</p>
3361: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3362: <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
1.75 rillig 3363: making and maintaining patches for a package (includes pkgdiff,
3364: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3365: <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>,
3366: <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
1.75 rillig 3367: converting to pkgsrc.</p></li>
1.91 rillig 3368: <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
1.75 rillig 3369: pkgsrc to a Solaris package.</p></li>
3370: </ul></div>
3371: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3372: utilities)</p>
3373: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3374: <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
1.75 rillig 3375: packages in a chrooted area.</p></li>
1.91 rillig 3376: <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
1.75 rillig 3377: kernel version for chrooted cross builds.</p></li>
3378: </ul></div>
3379: </div>
3380: <div class="sect1" lang="en">
3381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3382: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3383: <p>If you want to use pkgsrc as non-root user, you can set some
3384: variables to make pkgsrc work under these conditions. At the very least,
3385: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3386: will turn on unprivileged mode and set multiple related variables to allow
3387: installation of packages as non-root.</p>
3388: <p>In case the defaults are not enough, you may want to tune some other
3389: variables used. For example, if the automatic user/group detection leads
3390: to incorrect values (or not the ones you would like to use), you can change
3391: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3392: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3393: <p>As regards bootstrapping, please note that the
3394: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3395: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3396: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3397: installation targets. These directories can be overridden by the
1.75 rillig 3398: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3399: that allow finer tuning of the tree layout.</p>
3400: </div>
3401: <div class="sect1" lang="en">
3402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3403: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3404: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3405: enable this feature by adding the option
3406: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.104 rillig 3407: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3408: distfile is found, pkgsrc will try to resume it.</p>
3409: <p>You can also
3410: 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
3411: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3412: <code class="varname">FETCH_RESUME_ARGS</code> and
3413: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3414: values.</p>
3415: <p>For example, if you want to use
1.76 rillig 3416: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3417: like:</p>
3418: <pre class="programlisting">
1.100 rillig 3419: FETCH_CMD= wget
3420: FETCH_BEFORE_ARGS= --passive-ftp
3421: FETCH_RESUME_ARGS= -c
3422: FETCH_OUTPUT_ARGS= -O
1.1 grant 3423: </pre>
1.75 rillig 3424: </div>
3425: <div class="sect1" lang="en">
3426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3427: <a name="x.org-from-pkgsrc"></a>8.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
3428: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3429: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3430: you will have to add the following line into
1.104 rillig 3431: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3432: <pre class="programlisting">
1.103 wiz 3433: X11_TYPE=modular
1.1 grant 3434: </pre>
1.75 rillig 3435: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3436: <h3 class="title">Note</h3>
1.103 wiz 3437: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3438: </p>
1.75 rillig 3439: </div>
3440: </div>
3441: <div class="sect1" lang="en">
3442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3443: <a name="fetch-behind-firewall"></a>8.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3444: <p>If you are sitting behind a firewall which does not allow direct
3445: connections to Internet hosts (i.e. non-NAT), you may specify the
3446: relevant proxy hosts. This is done using an environment variable in the
3447: form of a URL, e.g. in Amdahl, the machine
3448: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3449: port 80 as the proxy port number. So the proxy environment variables
3450: are:</p>
3451: <pre class="programlisting">
1.100 rillig 3452: ftp_proxy=ftp://orpheus.amdahl.com:80/
3453: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3454: </pre>
1.75 rillig 3455: </div>
3456: <div class="sect1" lang="en">
3457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3458: <a name="passive-ftp"></a>8.8. How do I tell <span><strong class="command">make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3459: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3460: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3461: the first available command from the following list:</p>
3462: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3463: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3464: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3465: </ul></div>
3466: <p>On a default NetBSD installation, this will be
1.76 rillig 3467: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3468: connections first, and falls back to active connections if the server
3469: refuses to do passive. For the other tools, add the following to your
1.104 rillig 3470: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3471: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3472: <p>Having that option present will prevent
1.76 rillig 3473: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3474: transfers.</p>
3475: </div>
3476: <div class="sect1" lang="en">
3477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3478: <a name="fetching-all-distfiles"></a>8.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3479: <p>You would like to download all the distfiles in a single batch
3480: from work or university, where you can't run a <span><strong class="command">make
3481: 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>,
1.75 rillig 3482: but downloading the entire directory may not be appropriate.</p>
3483: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3484: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3485: resulting list to your machine at work/school and use it there. If you
3486: 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
3487: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3488: URL:</p>
3489: <p>At home:</p>
3490: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3491: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3492: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3493: <p>At work:</p>
3494: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3495: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3496: home.</p>
3497: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3498: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3499: machine architecture), you can do so by using the above-mentioned
3500: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3501: directly by running:</p>
1.75 rillig 3502: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3503: <p>If you even decide to ignore
3504: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3505: by running:</p>
3506: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3507: </div>
3508: <div class="sect1" lang="en">
3509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3510: <a name="tmac.andoc-missing"></a>8.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3511: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3512: <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>
1.75 rillig 3513: package, you get the error from make that it doesn't know how to make
1.76 rillig 3514: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3515: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3516: the NetBSD base distribution on your machine. It is recommended to do
3517: that to format man pages.</p>
1.91 rillig 3518: <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
1.75 rillig 3519: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.104 rillig 3520: environment or in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3521: </div>
3522: <div class="sect1" lang="en">
3523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3524: <a name="bsd.own.mk-missing"></a>8.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</h2></div></div></div>
1.87 wiz 3525: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3526: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3527: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3528: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3529: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3530: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3531: the one that corresponds to your release (determine via <span><strong class="command">uname
3532: -r</strong></span>).</p>
3533: </div>
3534: <div class="sect1" lang="en">
3535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3536: <a name="using-sudo-with-pkgsrc"></a>8.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3537: <p>When installing packages as non-root user and using the just-in-time
3538: <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
3539: password for each required package installed. To avoid this, the sudo
3540: package can be used, which does password caching over a limited time. To
3541: use it, install sudo (either as binary package or from
1.98 wiz 3542: <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.104 rillig 3543: following into your <a href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3544: <span class="emphasis"><em>after</em></span> the definition of the
3545: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3546: <pre class="programlisting">
1.100 rillig 3547: .if exists(${LOCALBASE}/bin/sudo)
3548: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3549: .endif
1.1 grant 3550: </pre>
1.75 rillig 3551: </div>
3552: <div class="sect1" lang="en">
3553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3554: <a name="faq.conf"></a>8.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3555: <p>As the system administrator, you can choose where configuration files
3556: are installed. The default settings make all these files go into
1.76 rillig 3557: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3558: be suboptimal depending on your expectations (e.g., a read-only,
3559: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3560: configuration of the provided packages).</p>
3561: <p>In order to change the defaults, you can modify the
3562: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.104 rillig 3563: <a href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3564: directory; some common examples include <code class="filename">/etc</code> or
3565: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3566: <p>Furthermore, you can change this value on a per-package basis by
3567: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3568: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3569: package you would like to modify, that is, the contents of
3570: <code class="varname">PKGBASE</code>.</p>
3571: <p>Note that after changing these settings, you must rebuild and
3572: reinstall any affected packages.</p>
3573: </div>
3574: <div class="sect1" lang="en">
3575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3576: <a name="audit-packages"></a>8.14. Automated security checks</h2></div></div></div>
1.75 rillig 3577: <p>Please be aware that there can often be bugs in third-party software,
3578: and some of these bugs can leave a machine vulnerable to exploitation by
3579: attackers. In an effort to lessen the exposure, the NetBSD packages team
3580: maintains a database of known-exploits to packages which have at one time
3581: been included in pkgsrc. The database can be downloaded automatically, and
3582: a security audit of all packages installed on a system can take place. To
1.91 rillig 3583: 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
1.75 rillig 3584: components:</p>
3585: <div class="orderedlist"><ol type="1">
3586: <li>
3587: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3588: download a list of the security vulnerabilities information. This list
3589: is kept up to date by the NetBSD security officer and the NetBSD
3590: packages team, and is distributed from the NetBSD ftp server:</p>
3591: <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>
3592: </li>
3593: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3594: current machine, checking each vulnerability which is known. If a
3595: vulnerable package is installed, it will be shown by output to stdout,
3596: including a description of the type of vulnerability, and a URL
3597: containing more information.</p></li>
3598: </ol></div>
1.91 rillig 3599: <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>
1.75 rillig 3600: package is strongly recommended! After
3601: “<span class="quote">audit-packages</span>” is installed, please read
3602: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3603: audit-packages</code></strong>.</p>
1.87 wiz 3604: <p>If this package is installed, pkgsrc builds will use it to
3605: 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
3606: check.</p>
1.75 rillig 3607: </div>
3608: <div class="sect1" lang="en">
3609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3610: <a name="ufaq-cflags"></a>8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3611: <p>When you add your own preferences to the
3612: <code class="varname">CFLAGS</code> variable in your
1.104 rillig 3613: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3614: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3615: 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
3616: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3617: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3618: package.</p>
3619: <p>Currently there is no solution to this problem. If you
3620: really need the package to use your <code class="varname">CFLAGS</code>
3621: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3622: directory and then inspect any <code class="filename">Makefile</code> and
3623: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3624: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3625: these lines. But be aware that some “<span class="quote">smart</span>”
3626: programmers write so bad code that it only works for the
3627: specific combination of <code class="varname">CFLAGS</code> they have
3628: chosen.</p>
3629: </div>
1.80 rillig 3630: <div class="sect1" lang="en">
3631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3632: <a name="ufaq-fail"></a>8.16. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3633: <div class="procedure"><ol type="1">
3634: <li><p>Make sure that your copy of pkgsrc is consistent. A
3635: case that occurs often is that people only update pkgsrc in
3636: parts, because of performance reasons. Since pkgsrc is one large
3637: system, not a collection of many small systems, there are
3638: sometimes changes that only work when the whole pkgsrc tree is
3639: updated.</p></li>
3640: <li><p>Make sure that you don't have any CVS conflicts.
3641: Search for “<span class="quote"><<<<<<</span>” or
3642: “<span class="quote">>>>>>></span>” in all your pkgsrc
3643: files.</p></li>
3644: <li><p>Make sure that you don't have old copies of the packages
3645: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3646: verify this.</p></li>
3647: <li><p>If the problem still exists, write a mail to the
3648: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3649: </ol></div>
3650: </div>
1.88 wiz 3651: <div class="sect1" lang="en">
3652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3653: <a name="faq.rcs-conflicts"></a>8.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</h2></div></div></div>
1.89 rillig 3654: <p>You have modified a file from pkgsrc, and someone else has
3655: modified that same file afterwards in the CVS repository. Both changes
3656: are in the same region of the file, so when you updated pkgsrc, the
3657: <code class="literal">cvs</code> command marked the conflicting changes in the
3658: file. Because of these markers, the file is no longer a valid
3659: <code class="filename">Makefile</code>.</p>
3660: <p>Have a look at that file, and if you don't need your local changes
3661: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3662: -dP</strong></span> in that directory to download the current version.</p>
3663: </div>
1.75 rillig 3664: </div>
3665: </div>
3666: <div class="part" lang="en">
3667: <div class="titlepage"><div><div><h1 class="title">
3668: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3669: <div class="partintro" lang="en">
3670: <div></div>
3671: <p>This part of the book deals with creating and
3672: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3673: guide on creating a new package. The remaining chapters are more
3674: like a reference manual for pkgsrc.</p>
1.75 rillig 3675: <div class="toc">
3676: <p><b>Table of Contents</b></p>
3677: <dl>
1.90 rillig 3678: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3679: <dd><dl>
3680: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3681: <dd><dl>
3682: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3683: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3684: </dl></dd>
3685: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3686: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3687: </dl></dd>
1.90 rillig 3688: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3689: <dd><dl>
1.90 rillig 3690: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3691: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3692: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3693: <dd><dl>
1.93 rillig 3694: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
3695: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
3696: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
3697: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
3698: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 3699: </dl></dd>
3700: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3701: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3702: <dd><dl>
3703: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3704: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3705: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3706: </dl></dd>
3707: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3708: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3709: </dl></dd>
3710: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3711: <dd><dl>
1.97 rillig 3712: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
3713: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
3714: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
3715: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
3716: <dd><dl>
3717: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
3718: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
3719: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
3720: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
3721: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.90 rillig 3722: </dl></dd>
3723: </dl></dd>
3724: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3725: <dd><dl>
3726: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3727: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3728: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
3729: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3730: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3731: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3732: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3733: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3734: </dl></dd>
3735: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3736: <dd><dl>
3737: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3738: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3739: <dd><dl>
3740: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3741: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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>
3742: </dl></dd>
3743: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3744: <dd><dl>
3745: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
3746: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3747: </dl></dd>
3748: </dl></dd>
3749: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3750: <dd><dl>
3751: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3752: <dd><dl>
3753: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3754: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3755: </dl></dd>
3756: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3757: <dd><dl>
3758: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3759: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3760: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3761: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3762: </dl></dd>
3763: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3764: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3765: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3766: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3767: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3768: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3769: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3770: </dl></dd>
3771: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3772: <dd><dl>
3773: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3774: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3775: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3776: </dl></dd>
3777: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3778: <dd><dl>
3779: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3780: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3781: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3782: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3783: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3784: <dd><dl>
3785: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3786: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3787: </dl></dd>
3788: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3789: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3790: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3791: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3792: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3793: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3794: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3795: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3796: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3797: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3798: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3799: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3800: </dl></dd>
3801: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3802: <dd><dl>
3803: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3804: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3805: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 3806: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 3807: </dl></dd>
3808: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3809: <dd><dl>
3810: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3811: <dd><dl>
3812: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3813: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3814: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3815: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3816: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3817: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3818: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3819: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3820: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3821: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3822: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3823: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3824: </dl></dd>
3825: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3826: <dd><dl>
3827: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3828: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3829: </dl></dd>
3830: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3831: <dd><dl>
3832: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3833: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3834: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3835: </dl></dd>
3836: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3837: <dd><dl>
3838: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3839: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3840: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3841: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3842: </dl></dd>
3843: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3844: <dd><dl>
3845: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3846: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3847: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3848: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3849: </dl></dd>
3850: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3851: <dd><dl>
3852: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3853: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 3854: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103 wiz 3855: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
3856: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3857: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
3858: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
3859: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
3860: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
3861: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
3862: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
3863: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
3864: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
3865: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
3866: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
3867: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
3868: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
3869: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87 wiz 3870: emulation</a></span></dt>
1.103 wiz 3871: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
3872: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3873: </dl></dd>
1.90 rillig 3874: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3875: </dl></dd>
1.90 rillig 3876: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3877: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3878: <dd><dl>
1.90 rillig 3879: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3880: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3881: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3882: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3883: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3884: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3885: </dl></dd>
3886: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3887: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3888: <dd><dl>
3889: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3890: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3891: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3892: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3893: </dl></dd>
1.75 rillig 3894: </dl>
3895: </div>
1.77 rillig 3896: </div>
3897: <div class="chapter" lang="en">
3898: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3899: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3900: <div class="toc">
3901: <p><b>Table of Contents</b></p>
3902: <dl>
3903: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3904: <dd><dl>
3905: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3906: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3907: </dl></dd>
3908: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3909: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">9.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3910: </dl>
3911: </div>
1.77 rillig 3912: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3913: most likely have a URL from where you can download the source
3914: code. Starting with this URL, creating a package involves only a
3915: few steps.</p>
1.77 rillig 3916: <div class="procedure"><ol type="1">
1.91 rillig 3917: <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>
1.77 rillig 3918: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3919: category in which you want to place your package. You can also create a
3920: directory of your own (maybe called <code class="filename">local</code>). In that
3921: category directory, create another directory for your package and change
3922: into it.</p></li>
3923: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
3924: you for a URL. Enter the URL of the distribution file (in most cases a
3925: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3926: of your package are created automatically. The distribution file is
3927: extracted automatically to fill in some details in the
3928: <code class="filename">Makefile</code> that would otherwise have to be done
3929: manually.</p></li>
3930: <li>
3931: <p>Examine the extracted files to determine the dependencies of
3932: your package. Ideally, this is mentioned in some
3933: <code class="filename">README</code> file, but things may differ. For each of
3934: these dependencies, look where it exists in pkgsrc, and if there is a
3935: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3936: line to your package <code class="filename">Makefile</code> which includes that
3937: file just before the last line. If the
3938: <code class="filename">buildlink3.mk</code> file does not exist, add a
3939: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3940: version of the dependency and where it can be found in pkgsrc. This line
3941: should be placed in the third paragraph. If the dependency is only
3942: needed for building the package, but not when using it, use
3943: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3944: Your package may then look like this:</p>
1.77 rillig 3945: <pre class="programlisting">
1.100 rillig 3946: [...]
1.77 rillig 3947:
1.100 rillig 3948: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3949: DEPENDS+= screen-[0-9]*:../../misc/screen
3950: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3951:
1.100 rillig 3952: [...]
1.77 rillig 3953:
1.100 rillig 3954: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3955: .include "../../devel/glib2/buildlink3.mk"
3956: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3957: </pre>
3958: </li>
1.91 rillig 3959: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
3960: to be done to make your package a “<span class="quote">good</span>” one. If you don't
3961: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
3962: --explain</strong></span> or <span><strong class="command">pkglint
3963: -e</strong></span>, which outputs additional
3964: explanations.</p></li>
3965: <li><p>In many cases the package is not yet ready to build. You can
3966: find instructions for the most common cases in the next section, <a href="#creating.common" title="9.1. Common types of packages">Section 9.1, “Common types of packages”</a>. After you have followed the instructions
3967: over there, you can hopefully continue here.</p></li>
3968: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
3969: directory from the extracted files. Besides these files, a lot of cache
3970: files and other system information has been saved in the working
3971: directory, which may become wrong after you edited the
3972: <code class="filename">Makefile</code>.</p></li>
3973: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
3974: the various things that can go wrong in this phase, consult <a href="#fixes" title="Chapter 18. Making your package work">Chapter 18, <i>Making your package work</i></a>.</p></li>
3975: <li><p>When the package builds fine, the next step is to install
3976: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
3977: everything works.</p></li>
3978: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3979: contains a list of the files that are installed by the package, is
3980: nearly empty. Run <span><strong class="command">bmake print-PLIST
3981: >PLIST</strong></span> to generate a probably correct list. Check
3982: the file using your preferred text editor to see if the list of
3983: files looks plausible.</p></li>
3984: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
3985: <code class="filename">PLIST</code> contains garbage or not.</p></li>
3986: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
3987: has been registered in the database of installed files, but with an
3988: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
3989: and <span><strong class="command">bmake install</strong></span> again. Now the package is
3990: registered with the list of files from
3991: <code class="filename">PLIST</code>.</p></li>
3992: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
3993: package from the set of installed files.</p></li>
1.77 rillig 3994: </ol></div>
1.91 rillig 3995: <div class="sect1" lang="en">
3996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3997: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
3998: <div class="sect2" lang="en">
3999: <div class="titlepage"><div><div><h3 class="title">
4000: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
4001: <p>Simple Perl modules are handled automatically by
4002: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4003: </div>
4004: <div class="sect2" lang="en">
4005: <div class="titlepage"><div><div><h3 class="title">
4006: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
4007: <p>KDE applications should always include
4008: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4009: settings that are typical of KDE packages.</p>
4010: </div>
4011: </div>
4012: <div class="sect1" lang="en">
4013: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4014: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
4015: <div class="sect2" lang="en">
4016: <div class="titlepage"><div><div><h3 class="title">
4017: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
4018: <div class="sect3" lang="en">
4019: <div class="titlepage"><div><div><h4 class="title">
4020: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
4021: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4022: that the “<span class="quote">nvu</span>” package has not yet been imported into
4023: pkgsrc. As the description says it has to do with the web, the obvious
4024: choice for the category is “<span class="quote">www</span>”.</p>
4025: <pre class="programlisting">
1.100 rillig 4026: <code class="prompt">$</code> mkdir www/nvu
4027: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4028: </pre>
4029: <p>The web site says that the sources are available as a tar file, so
4030: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4031: <pre class="programlisting">
1.100 rillig 4032: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4033: </pre>
4034: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4035: below the <code class="varname">DISTNAME</code> line, as the package name should
4036: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4037: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4038: <code class="varname">COMMENT</code> fields. Then the package
4039: <code class="filename">Makefile</code> looked like that:</p>
4040: <pre class="programlisting">
1.100 rillig 4041: # $NetBSD$
4042: #
1.91 rillig 4043:
1.100 rillig 4044: DISTNAME= nvu-1.0-sources
4045: PKGNAME= nvu-1.0
4046: CATEGORIES= www
4047: MASTER_SITES= http://cvs.nvu.com/download/
4048: EXTRACT_SUFX= .tar.bz2
4049:
4050: MAINTAINER= rillig@NetBSD.org
4051: HOMEPAGE= http://cvs.nvu.com/
4052: COMMENT= Web Authoring System
1.91 rillig 4053:
1.100 rillig 4054: # url2pkg-marker (please do not remove this line.)
4055: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4056: </pre>
4057: <p>Then, I quit the editor and watched pkgsrc downloading a large
4058: source archive:</p>
4059: <pre class="programlisting">
1.100 rillig 4060: url2pkg> Running "make makesum" ...
4061: => Required installed package digest>=20010302: digest-20060826 found
4062: => Fetching nvu-1.0-sources.tar.bz2
4063: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4064: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4065: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4066: url2pkg> Running "make extract" ...
4067: => Required installed package digest>=20010302: digest-20060826 found
4068: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4069: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4070: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4071: ===> Installing dependencies for nvu-1.0
4072: ===> Overriding tools for nvu-1.0
4073: ===> Extracting for nvu-1.0
4074: url2pkg> Adjusting the Makefile.
1.91 rillig 4075:
1.100 rillig 4076: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4077:
1.100 rillig 4078: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4079: </pre>
4080: </div>
4081: <div class="sect3" lang="en">
4082: <div class="titlepage"><div><div><h4 class="title">
4083: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4084: <p>Now that the package has been extracted, let's see what's inside
4085: it. The package has a <code class="filename">README.txt</code>, but that only
4086: says something about mozilla, so it's probably useless for seeing what
4087: dependencies this package has. But since there is a GNU configure script
4088: in the package, let's hope that it will complain about everything it
4089: needs.</p>
4090: <pre class="programlisting">
1.100 rillig 4091: <code class="prompt">$</code> bmake
4092: => Required installed package digest>=20010302: digest-20060826 found
4093: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4094: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4095: ===> Patching for nvu-1.0
4096: ===> Creating toolchain wrappers for nvu-1.0
4097: ===> Configuring for nvu-1.0
4098: [...]
4099: configure: error: Perl 5.004 or higher is required.
4100: [...]
4101: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4102: [...]
1.91 rillig 4103: </pre>
4104: <p>That worked quite well. So I opened the package Makefile in my
4105: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4106: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4107: package have changed now, and since a perl wrapper is automatically
4108: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4109: from scratch.</p>
4110: <pre class="programlisting">
1.100 rillig 4111: <code class="prompt">$</code> bmake clean
4112: ===> Cleaning for nvu-1.0
4113: <code class="prompt">$</code> bmake
4114: [...]
4115: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4116: GNU Make. You will not be able to build Mozilla without GNU Make.
4117: [...]
1.91 rillig 4118: </pre>
4119: <p>So I added “<span class="quote">gmake</span>” to the
4120: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4121: <pre class="programlisting">
1.100 rillig 4122: [...]
4123: checking for GTK - version >= 1.2.0... no
4124: *** Could not run GTK test program, checking why...
4125: [...]
1.91 rillig 4126: </pre>
4127: <p>Now to the other dependencies. The first question is: Where is the
4128: GTK package hidden in pkgsrc?</p>
4129: <pre class="programlisting">
1.100 rillig 4130: <code class="prompt">$</code> echo ../../*/gtk*
4131: [many packages ...]
4132: <code class="prompt">$</code> echo ../../*/gtk
4133: ../../x11/gtk
4134: <code class="prompt">$</code> echo ../../*/gtk2
4135: ../../x11/gtk2
4136: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4137: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4138: </pre>
4139: <p>The first try was definitely too broad. The second one had exactly
4140: one result, which is very good. But there is one pitfall with GNOME
4141: packages. Before GNOME 2 had been released, there were already many
4142: GNOME 1 packages in pkgsrc. To be able to continue to use these
4143: packages, the GNOME 2 packages were imported as separate packages, and
4144: their names usually have a “<span class="quote">2</span>” appended. So I checked
4145: whether this was the case here, and indeed it was.</p>
4146: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4147: file, adding the dependency is very easy. I just inserted an
4148: <code class="literal">.include</code> line before the last line of the package
4149: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4150: <pre class="programlisting">
1.100 rillig 4151: [...]
4152: .include "../../x11/gtk2/buildlink3.mk"
4153: .include "../../mk/bsd.pkg.mk
1.91 rillig 4154: </pre>
4155: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4156: was:</p>
4157: <pre class="programlisting">
1.100 rillig 4158: [...]
4159: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4160: checking for GTK - version >= 1.2.0... no
4161: *** Could not run GTK test program, checking why...
4162: *** The test program failed to compile or link. See the file config.log for the
4163: *** exact error that occured. This usually means GTK was incorrectly installed
4164: *** or that you have moved GTK since it was installed. In the latter case, you
4165: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4166: configure: error: Test for GTK failed.
4167: [...]
1.91 rillig 4168: </pre>
4169: <p>In this particular case, the assumption that “<span class="quote">every package
4170: prefers GNOME 2</span>” had been wrong. The first of the lines above
4171: told me that this package really wanted to have the GNOME 1 version of
4172: GTK. If the package had looked for GTK2, it would have looked for
4173: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4174: So I changed the <code class="literal">x11/gtk2</code> to
4175: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4176: and tried again.</p>
4177: <pre class="programlisting">
1.100 rillig 4178: [...]
4179: 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
4180: In file included from xpidl.c:42:
4181: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4182: In file included from xpidl.c:42:
4183: xpidl.h:132: error: parse error before "IDL_ns"
4184: [...]
1.91 rillig 4185: </pre>
4186: <p>The package still does not find all of its dependencies. Now the
4187: question is: Which package provides the
4188: <code class="filename">libIDL/IDL.h</code> header file?</p>
4189: <pre class="programlisting">
1.100 rillig 4190: <code class="prompt">$</code> echo ../../*/*idl*
4191: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4192: <code class="prompt">$</code> echo ../../*/*IDL*
4193: ../../net/libIDL
1.91 rillig 4194: </pre>
4195: <p>Let's take the one from the second try. So I included the
4196: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4197: again. But the error didn't change. After digging through some of the
4198: code, I concluded that the build process of the package was broken and
4199: couldn't have ever worked, but since the Mozilla source tree is quite
4200: large, I didn't want to fix it. So I added the following to the package
4201: <code class="filename">Makefile</code> and tried again:</p>
4202: <pre class="programlisting">
1.100 rillig 4203: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4204: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4205: </pre>
4206: <p>The latter line is needed because the package expects the library
4207: <code class="filename">libIDL.so</code>, but only
4208: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4209: wrapper to rewrite that on the fly.</p>
4210: <p>The next problem was related to a recent change of the FreeType
4211: 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>
4212: which patch files were relevant for this issue and copied them to the
4213: <code class="filename">patches</code> directory. Then I retried, fixed the
4214: patches so that they applied cleanly and retried again. This time,
4215: everything worked.</p>
4216: </div>
4217: <div class="sect3" lang="en">
4218: <div class="titlepage"><div><div><h4 class="title">
4219: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
4220: <pre class="programlisting">
1.100 rillig 4221: <code class="prompt">$</code> bmake CHECK_FILES=no install
4222: [...]
4223: <code class="prompt">$</code> bmake print-PLIST >PLIST
4224: <code class="prompt">$</code> bmake deinstall
4225: <code class="prompt">$</code> bmake install
1.91 rillig 4226: </pre>
4227: </div>
4228: </div>
4229: </div>
1.77 rillig 4230: </div>
1.75 rillig 4231: <div class="chapter" lang="en">
4232: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4233: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4234: <div class="toc">
4235: <p><b>Table of Contents</b></p>
4236: <dl>
1.90 rillig 4237: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4238: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4239: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4240: <dd><dl>
1.93 rillig 4241: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
4242: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
4243: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
4244: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
4245: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 4246: </dl></dd>
4247: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4248: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4249: <dd><dl>
4250: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4251: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4252: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4253: </dl></dd>
1.90 rillig 4254: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4255: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4256: </dl>
4257: </div>
1.87 wiz 4258: <p>Whenever you're preparing a package, there are a number of
4259: files involved which are described in the following
4260: sections.</p>
1.75 rillig 4261: <div class="sect1" lang="en">
4262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4263: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
4264: </h2></div></div></div>
1.75 rillig 4265: <p>Building, installation and creation of a binary package are all
1.87 wiz 4266: controlled by the package's <code class="filename">Makefile</code>.
4267: The <code class="filename">Makefile</code> describes various things about
4268: a package, for example from where to get it, how to configure,
4269: build, and install it.</p>
1.76 rillig 4270: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4271: sections that describe the package.</p>
1.75 rillig 4272: <p>In the first section there are the following variables, which
1.87 wiz 4273: should appear exactly in the order given here. The order and
4274: grouping of the variables is mostly historical and has no further
4275: meaning.</p>
1.75 rillig 4276: <div class="itemizedlist"><ul type="disc">
4277: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4278: distribution file to be downloaded from the package's
4279: website.</p></li>
1.75 rillig 4280: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4281: package, as used by pkgsrc. You only need to provide it if
4282: <code class="varname">DISTNAME</code> (which is the default) is not a good
4283: name for the package in pkgsrc. Usually it is the pkgsrc
4284: directory name together with the version number. It must match the
4285: regular expression
4286: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4287: starts with a letter or digit, and contains only letters, digits,
4288: dashes, underscores, dots and plus signs.</p></li>
4289: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4290: the package file to create if the <code class="varname">PKGNAME</code>
4291: isn't unique on a SVR4 system. The default is
4292: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4293: <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
1.87 wiz 4294: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4295: does not produce an unique package name on a SVR4 system.
4296: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4297: characters.</p></li>
1.75 rillig 4298: <li>
4299: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4300: which the package fits in. You can choose any of the top-level
4301: directories of pkgsrc for it.</p>
1.75 rillig 4302: <p>Currently the following values are available for
1.87 wiz 4303: <code class="varname">CATEGORIES</code>. If more than
4304: one is used, they need to be separated by spaces:</p>
1.75 rillig 4305: <pre class="programlisting">
1.100 rillig 4306: archivers cross geography meta-pkgs security
4307: audio databases graphics misc shells
4308: benchmarks devel ham multimedia sysutils
4309: biology editors inputmethod net textproc
4310: cad emulators lang news time
4311: chat finance mail parallel wm
4312: comms fonts math pkgtools www
4313: converters games mbone print x11
4314: </pre>
1.75 rillig 4315: </li>
1.81 rillig 4316: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4317: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4318: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4319: and <code class="varname">DISTFILES</code> are discussed in detail in
1.90 rillig 4320: <a href="#build.fetch" title="16.5. The fetch phase">Section 16.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4321: </ul></div>
4322: <p>The second section contains information about separately
1.87 wiz 4323: downloaded patches, if any.
4324: </p>
1.75 rillig 4325: <div class="itemizedlist"><ul type="disc">
4326: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4327: Name(s) of additional files that contain distribution patches.
4328: There is no default. pkgsrc will look for them at
4329: <code class="varname">PATCH_SITES</code>.
4330: They will automatically be uncompressed before patching if
4331: the names end with <code class="filename">.gz</code> or
4332: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4333: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4334: Primary location(s) for distribution patch files (see
4335: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4336: </ul></div>
4337: <p>The third section contains the following variables.
1.87 wiz 4338: </p>
1.75 rillig 4339: <div class="itemizedlist"><ul type="disc">
4340: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4341: of the person who feels responsible for this package, and who is
4342: most likely to look at problems or questions regarding this
4343: 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
4344: developers should contact the <code class="varname">MAINTAINER</code> before
4345: making major changes to the package. When packaging a new program,
4346: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4347: maintain the package for future updates, set it to
4348: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4349: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4350: find more information about the package.</p></li>
1.75 rillig 4351: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4352: description of the package (should not include the package
4353: name).</p></li>
1.75 rillig 4354: </ul></div>
4355: <p>Other variables that affect the build:
1.87 wiz 4356: </p>
1.75 rillig 4357: <div class="itemizedlist"><ul type="disc"><li>
4358: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4359: interesting distribution files of the package are found. The
4360: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4361: works for most packages.</p>
1.75 rillig 4362: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4363: (most GNU software does, for instance), but extracts itself in
4364: the current directory, you should set
4365: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4366: <p>If a package doesn't create a subdirectory with the
4367: name of <code class="varname">DISTNAME</code> but some different name,
4368: set <code class="varname">WRKSRC</code> to point to the proper name in
4369: <code class="filename">${WRKDIR}</code>, for example
4370: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4371: <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>
1.75 rillig 4372: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4373: taken from the <code class="varname">WRKDIR_BASENAME</code>
4374: variable. By default, its value is
4375: <code class="filename">work</code>. If you want to use the same
4376: pkgsrc tree for building different kinds of binary packages,
4377: you can change the variable according to your needs. Two
4378: other variables handle common cases of setting
4379: <code class="varname">WRKDIR_BASENAME</code> individually. If
4380: <code class="varname">OBJHOSTNAME</code> is defined in
1.104 rillig 4381: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4382: the host's name is attached to the directory name. If
4383: <code class="varname">OBJMACHINE</code> is defined, the platform name
4384: is attached, which might look like
4385: <code class="filename">work.i386</code> or
4386: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4387: </li></ul></div>
4388: <p>Please pay attention to the following gotchas:</p>
4389: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4390: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4391: installed in compressed form by the package. For packages using
4392: BSD-style makefiles which honor MANZ, there is
4393: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4394: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4395: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4396: below).</p></li>
1.103 wiz 4397: <li><p>If the package installs any info files, see <a href="#faq.info-files" title="18.6.7. Packages installing info files">Section 18.6.7, “Packages installing info files”</a>.</p></li>
1.75 rillig 4398: </ul></div>
4399: </div>
4400: <div class="sect1" lang="en">
4401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4402: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
4403: </h2></div></div></div>
1.76 rillig 4404: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4405: digest, or checksum, of each distfile needed for the package. This
4406: ensures that the distfiles retrieved from the Internet have not been
4407: corrupted during transfer or altered by a malign force to introduce
4408: a security hole. Due to recent rumor about weaknesses of digest
4409: algorithms, all distfiles are protected using both SHA1 and RMD160
4410: message digests, as well as the file size.</p>
1.76 rillig 4411: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4412: checksums for all the patches found in the
1.90 rillig 4413: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4414: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4415: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4416: command.</p>
1.75 rillig 4417: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4418: 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
1.87 wiz 4419: <code class="filename">distinfo</code> file and care should be taken when
4420: upgrading such a package to ensure distfile information is not
4421: lost.</p>
1.75 rillig 4422: </div>
4423: <div class="sect1" lang="en">
4424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4425: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93 rillig 4426: <p>Many packages still don't work out-of-the box on the various
4427: platforms that are supported by pkgsrc. Therefore, a number of custom
4428: patch files are needed to make the package work. These patch files are
4429: found in the <code class="filename">patches/</code> directory.</p>
4430: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4431: applied to the files in <code class="varname">WRKSRC</code> directory after
4432: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4433: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4434: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4435: <div class="sect2" lang="en">
4436: <div class="titlepage"><div><div><h3 class="title">
4437: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4438: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4439: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4440: problems. (To force patches to apply with fuzz you can set
4441: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4442: should contain only changes for a single file, and no file should be
1.93 rillig 4443: patched by more than one patch file. This helps to keep future
4444: modifications simple.</p>
4445: <p>Each patch file is structured as follows: In the first line,
4446: there is the RCS Id of the patch itself. The second line should be
4447: empty for aesthetic reasons. After that, there should be a comment for
4448: each change that the patch does. There are a number of standard
4449: cases:</p>
4450: <div class="itemizedlist"><ul type="disc">
4451: <li><p>Patches that replace the <code class="literal">==</code>
4452: 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
4453: should contain a reference to , to avoid
4454: redundant explanations.</p></li>
4455: <li><p>Patches for commonly known vulnerabilities should
4456: mention the vulnerability ID (CAN, CVE).</p></li>
4457: <li><p>Patches that change source code should mention the
4458: platform and other environment (for example, the compiler) that the
4459: patch is needed for.</p></li>
4460: </ul></div>
4461: <p>In all other cases, the patch should be commented so that any
4462: developer who knows the code of the application can make some use of
4463: the patch. Special care should be taken for the upstream developers,
4464: since we generally want that they accept our patches, so we have less
4465: work in the future.</p>
4466: </div>
4467: <div class="sect2" lang="en">
4468: <div class="titlepage"><div><div><h3 class="title">
4469: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
4470: <p>One important thing to mention is to pay attention that no RCS
4471: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4472: later checked into the NetBSD CVS tree. Use the
1.93 rillig 4473: <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
4474: problems.</p>
1.87 wiz 4475: <p>For even more automation, we recommend using
4476: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4477: whole set of patches. You just have to backup files before you
4478: edit them to <code class="filename">filename.orig</code>, e.g. with
4479: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4480: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4481: you upgrade a package this way, you can easily compare the new
4482: set of patches with the previously existing one with
4483: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4484: or update from the <code class="filename">work/.newpatches</code>
4485: directory to <code class="filename">patches/</code>.</p>
4486: <p>When you have finished a package, remember to generate
4487: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4488: makepatchsum</strong></span> command, see <a href="#components.distinfo" title="10.2. distinfo">Section 10.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4489: <p>When adding a patch that corrects a problem in the
4490: distfile (rather than e.g. enforcing pkgsrc's view of where
4491: man pages should go), send the patch as a bug report to the
4492: maintainer. This benefits non-pkgsrc users of the package,
4493: and usually makes it possible to remove the patch in future
4494: version.</p>
1.101 rillig 4495: <p>The file names of the patch files are usually of the form
4496: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4497: </div>
4498: <div class="sect2" lang="en">
4499: <div class="titlepage"><div><div><h3 class="title">
4500: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4501: <p>If you want to share patches between multiple packages
4502: in pkgsrc, e.g. because they use the same distfiles, set
4503: <code class="varname">PATCHDIR</code> to the path where the patch files
4504: can be found, e.g.:</p>
4505: <pre class="programlisting">
1.100 rillig 4506: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4507: </pre>
1.75 rillig 4508: <p>Patch files that are distributed by the author or other
1.87 wiz 4509: maintainers can be listed in
4510: <code class="varname">PATCHFILES</code>.</p>
4511: <p>If it is desired to store any patches that should not be
4512: committed into pkgsrc, they can be kept outside the pkgsrc
4513: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4514: directory tree there is expected to have the same
4515: “<span class="quote">category/package</span>” structure as pkgsrc, and
4516: patches are expected to be stored inside these dirs (also
4517: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4518: example, if you want to keep a private patch for
4519: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4520: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4521: files in the named directory are expected to be patch files,
4522: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4523: applied</em></span>.</p>
1.93 rillig 4524: </div>
1.85 jmmv 4525: <div class="sect2" lang="en">
4526: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4527: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4528: <p>When fixing a portability issue in the code do not use
4529: preprocessor magic to check for the current operating system nor
4530: platform. Doing so hurts portability to other platforms because
4531: the OS-specific details are not abstracted appropriately.</p>
4532: <p>The general rule to follow is: instead of checking for the
4533: operating system the application is being built on, check for the
4534: specific <span class="emphasis"><em>features</em></span> you need. For example,
4535: instead of assuming that kqueue is available under NetBSD and
4536: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.105 ! weinem 4537: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4538: yes, this generally involves patching the
4539: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4540: that prevents some OSes from adopting interfaces from other OSes
4541: (e.g. Linux implementing kqueue), something that the above checks
4542: cannot take into account.</p>
4543: <p>Of course, checking for features generally involves more
4544: work on the developer's side, but the resulting changes are
1.87 wiz 4545: cleaner and there are chances they will work on many other
1.85 jmmv 4546: platforms. Not to mention that there are higher chances of being
4547: later integrated into the mainstream sources. Remember:
4548: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4549: <p>Some typical examples:</p>
4550: <div class="table">
1.90 rillig 4551: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 rillig 4552: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4553: <colgroup>
4554: <col>
4555: <col>
4556: <col>
4557: </colgroup>
4558: <thead><tr>
4559: <th>Where</th>
4560: <th>Incorrect</th>
4561: <th>Correct</th>
4562: </tr></thead>
4563: <tbody>
4564: <tr>
4565: <td>configure script</td>
4566: <td>
1.100 rillig 4567: <pre class="programlisting">
4568: case ${target_os} in
4569: netbsd*) have_kvm=yes ;;
4570: *) have_kvm=no ;;
4571: esac
4572: </pre>
1.85 jmmv 4573: </td>
4574: <td>
1.100 rillig 4575: <pre class="programlisting">
4576: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4577: </pre>
1.85 jmmv 4578: </td>
4579: </tr>
4580: <tr>
4581: <td>C source file</td>
4582: <td>
1.100 rillig 4583: <pre class="programlisting">
4584: #if defined(__NetBSD__)
4585: # include <sys/event.h>
4586: #endif
4587: </pre>
1.85 jmmv 4588: </td>
4589: <td>
1.100 rillig 4590: <pre class="programlisting">
4591: #if defined(HAVE_SYS_EVENT_H)
4592: # include <sys/event.h>
4593: #endif
4594: </pre>
1.85 jmmv 4595: </td>
4596: </tr>
4597: <tr>
4598: <td>C source file</td>
4599: <td>
1.100 rillig 4600: <pre class="programlisting">
4601: int
4602: monitor_file(...)
4603: {
4604: #if defined(__NetBSD__)
4605: int fd = kqueue();
4606: ...
4607: #else
4608: ...
4609: #endif
4610: }
4611: </pre>
1.85 jmmv 4612: </td>
4613: <td>
1.100 rillig 4614: <pre class="programlisting">
4615: int
4616: monitor_file(...)
4617: {
4618: #if defined(HAVE_KQUEUE)
4619: int fd = kqueue();
4620: ...
4621: #else
4622: ...
4623: #endif
4624: }
4625: </pre>
1.85 jmmv 4626: </td>
4627: </tr>
4628: </tbody>
1.91 rillig 4629: </table></div>
1.85 jmmv 4630: </div>
1.91 rillig 4631: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4632: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4633: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4634: 2</a>). It summarizes multiple details on how to make
4635: software easier to package; all the suggestions in it were
4636: collected from our experience in pkgsrc work, so they are possibly
4637: helpful when creating patches too.</p>
4638: </div>
4639: <div class="sect2" lang="en">
4640: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4641: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4642: <p>Always, always, <span class="strong"><strong>always</strong></span>
4643: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4644: improvements you do to a package to the mainstream developers.
4645: This is the only way to get their attention on portability issues
4646: and to ensure that future versions can be built out-of-the box on
4647: NetBSD. Furthermore, any user that gets newer distfiles will get
4648: the fixes straight from the packaged code.</p>
1.93 rillig 4649: <p>This generally involves cleaning up the patches
4650: (because sometimes the patches that are
1.85 jmmv 4651: added to pkgsrc are quick hacks), filling bug reports in the
4652: appropriate trackers for the projects and working with the
4653: mainstream authors to accept your changes. It is
4654: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4655: the packages in pkgsrc are kept simple and thus further changes
4656: can be done without much hassle.</p>
4657: <p>Support the idea of free software!</p>
4658: </div>
1.75 rillig 4659: </div>
4660: <div class="sect1" lang="en">
4661: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4662: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4663: <div class="variablelist"><dl>
1.76 rillig 4664: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4665: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4666: any credits where they are due. Please bear in mind that others do not
4667: share your sense of humour (or spelling idiosyncrasies), and that others
4668: will read everything that you write here.</p></dd>
1.76 rillig 4669: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4670: <dd><p>This file governs the files that are installed on your
4671: system: all the binaries, manual pages, etc. There are other
4672: directives which may be entered in this file, to control the
4673: creation and deletion of directories, and the location of
1.90 rillig 4674: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4675: information.</p></dd>
1.75 rillig 4676: </dl></div>
4677: </div>
4678: <div class="sect1" lang="en">
4679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4680: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4681: <div class="sect2" lang="en">
4682: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4683: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4684: <div class="variablelist"><dl>
1.76 rillig 4685: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4686: <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>.
1.87 wiz 4687: First time after package extraction and before files are
4688: moved in place, the second time after the files to install
4689: are moved in place. This can be used to do any custom
4690: procedures not possible with @exec commands in
4691: <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.90 rillig 4692: <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="14.1. Files and directories outside the installation prefix">Section 14.1, “Files and directories outside the installation prefix”</a>.</p></dd>
1.76 rillig 4693: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4694: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4695: this script's responsibility to clean up any additional messy details
4696: around the package's installation, since all pkg_delete knows is how to
4697: delete the files created in the original distribution.
4698: 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>
4699: 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>
1.76 rillig 4700: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4701: <dd>
4702: <p>This file is displayed after installation of the package.
1.87 wiz 4703: Useful for things like legal notices on almost-free
4704: software and hints for updating config files after
4705: installing modules for apache, PHP etc.
4706: Please note that you can modify variables in it easily by using
4707: <code class="varname">MESSAGE_SUBST</code> in the package's
4708: <code class="filename">Makefile</code>:</p>
1.75 rillig 4709: <pre class="programlisting">
1.100 rillig 4710: MESSAGE_SUBST+= SOMEVAR="somevalue"
4711: </pre>
1.75 rillig 4712: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4713: <code class="filename">MESSAGE</code>. By default, substitution is
4714: performed for <code class="varname">PKGNAME</code>,
4715: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4716: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4717: <code class="varname">X11BASE</code>,
4718: <code class="varname">PKG_SYSCONFDIR</code>,
4719: <code class="varname">ROOT_GROUP</code>, and
4720: <code class="varname">ROOT_GROUP</code>.</p>
4721: <p>You can display a different or additional files by
4722: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4723: default is <code class="filename">MESSAGE</code>, if the file
4724: exists.</p>
1.75 rillig 4725: </dd>
1.78 rillig 4726: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4727: <dd><p>FIXME: There is no documentation on the
4728: alternatives framework.</p></dd>
4729: </dl></div>
4730: </div>
4731: <div class="sect2" lang="en">
4732: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4733: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4734: <div class="variablelist"><dl>
4735: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4736: <dd><p>This file contains arbitrary things that could
4737: also go into a <code class="filename">Makefile</code>, but its purpose is
4738: to be used by more than one package. This file should only be
4739: used when the packages that will use the file are known in
4740: advance. For other purposes it is often better to write a
4741: <code class="filename">*.mk</code> file and give it a good name that
4742: describes what it does.</p></dd>
4743: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4744: <dd><p>This file contains the dependency information
1.90 rillig 4745: for the buildlink3 framework (see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4746: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4747: <dd><p>This file contains workarounds for compiler bugs
4748: and similar things. It is included automatically by the pkgsrc
4749: infrastructure, so you don't need an extra
4750: <code class="literal">.include</code> line for
4751: it.</p></dd>
4752: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4753: <dd><p>This file contains the code for the
1.90 rillig 4754: package-specific options (see <a href="#options" title="Chapter 15. Options handling">Chapter 15, <i>Options handling</i></a>) that can be
1.78 rillig 4755: selected by the user. If a package has only one or two options,
4756: it is equally acceptable to put the code directly into the
4757: <code class="filename">Makefile</code>.</p></dd>
4758: </dl></div>
4759: </div>
4760: <div class="sect2" lang="en">
4761: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4762: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4763: <div class="variablelist"><dl>
4764: <dt><span class="term"><code class="filename">README*</code></span></dt>
4765: <dd><p>These files do not take place in the creation of
4766: a package and thus are purely informative to the package
4767: developer.</p></dd>
4768: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4769: <dd><p>This file contains things that need to be done
4770: to make the package even
4771: better.</p></dd>
1.75 rillig 4772: </dl></div>
4773: </div>
1.78 rillig 4774: </div>
1.75 rillig 4775: <div class="sect1" lang="en">
4776: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4777: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
4778: </h2></div></div></div>
1.75 rillig 4779: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4780: unpacked into the directory denoted by
4781: <code class="varname">WRKDIR</code>. It can be removed by running
4782: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4783: directory is also used to keep various timestamp files.
4784: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4785: The default is <code class="filename">${.CURDIR}/work</code>
4786: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4787: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4788: </div>
4789: <div class="sect1" lang="en">
4790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4791: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
4792: </h2></div></div></div>
1.75 rillig 4793: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4794: to configuration or building, you could place these files here and use
4795: a <span><strong class="command">${CP}</strong></span> command in the
4796: “<span class="quote">pre-configure</span>” target to achieve
4797: this. Alternatively, you could simply diff the file against
4798: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4799: the creation of this file.</p>
4800: <p>If you want to share files in this way with other
4801: packages, set the <code class="varname">FILESDIR</code> variable to point
4802: to the other package's <code class="filename">files</code> directory,
4803: e.g.:</p>
4804: <pre class="programlisting">
1.100 rillig 4805: FILESDIR=${.CURDIR}/../xemacs/files
4806: </pre>
1.75 rillig 4807: </div>
4808: </div>
4809: <div class="chapter" lang="en">
4810: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4811: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4812: <div class="toc">
4813: <p><b>Table of Contents</b></p>
4814: <dl>
1.97 rillig 4815: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
4816: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
4817: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
4818: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
4819: <dd><dl>
4820: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
4821: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
4822: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
4823: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
4824: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">11.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4825: </dl></dd>
4826: </dl>
4827: </div>
1.76 rillig 4828: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4829: each of which forms a well-defined part of the pkgsrc system. Using
4830: 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
4831: like pkgsrc requires some discipline to keep the code correct and
4832: understandable.</p>
1.76 rillig 4833: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4834: programming are variables (which are actually macros) and shell
4835: commands. Among these shell commands may even be more complex ones
4836: 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
4837: as intended it is necessary to quote all variables correctly when they
4838: are used.</p>
4839: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4840: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4841: with them.</p>
4842: <div class="sect1" lang="en">
4843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4844: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
4845: <div class="itemizedlist"><ul type="disc"><li>
4846: <p>When you are creating a file as a
4847: target of a rule, always write the data to a temporary file first
4848: and finally rename that file. Otherwise there might occur an error
4849: in the middle of generating the file, and when the user runs
4850: <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
4851: regenerated properly. Example:</p>
4852: <pre class="programlisting">
1.100 rillig 4853: wrong:
4854: @echo "line 1" > ${.TARGET}
4855: @echo "line 2" >> ${.TARGET}
4856: @false
4857:
4858: correct:
4859: @echo "line 1" > ${.TARGET}.tmp
4860: @echo "line 2" >> ${.TARGET}.tmp
4861: @false
4862: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4863: </pre>
4864: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4865: <code class="filename">wrong</code> will exist, although there was an error
4866: message in the first run. On the other hand, running <span><strong class="command">make
4867: correct</strong></span> gives an error message twice, as expected.</p>
4868: <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
4869: <code class="literal">${.TARGET}</code> in case of error, but this only
4870: happens when it is interrupted, for example by pressing
4871: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4872: 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>
4873: </li></ul></div>
4874: </div>
4875: <div class="sect1" lang="en">
4876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4877: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4878: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4879: can be processed using the five operators ``='', ``+='', ``?='',
4880: ``:='', 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
4881: page.</p>
4882: <p>When a variable's value is parsed from a
1.76 rillig 4883: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4884: backslash character ``\'' are handled specially. If a backslash is
4885: followed by a newline, any whitespace immediately in front of the
4886: backslash, the backslash, the newline, and any whitespace
4887: immediately behind the newline are replaced with a single space. A
4888: backslash character and an immediately following hash character are
4889: replaced with a single hash character. Otherwise, the backslash is
4890: passed as is. In a variable assignment, any hash character that is
4891: not preceded by a backslash starts a comment that continues upto the
4892: end of the logical line.</p>
4893: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4894: the only way to create a variable consisting of a single backslash
4895: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4896: <p>So far for defining variables. The other thing you can do with
4897: variables is evaluating them. A variable is evaluated when it is
4898: part of the right side of the ``:='' or the ``!='' operator, or
4899: directly before executing a shell command which the variable is part
4900: 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
4901: is, variables are not evaluated until there's no other way. The
4902: ``modifiers'' mentioned in the man page also evaluate the
4903: variable.</p>
4904: <p>Some of the modifiers split the string into words and then
4905: operate on the words, others operate on the string as a whole. When
4906: a string is split into words, it is split as you would expect
4907: 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.105 ! weinem 4908: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4909: loop does not follow the shell quoting rules but splits at sequences
4910: of whitespace.</p>
4911: <p>There are several types of variables that should be handled
4912: differently. Strings and two types of lists.</p>
4913: <div class="itemizedlist"><ul type="disc">
4914: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4915: characters. Nevertheless, you should restrict yourself to only
4916: using printable characters. Examples are
4917: <code class="varname">PREFIX</code> and
4918: <code class="varname">COMMENT</code>.</p></li>
4919: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4920: are never exported to any shell command. Their elements are
4921: separated by whitespace. Therefore, the elements themselves cannot
4922: have embedded whitespace. Any other characters are allowed.
4923: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4924: Examples are <code class="varname">DEPENDS</code> and
4925: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4926: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4927: may be exported to a shell command. Their elements can contain any
4928: characters, including whitespace. That's why they cannot be used
4929: in <span><strong class="command">.for</strong></span> loops. Examples are
4930: <code class="varname">DISTFILES</code> and
4931: <code class="varname">MASTER_SITES</code>.</p></li>
4932: </ul></div>
4933: <div class="sect2" lang="en">
4934: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4935: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4936: <div class="itemizedlist"><ul type="disc">
4937: <li><p>All variable names starting with an underscore
4938: are reserved for use by the pkgsrc infrastructure. They shall
4939: not be used by package
1.76 rillig 4940: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4941: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4942: lowercase variable names for the iteration
4943: variables.</p></li>
4944: <li><p>All list variables should have a ``plural''
4945: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4946: <code class="varname">DISTFILES</code>.</p></li>
4947: </ul></div>
4948: </div>
4949: </div>
4950: <div class="sect1" lang="en">
4951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4952: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75 rillig 4953: <p>This section presents you with some code snippets you should
4954: use in your own code. If you don't find anything appropriate here,
4955: you should test your code and add it here.</p>
4956: <div class="sect2" lang="en">
4957: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4958: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4959: <pre class="programlisting">
1.100 rillig 4960: STRING= foo * bar `date`
4961: INT_LIST= # empty
4962: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4963: EXT_LIST= # empty
4964: ANOTHER_EXT_LIST= a=b c=d
4965:
4966: INT_LIST+= ${STRING} # 1
4967: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4968: EXT_LIST+= ${STRING:Q} # 3
4969: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4970: </pre>
1.75 rillig 4971: <p>When you add a string to an external list (example 3), it
4972: must be quoted. In all other cases, you must not add a quoting
4973: level. You must not merge internal and external lists, unless you
4974: are sure that all entries are correctly interpreted in both
4975: lists.</p>
4976: </div>
4977: <div class="sect2" lang="en">
4978: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4979: <a name="converting-internal-to-external"></a>11.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4980: <pre class="programlisting">
1.100 rillig 4981: EXT_LIST= # empty
4982: .for i in ${INT_LIST}
4983: EXT_LIST+= ${i:Q}""
4984: .endfor
1.1 grant 4985: </pre>
1.75 rillig 4986: <p>This code converts the internal list
4987: <code class="varname">INT_LIST</code> into the external list
4988: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4989: are unquoted they must be quoted here. The reason for appending
4990: <code class="varname">""</code> is explained below.</p>
4991: </div>
4992: <div class="sect2" lang="en">
4993: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4994: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4995: <p>Sometimes you may want to print an arbitrary string. There
4996: are many ways to get it wrong and only few that can handle every
4997: nastiness.</p>
1.75 rillig 4998: <pre class="programlisting">
1.100 rillig 4999: STRING= foo bar < > * `date` $$HOME ' "
5000: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 5001:
1.100 rillig 5002: all:
5003: echo ${STRING} # 1
5004: echo "${STRING}" # 2
5005: echo "${STRING:Q}" # 3
5006: echo ${STRING:Q} # 4
5007: echo x${STRING:Q} | sed 1s,.,, # 5
5008: printf "%s\\n" ${STRING:Q}"" # 6
5009: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5010: </pre>
1.75 rillig 5011: <p>Example 1 leads to a syntax error in the shell, as the
5012: characters are just copied.</p>
5013: <p>Example 2 leads to a syntax error too, and if you leave out
5014: the last " character from <code class="varname">${STRING}</code>,
5015: <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
5016: variable would be evaluated, too.</p>
5017: <p>Example 3 outputs each space character preceded by a
5018: backslash (or not), depending on the implementation of the
5019: <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>
5020: <p>Example 4 handles correctly every string that does not start
5021: with a dash. In that case, the result depends on the
5022: 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
5023: guarantee that your input does not start with a dash, this form is
5024: appropriate.</p>
5025: <p>Example 5 handles even the case of a leading dash
5026: correctly.</p>
1.79 rillig 5027: <p>Example 6 also works with every string and is the
5028: light-weight solution, since it does not involve a pipe, which has
5029: its own problems.</p>
1.75 rillig 5030: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5031: because the quoting has already been done when adding elements to
5032: the list.</p>
5033: <p>As internal lists shall not be passed to the shell, there is
5034: no example for it.</p>
5035: </div>
5036: <div class="sect2" lang="en">
5037: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5038: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5039: <p>There are many possible sources of wrongly quoted variables.
5040: This section lists some of the commonly known ones.</p>
5041: <div class="itemizedlist"><ul type="disc">
5042: <li>
5043: <p>Whenever you use the value of a list, think
5044: about what happens to leading or trailing whitespace. If the
5045: list is a well-formed shell expression, you can apply the
5046: <code class="varname">:M*</code> modifier to strip leading and trailing
5047: whitespace from each word. The <code class="varname">:M</code> operator
5048: first splits its argument according to the rules of the shell,
5049: and then creates a new list consisting of all words that match
5050: the shell glob expression <code class="varname">*</code>, that is: all.
5051: One class of situations where this is needed is when adding a
5052: variable like <code class="varname">CPPFLAGS</code> to
5053: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5054: invokes other configure scripts, it strips the leading and
5055: trailing whitespace from the variable and then passes it to the
5056: other configure scripts. But these configure scripts expect the
5057: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5058: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5059: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5060: here is how we do it:</p>
5061: <pre class="programlisting">
1.100 rillig 5062: CPPFLAGS= # empty
5063: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5064: CPPFLAGS+= ${MY_CPPFLAGS}
5065:
5066: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5067:
5068: all:
5069: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5070: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5071: </pre>
1.75 rillig 5072: </li>
5073: <li><p>The example above contains one bug: The
5074: <code class="varname">${PREFIX}</code> is a properly quoted shell
5075: expression, but there is the C compiler after it, which also
5076: expects a properly quoted string (this time in C syntax). The
5077: version above is therefore only correct if
5078: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5079: or double quotes. If you want to allow these, you have to add
5080: another layer of quoting to each variable that is used as a C
5081: string literal. You cannot use the <code class="varname">:Q</code>
5082: operator for it, as this operator only works for the
5083: shell.</p></li>
5084: <li>
5085: <p>Whenever a variable can be empty, the
5086: <code class="varname">:Q</code> operator can have surprising results. Here
5087: are two completely different cases which can be solved with the
5088: same trick.</p>
5089: <pre class="programlisting">
1.100 rillig 5090: EMPTY= # empty
5091: empty_test:
5092: for i in a ${EMPTY:Q} c; do \
5093: echo "$$i"; \
5094: done
5095:
5096: for_test:
5097: .for i in a:\ a:\test.txt
5098: echo ${i:Q}
5099: echo "foo"
5100: .endfor
1.1 grant 5101: </pre>
1.75 rillig 5102: <p>The first example will only print two of the three lines
5103: we might have expected. This is because
5104: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5105: the shell cannot see. The workaround is to write
5106: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5107: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5108: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5109: <p>The second example will only print three lines instead of
5110: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5111: This is because the backslash of the value
5112: <code class="varname">a:\</code> is interpreted as a line-continuation by
5113: <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
5114: <a href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
5115: <code class="varname">${i:Q}""</code>.</p>
5116: </li>
5117: </ul></div>
5118: </div>
5119: <div class="sect2" lang="en">
5120: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5121: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5122: <p>The pkgsrc bmake program does not handle the following
5123: assignment correctly. In case <code class="varname">_othervar_</code>
5124: contains a ``-'' character, one of the closing braces is included
5125: in <code class="varname">${VAR}</code> after this code executes.</p>
5126: <pre class="programlisting">
1.100 rillig 5127: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5128: </pre>
1.75 rillig 5129: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5130: 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
1.75 rillig 5131: <code class="varname">bug1</code>.</p>
5132: </div>
5133: </div>
5134: </div>
5135: <div class="chapter" lang="en">
5136: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5137: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5138: <div class="toc">
5139: <p><b>Table of Contents</b></p>
5140: <dl>
1.90 rillig 5141: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5142: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5143: <dt><span class="sect1"><a href="#print-PLIST">12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span></a></span></dt>
5144: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5145: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5146: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5147: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5148: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5149: </dl>
5150: </div>
1.87 wiz 5151: <p>The <code class="filename">PLIST</code> file contains a package's
5152: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5153: the package (relative to the <code class="filename">${PREFIX}</code>
5154: directory it's been installed in) plus some additional statements
5155: - 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.
5156: This chapter addresses some issues that need attention when
5157: dealing with the <code class="filename">PLIST</code> file (or files, see
5158: below!).</p>
1.75 rillig 5159: <div class="sect1" lang="en">
5160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5161: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5162: <p>Be sure to add a RCS ID line as the first thing in any
5163: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5164: <pre class="programlisting">
1.100 rillig 5165: @comment $NetBSD$
1.87 wiz 5166: </pre>
1.75 rillig 5167: </div>
5168: <div class="sect1" lang="en">
5169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5170: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5171: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5172: to output a PLIST that matches any new files since the package
1.90 rillig 5173: was extracted. See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a> for
1.87 wiz 5174: more information on this target.</p>
1.75 rillig 5175: </div>
5176: <div class="sect1" lang="en">
5177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5178: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
5179: </h2></div></div></div>
1.87 wiz 5180: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5181: <a href="#faq.common-dirs" title="12.8. Sharing directories between packages">Section 12.8, “Sharing directories between packages”</a>, you may have noticed that
1.87 wiz 5182: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5183: <code class="varname">@comment</code>s instead of real
5184: <code class="varname">@dirrm</code> lines. You can also do this for
5185: specific directories and files, so that the results of that
5186: command are very close to reality. This helps <span class="emphasis"><em>a
5187: lot</em></span> during the update of packages.</p>
5188: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5189: of AWK patterns and actions that are used to filter the output of
5190: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5191: scripting you like to it, but be careful with quoting.</p>
5192: <p>For example, to get all files inside the
5193: <code class="filename">libdata/foo</code> directory removed from the
5194: resulting PLIST:</p>
5195: <pre class="programlisting">
1.100 rillig 5196: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5197: </pre>
5198: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5199: to a specific (shared) directory converted to
5200: <code class="varname">@comment</code>s:</p>
1.75 rillig 5201: <pre class="programlisting">
1.100 rillig 5202: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5203: </pre>
1.75 rillig 5204: </div>
5205: <div class="sect1" lang="en">
5206: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5207: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5208: <p>A number of variables are substituted automatically in
5209: PLISTs when a package is installed on a system. This includes the
5210: following variables:</p>
1.75 rillig 5211: <div class="variablelist"><dl>
5212: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5213: <dd>
5214: <p>Some packages like emacs and perl embed information
1.87 wiz 5215: about which architecture they were built on into the
5216: pathnames where they install their files. To handle this
5217: case, PLIST will be preprocessed before actually used, and
5218: the symbol
5219: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5220: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5221: same is done if the string
5222: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5223: PLIST somewhere - use this on packages that have GNU
5224: autoconf-created configure scripts.</p>
1.75 rillig 5225: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5226: <h3 class="title">Legacy note</h3>
5227: <p>There used to be a symbol
1.87 wiz 5228: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5229: was replaced by the output of <span><strong class="command">uname
5230: -m</strong></span>, but that's no longer supported and has
5231: been removed.</p>
1.75 rillig 5232: </div>
5233: </dd>
5234: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5235: <dd>
5236: <p>Some packages want to embed the OS name and version
1.87 wiz 5237: into some paths. To do this, use these variables in the
5238: <code class="filename">PLIST</code>:
5239: </p>
1.75 rillig 5240: <div class="itemizedlist"><ul type="disc">
5241: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5242: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5243: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5244: </ul></div>
5245: </dd>
5246: </dl></div>
1.87 wiz 5247: <p>For a complete list of values which are replaced by
5248: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5249: search for <code class="varname">PLIST_SUBST</code>).</p>
5250: <p>If you want to change other variables not listed above, you
5251: can add variables and their expansions to this variable in the
1.90 rillig 5252: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a href="#components.optional" title="10.5. Optional files">Section 10.5, “Optional files”</a>):</p>
1.75 rillig 5253: <pre class="programlisting">
1.100 rillig 5254: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5255: </pre>
1.75 rillig 5256: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5257: in the <code class="filename">PLIST</code> with
5258: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5259: </div>
5260: <div class="sect1" lang="en">
5261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5262: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5263: <p>Man pages should be installed in compressed form if
1.87 wiz 5264: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5265: and uncompressed otherwise. To handle this in the
5266: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5267: appended/removed automatically for man pages according to
5268: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5269: or not, see above for details. This modification of the
5270: <code class="filename">PLIST</code> file is done on a copy of it, not
5271: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5272: </div>
5273: <div class="sect1" lang="en">
5274: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5275: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5276: </h2></div></div></div>
1.76 rillig 5277: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5278: in generating the binary package, set the variable
5279: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5280: 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
5281: important. The default for <code class="varname">PLIST_SRC</code> is
5282: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5283: </div>
5284: <div class="sect1" lang="en">
5285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5286: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5287: <p>Some packages decide to install a different set of files based on
1.87 wiz 5288: the operating system being used. These differences can be
5289: automatically handled by using the following files:</p>
1.75 rillig 5290: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5291: <li><p><code class="filename">PLIST.common</code></p></li>
5292: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5293: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5294: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5295: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5296: </ul></div>
5297: </div>
5298: <div class="sect1" lang="en">
5299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5300: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5301: <p>A “<span class="quote">shared directory</span>” is a directory where
5302: multiple (and unrelated) packages install files. These
5303: directories are problematic because you have to add special tricks
5304: in the PLIST to conditionally remove them, or have some
5305: centralized package handle them.</p>
5306: <p>Within pkgsrc, you'll find both approaches. If a directory
5307: is shared by a few unrelated packages, it's often not worth to add
5308: an extra package to remove it. Therefore, one simply does:</p>
5309: <pre class="programlisting">
1.100 rillig 5310: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
1.87 wiz 5311: </pre>
5312: <p>in the PLISTs of all affected packages, instead of the
5313: regular "@dirrm" line.</p>
5314: <p>However, if the directory is shared across many packages, two
5315: different solutions are available:</p>
1.75 rillig 5316: <div class="orderedlist"><ol type="1">
1.87 wiz 5317: <li><p>If the packages have a common dependency, the directory
5318: can be removed in that. For example, see
1.91 rillig 5319: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87 wiz 5320: removes the shared directory
5321: <code class="filename">share/omf</code>.</p></li>
5322: <li><p>If the packages using the directory are not related at
5323: all (they have no common dependencies), a *-dirs package is
5324: used.</p></li>
1.75 rillig 5325: </ol></div>
1.87 wiz 5326: <p>From now on, we'll discuss the second solution. To get an
5327: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5328: <pre class="programlisting">
1.100 rillig 5329: <code class="prompt">%</code> cd .../pkgsrc
5330: <code class="prompt">%</code> ls -d */*-dirs
1.87 wiz 5331: </pre>
5332: <p>Their use from other packages is very simple. The
5333: <code class="varname">USE_DIRS</code> variable takes a list of package names
5334: (without the “<span class="quote">-dirs</span>” part) together with the required
5335: version number (always pick the latest one when writing new
5336: packages).</p>
5337: <p>For example, if a package installs files under
5338: <code class="filename">share/applications</code>, it should have the
5339: following line in it:</p>
5340: <pre class="programlisting">
1.100 rillig 5341: USE_DIRS+= xdg-1.1
1.87 wiz 5342: </pre>
5343: <p>After regenerating the PLIST using <span><strong class="command">make
5344: print-PLIST</strong></span>, you should get the right (commented out)
5345: lines.</p>
5346: <p>Note that even if your package is using
5347: <code class="filename">$X11BASE</code>, it must not depend on the
5348: *-x11-dirs packages. Just specify the name without that part and
5349: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5350: care of it.</p>
1.75 rillig 5351: </div>
5352: </div>
5353: <div class="chapter" lang="en">
5354: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5355: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5356: <div class="toc">
5357: <p><b>Table of Contents</b></p>
5358: <dl>
1.90 rillig 5359: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5360: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5361: <dd><dl>
1.90 rillig 5362: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5363: <dt><span class="sect2"><a href="#updating-buildlink-depends">13.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.75 rillig 5364: </dl></dd>
1.90 rillig 5365: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5366: <dd><dl>
1.90 rillig 5367: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
5368: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5369: </dl></dd>
5370: </dl>
5371: </div>
5372: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5373: are seen by a package's configure and build processes. This is implemented
5374: in a two step process:</p>
1.75 rillig 5375: <div class="orderedlist"><ol type="1">
5376: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5377: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5378: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5379: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5380: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5381: <code class="option">-L${LOCALBASE}/lib</code> into references to
5382: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5383: native compiler on some operating systems look like GCC, so that
5384: packages that expect GCC won't require modifications to build with
5385: those native compilers.</p></li>
1.75 rillig 5386: </ol></div>
5387: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5388: package may be built consistently despite what other software may be
5389: installed. Please note that the normal system header and library paths,
5390: e.g. <code class="filename">/usr/include</code>,
5391: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5392: designed to insulate the package build from non-system-supplied
5393: software.</p>
1.75 rillig 5394: <div class="sect1" lang="en">
5395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5396: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5397: <p>The process of converting packages to use the buildlink3
1.87 wiz 5398: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5399: The things to keep in mind are:</p>
1.75 rillig 5400: <div class="orderedlist"><ol type="1">
1.87 wiz 5401: <li><p>Ensure that the build always calls the wrapper scripts
5402: instead of the actual toolchain. Some packages are tricky,
5403: and the only way to know for sure is the check
5404: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5405: wrappers are being invoked.</p></li>
5406: <li><p>Don't override <code class="varname">PREFIX</code> from within
5407: the package Makefile, e.g. Java VMs, standalone shells,
5408: etc., because the code to symlink files into
5409: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5410: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5411: </p></li>
5412: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5413: <code class="filename">buildlink3.mk</code> files that you list in a
5414: package's Makefile are added as dependencies for that package.
5415: </p></li>
1.75 rillig 5416: </ol></div>
1.87 wiz 5417: <p>If a dependency on a particular package is required for its libraries and
5418: headers, then we replace:</p>
1.75 rillig 5419: <pre class="programlisting">
1.100 rillig 5420: DEPENDS+= foo>=1.1.0:../../category/foo
5421: </pre>
1.75 rillig 5422: <p>with</p>
5423: <pre class="programlisting">
1.100 rillig 5424: .include "../../category/foo/buildlink3.mk"
5425: </pre>
1.75 rillig 5426: <p>The buildlink3.mk files usually define the required dependencies.
5427: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5428: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5429: <pre class="programlisting">
1.100 rillig 5430: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5431: .include "../../category/foo/buildlink3.mk"
5432: </pre>
1.76 rillig 5433: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5434: files in <code class="filename">pkgsrc/mk</code>
5435: that handle special package issues:</p>
1.75 rillig 5436: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5437: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5438: the native or a pkgsrc Berkeley DB implementation based on
5439: the values of <code class="varname">BDB_ACCEPTED</code> and
5440: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5441: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5442: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5443: to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76 rillig 5444: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5445: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5446: adding a dependency on Heimdal or MIT-krb5 for packages that
5447: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5448: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5449: system-provided Motif installation or adds a dependency on
1.91 rillig 5450: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>. The user can set
1.88 wiz 5451: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5452: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5453: which Motif version will be used.</p></li>
1.76 rillig 5454: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5455: variables that may be used by packages that use the
5456: Open Sound System (OSS) API.</p></li>
1.76 rillig 5457: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5458: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5459: the file for more information.</p></li>
1.76 rillig 5460: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5461: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5462: a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76 rillig 5463: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5464: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5465: library.</p></li>
1.75 rillig 5466: </ul></div>
1.76 rillig 5467: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5468: files provide a more complete
5469: description of how to use them properly.</p>
1.75 rillig 5470: </div>
5471: <div class="sect1" lang="en">
5472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5473: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5474: <p>A package's <code class="filename">buildlink3.mk</code> file is
5475: included by Makefiles to indicate the need to compile and link
5476: against header files and libraries provided by the package. A
5477: <code class="filename">buildlink3.mk</code> file should always provide
5478: enough information to add the correct type of dependency
5479: relationship and include any other
5480: <code class="filename">buildlink3.mk</code> files that it needs to find
5481: headers and libraries that it needs in turn.</p>
5482: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5483: 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>
1.87 wiz 5484: package is highly recommended. For most packages, the following
5485: command will generate a good starting point for
5486: <code class="filename">buildlink3.mk</code> files:</p>
5487: <pre class="screen">
5488: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5489: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5490: </pre>
1.75 rillig 5491: <div class="sect2" lang="en">
5492: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5493: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5494: <p>The following real-life example
1.87 wiz 5495: <code class="filename">buildlink3.mk</code> is taken
5496: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5497: <pre class="programlisting">
1.100 rillig 5498: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5499:
1.100 rillig 5500: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5501: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5502:
1.100 rillig 5503: .if ${BUILDLINK_DEPTH} == "+"
5504: BUILDLINK_DEPENDS+= tiff
5505: .endif
1.87 wiz 5506:
1.100 rillig 5507: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5508: BUILDLINK_PACKAGES+= tiff
1.87 wiz 5509:
1.100 rillig 5510: .if ${TIFF_BUILDLINK3_MK} == "+"
5511: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5512: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5513: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5514:
1.100 rillig 5515: .include "../../devel/zlib/buildlink3.mk"
5516: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 5517:
1.100 rillig 5518: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5519: </pre>
1.87 wiz 5520: <p>The header and footer manipulate
5521: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5522: <code class="filename">buildlink3.mk</code> files and is used to track
5523: at what depth we are including
5524: <code class="filename">buildlink3.mk</code> files.</p>
5525: <p>The first section controls if the dependency on
5526: <em class="replaceable"><code>pkg</code></em> is added.
5527: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5528: packages for which dependencies are added by
5529: buildlink3.</p>
5530: <p>The second section advises pkgsrc that the
5531: <code class="filename">buildlink3.mk</code> file for
5532: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5533: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5534: packages for which <code class="filename">buildlink3.mk</code> files
5535: have been included. It must <span class="emphasis"><em>always</em></span> be
5536: appended to within a <code class="filename">buildlink3.mk</code>
5537: file.</p>
5538: <p>The third section is protected from multiple inclusion
5539: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5540: added. Several important variables are set in the section:</p>
5541: <div class="itemizedlist"><ul type="disc">
5542: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5543: is the actual dependency recorded in the installed
5544: package; this should always be set using
5545: <span><strong class="command">+=</strong></span> to ensure that
5546: we're appending to any pre-existing list of values. This
5547: variable should be set to the first version of the
5548: package that had an API change.
5549: </p></li>
5550: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5551: is the location of the <em class="replaceable"><code>pkg</code></em>
5552: pkgsrc directory.</p></li>
5553: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5554: (not shown above) controls whether we use
5555: <code class="varname">BUILD_DEPENDS</code> or
5556: <code class="varname">DEPENDS</code> to add the dependency on
5557: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5558: selected by setting
5559: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5560: to “<span class="quote">build</span>”. By default, the full dependency is
5561: used.</p></li>
5562: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5563: and
5564: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5565: (not shown above) are lists of subdirectories of
1.76 rillig 5566: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5567: to add to the header and library search paths. These
5568: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5569: respectively.</p></li>
5570: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5571: (not shown above) is the list of preprocessor flags to add
5572: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5573: configure and build phases. The “<span class="quote">-I</span>” option
5574: should be avoided and instead be handled using
5575: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5576: above.</p></li>
1.75 rillig 5577: </ul></div>
1.87 wiz 5578: <p>The following variables are all optionally defined within
5579: this second section (protected against multiple inclusion) and
5580: control which package files are symlinked into
5581: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5582: transformed during the symlinking:</p>
1.75 rillig 5583: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5584: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5585: (not shown above) is a shell glob pattern relative to
1.76 rillig 5586: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5587: to be symlinked into
1.76 rillig 5588: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5589: e.g. <code class="filename">include/*.h</code>.</p></li>
5590: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5591: (not shown above) is a shell pipeline that
5592: outputs to stdout a list of files relative to
5593: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5594: The resulting files are to be symlinked
5595: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5596: this takes the <code class="filename">+CONTENTS</code> of a
5597: <em class="replaceable"><code>pkg</code></em> and filters it through
5598: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5599: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5600: (not shown above) is a filter command that filters
1.76 rillig 5601: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5602: relative to
1.76 rillig 5603: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5604: on stdout. By default for overwrite packages,
5605: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5606: outputs the contents of the <code class="filename">include</code>
5607: and <code class="filename">lib</code> directories in the package
5608: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5609: it outputs any libtool archives in
1.87 wiz 5610: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5611: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5612: (not shown above) is a list of sed arguments used to
5613: transform the name of the source filename into a
5614: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5615: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5616: </ul></div>
1.87 wiz 5617: <p>The last section includes any
5618: <code class="filename">buildlink3.mk</code> needed for
5619: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5620: Including these <code class="filename">buildlink3.mk</code> files
5621: means that the headers and libraries for these
5622: dependencies are also symlinked into
5623: <code class="filename">${BUILDLINK_DIR}</code>
5624: whenever the <em class="replaceable"><code>pkg</code></em>
5625: <code class="filename">buildlink3.mk</code>
5626: file is included.</p>
1.75 rillig 5627: </div>
5628: <div class="sect2" lang="en">
5629: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5630: <a name="updating-buildlink-depends"></a>13.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.87 wiz 5631: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5632: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5633: after a package update is when the API or interface to the
1.87 wiz 5634: header files change.</p>
5635: <p>In this case,
5636: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5637: should be adjusted to require at least the new package
5638: version. In some cases, the packages that depend on this new
5639: version may need their <code class="varname">PKGREVISION</code>s
5640: increased and, if they have <code class="filename">buildlink3.mk</code>
5641: files, their
5642: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5643: adjusted, too. This is needed so pkgsrc will require the
5644: correct package dependency and not settle for an older one
5645: when building the source.</p>
5646: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5647: should be increased when the binary interface or sonames
5648: (major number of the library version) of any installed
5649: shared libraries change. This is needed so that binary
5650: packages made using it will require the correct package
5651: dependency and not settle for an older one which will not
1.87 wiz 5652: contain the necessary shared libraries.</p>
1.90 rillig 5653: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5654: more information about dependencies on other packages,
5655: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5656: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5657: <p>Please take careful consideration before adjusting
5658: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5659: or
5660: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5661: as we don't want to cause unneeded package deletions and
5662: rebuilds. In many cases, new versions of packages work just
5663: fine with older dependencies.</p>
5664: <p>Also it is not needed to set
1.75 rillig 5665: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5666: when it is identical to
1.87 wiz 5667: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5668: </div>
5669: </div>
5670: <div class="sect1" lang="en">
5671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5672: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5673: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5674: coincide with headers and libraries present in the base system.
1.76 rillig 5675: Aside from a <code class="filename">buildlink3.mk</code> file, these
5676: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5677: file that includes the necessary checks to decide whether using
5678: the built-in software or the pkgsrc software is
1.87 wiz 5679: appropriate.</p>
5680: <p>The only requirements of a builtin.mk file for
5681: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5682: <div class="orderedlist"><ol type="1">
1.87 wiz 5683: <li><p>It should set
5684: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5685: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5686: after it is included.</p></li>
5687: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5688: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5689: which is already set before the
5690: <code class="filename">builtin.mk</code> file is included.</p></li>
5691: <li><p>It should be written to allow multiple inclusion. This
5692: is <span class="emphasis"><em>very</em></span> important and takes careful
5693: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5694: </ol></div>
5695: <div class="sect2" lang="en">
5696: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5697: <a name="anatomy-of-builtin.mk"></a>13.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5698: <p>The following is the recommended template for builtin.mk
1.87 wiz 5699: files:</p>
1.75 rillig 5700: <pre class="programlisting">
1.100 rillig 5701: .if !defined(IS_BUILTIN.foo)
5702: #
5703: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5704: # genuinely exists in the system or not.
5705: #
5706: IS_BUILTIN.foo?= no
5707:
5708: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5709: # version can be determined.
5710: #
5711: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5712: BUILTIN_PKG.foo?= foo-1.0
5713: . endif
5714: .endif # IS_BUILTIN.foo
5715:
5716: .if !defined(USE_BUILTIN.foo)
5717: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5718: . if defined(BUILTIN_PKG.foo)
5719: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5720: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5721: USE_BUILTIN.foo!= \
5722: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5723: && ${ECHO} "yes" || ${ECHO} "no"
5724: . endif
5725: . endfor
5726: . endif
5727: .endif # USE_BUILTIN.foo
5728:
5729: CHECK_BUILTIN.foo?= no
5730: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5731: #
5732: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5733: # "yes" or "no".
5734: #
5735: .endif # CHECK_BUILTIN.foo
5736: </pre>
1.87 wiz 5737: <p>The first section sets
5738: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5739: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5740: in the base system. This should not be a base system software
5741: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5742: it should only be “<span class="quote">yes</span>” if the actual package is
5743: included as part of the base system. This variable is only
5744: used internally within the <code class="filename">builtin.mk</code>
5745: file.</p>
5746: <p>The second section sets
5747: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5748: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5749: system if it exists (if
5750: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5751: is “<span class="quote">yes</span>”). This variable is only used internally
5752: within the <code class="filename">builtin.mk</code> file.</p>
5753: <p>The third section sets
5754: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5755: and is <span class="emphasis"><em>required</em></span> in all
5756: <code class="filename">builtin.mk</code> files. The code in this
5757: section must make the determination whether the built-in
5758: software is adequate to satisfy the dependencies listed in
5759: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5760: This is typically done by comparing
5761: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5762: against each of the dependencies in
5763: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5764: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5765: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5766: end of the <code class="filename">builtin.mk</code> file. Note that
5767: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5768: may be “<span class="quote">yes</span>” even if
5769: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5770: is “<span class="quote">no</span>” because we may make the determination
5771: that the built-in version of the software is similar enough to
5772: be used as a replacement.</p>
5773: <p>The last section is guarded by
5774: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5775: and includes code that uses the value of
5776: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5777: set in the previous section. This typically includes, e.g.,
5778: adding additional dependency restrictions and listing additional
5779: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5780: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5781: </div>
5782: <div class="sect2" lang="en">
5783: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5784: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5785: <p>When building packages, it's possible to choose whether to set
5786: a global preference for using either the built-in (native)
5787: version or the pkgsrc version of software to satisfy a
5788: dependency. This is controlled by setting
5789: <code class="varname">PREFER_PKGSRC</code> and
5790: <code class="varname">PREFER_NATIVE</code>. These variables take values
5791: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5792: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5793: use the pkgsrc versions of software, while
5794: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5795: built-in versions. Preferences are determined by the most
5796: specific instance of the package in either
5797: <code class="varname">PREFER_PKGSRC</code> or
5798: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5799: in neither or in both variables, then
5800: <code class="varname">PREFER_PKGSRC</code> has precedence over
5801: <code class="varname">PREFER_NATIVE</code>. For example, to require
5802: using pkgsrc versions of software for all but the most basic
5803: bits on a NetBSD system, you can set:</p>
5804: <pre class="programlisting">
1.100 rillig 5805: PREFER_PKGSRC= yes
5806: PREFER_NATIVE= getopt skey tcp_wrappers
5807: </pre>
1.87 wiz 5808: <p>A package <span class="emphasis"><em>must</em></span> have a
5809: <code class="filename">builtin.mk</code>
5810: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5811: otherwise it is simply ignored in that list.</p>
1.75 rillig 5812: </div>
5813: </div>
5814: </div>
5815: <div class="chapter" lang="en">
5816: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5817: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5818: <div class="toc">
5819: <p><b>Table of Contents</b></p>
5820: <dl>
1.90 rillig 5821: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5822: <dd><dl>
1.90 rillig 5823: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5824: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5825: </dl></dd>
1.90 rillig 5826: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5827: <dd><dl>
1.90 rillig 5828: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5829: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5830: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5831: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5832: </dl></dd>
5833: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5834: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">14.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5835: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5836: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5837: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5838: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5839: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">14.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5840: </dl>
5841: </div>
5842: <p>This chapter describes the framework known as
5843: <code class="literal">pkginstall</code>, whose key features are:</p>
5844: <div class="itemizedlist"><ul type="disc">
5845: <li><p>Generic installation and manipulation of directories and files
5846: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5847: <li><p>Automatic handling of configuration files during installation,
5848: provided that packages are correctly designed.</p></li>
5849: <li><p>Generation and installation of system startup scripts.</p></li>
5850: <li><p>Registration of system users and groups.</p></li>
5851: <li><p>Registration of system shells.</p></li>
5852: <li><p>Automatic updating of fonts databases.</p></li>
5853: </ul></div>
5854: <p>The following sections inspect each of the above points in detail.</p>
5855: <p>You may be thinking that many of the things described here could be
5856: easily done with simple code in the package's post-installation target
5857: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5858: as the code in them is only executed when building from source. Machines
5859: using binary packages could not benefit from it at all (as the code itself
5860: could be unavailable). Therefore, the only way to achieve any of the items
5861: described above is by means of the installation scripts, which are
5862: automatically generated by pkginstall.</p>
5863: <div class="sect1" lang="en">
5864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5865: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5866: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5867: of files and directories that belong to a package. The names used in it
1.76 rillig 5868: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5869: which means that it cannot register files outside this directory (absolute
5870: path names are not allowed). Despite this restriction, some packages need
5871: to install files outside this location; e.g., under
1.76 rillig 5872: <code class="filename">${VARBASE}</code> or
1.87 wiz 5873: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5874: is to create such files during installation time by using
5875: installation scripts.</p>
5876: <p>The generic installation scripts are shell scripts that can
5877: contain arbitrary code. The list of scripts to execute is taken from
5878: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5879: <code class="filename">INSTALL</code>. A similar variable exists for package
5880: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5881: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5882: commands, so they have the potential to create and manage files
5883: anywhere in the file system.</p>
5884: <p>Using these general installation files is not recommended, but
5885: may be needed in some special cases. One reason for avoiding them is
5886: that the user has to trust the packager that there is no unwanted or
5887: simply erroneous code included in the installation script. Also,
5888: previously there were many similar scripts for the same functionality,
5889: and fixing a common error involved finding and changing all of
5890: them.</p>
5891: <p>The pkginstall framework offers another, standardized way. It
5892: provides generic scripts to abstract the manipulation of such files
5893: and directories based on variables set in the package's
5894: <code class="filename">Makefile</code>. The rest of this section describes
5895: these variables.</p>
1.75 rillig 5896: <div class="sect2" lang="en">
5897: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5898: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5899: <p>The following variables can be set to request the creation of
5900: directories anywhere in the file system:</p>
5901: <div class="itemizedlist"><ul type="disc">
5902: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5903: contain a list of directories that should be created and should attempt
5904: to be destroyed by the installation scripts. The difference between
5905: the two is that the latter prompts the administrator to remove any
5906: directories that may be left after deinstallation (because they were
5907: not empty), while the former does not.</p></li>
5908: <li>
5909: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5910: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5911: which directories should be created and should attempt to be destroyed
5912: by the installation scripts. Each tuple holds the following values,
5913: separated by spaces: the directory name, its owner, its group and its
5914: numerical mode. For example:</p>
5915: <pre class="programlisting">
1.100 rillig 5916: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5917: </pre>
1.75 rillig 5918: <p>The difference between the two is exactly the same as their
5919: non-<code class="varname">PERMS</code> counterparts.</p>
5920: </li>
5921: </ul></div>
5922: </div>
5923: <div class="sect2" lang="en">
5924: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5925: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5926: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5927: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5928: To overcome this problem, the only solution is to extract the file in the
5929: known place (i.e., inside the installation prefix) and copy it to the
5930: appropriate location during installation (done by the installation scripts
5931: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5932: file</em></span> in the following paragraphs, which describe the variables
5933: that can be used to automatically and consistently handle files outside the
5934: installation prefix:</p>
5935: <div class="itemizedlist"><ul type="disc">
5936: <li>
5937: <p><code class="varname">CONF_FILES</code> and
5938: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5939: During installation time, the master file is copied to the target one
5940: if and only if the latter does not exist. Upon deinstallation, the
5941: target file is removed provided that it was not modified by the
5942: installation.</p>
5943: <p>The difference between the two is that the latter prompts the
5944: administrator to remove any files that may be left after
5945: deinstallation (because they were not empty), while the former does
5946: not.</p>
5947: </li>
5948: <li>
5949: <p><code class="varname">CONF_FILES_PERMS</code> and
5950: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5951: files as well as their target locations. For each of them, it also
5952: specifies their owner, their group and their numeric permissions, in
5953: this order. For example:</p>
5954: <pre class="programlisting">
1.100 rillig 5955: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5956: </pre>
1.75 rillig 5957: <p>The difference between the two is exactly the same as their
5958: non-<code class="varname">PERMS</code> counterparts.</p>
5959: </li>
5960: </ul></div>
5961: </div>
5962: </div>
5963: <div class="sect1" lang="en">
5964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5965: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 5966: <p>Configuration files are special in the sense that they are installed
5967: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5968: need special treatment during installation (most of which is automated by
5969: pkginstall). The main concept you must bear in mind is that files marked
5970: as configuration files are automatically copied to the right place (somewhere
5971: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5972: and only if</em></span> they didn't exist before. Similarly, they will not
5973: be removed if they have local modifications. This ensures that
5974: administrators never lose any custom changes they may have made.</p>
5975: <div class="sect2" lang="en">
5976: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5977: <a name="conf-files-sysconfdir"></a>14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5978: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5979: specifies where configuration files shall be installed. Its contents are
5980: set based upon the following variables:</p>
5981: <div class="itemizedlist"><ul type="disc">
5982: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5983: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5984: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5985: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5986: Packages must not use it directly.</p></li>
5987: <li>
5988: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5989: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5990: for the package being built shall be installed. The definition of this
5991: variable only makes sense in the package's
1.76 rillig 5992: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5993: <p>As an example, consider the Apache package,
1.91 rillig 5994: <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
1.75 rillig 5995: configuration files under the
1.76 rillig 5996: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5997: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5998: Makefile.</p>
5999: </li>
6000: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6001: variable that holds this package's configuration directory (if
6002: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6003: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6004: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6005: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6006: directory where the configuration files for the package identified by
6007: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6008: </ul></div>
6009: <p>Based on the above variables, pkginstall determines the value of
6010: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6011: variable that can be used within a package to refer to its configuration
6012: directory. The algorithm used to set its value is basically the
6013: following:</p>
6014: <div class="orderedlist"><ol type="1">
6015: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6016: its value is used.</p></li>
6017: <li><p>If the previous variable is not defined but
6018: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 6019: <code class="filename">Makefile</code>, the resulting value is
6020: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 6021: <li><p>Otherwise, it is set to
1.76 rillig 6022: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6023: </ol></div>
1.76 rillig 6024: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 6025: automatically added to <code class="filename">OWN_DIRS</code>. See <a href="#dirs-outside-prefix" title="14.1.1. Directory manipulation">Section 14.1.1, “Directory manipulation”</a> what this means.</p>
1.75 rillig 6026: </div>
6027: <div class="sect2" lang="en">
6028: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6029: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6030: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6031: known place, you need to teach each package where it shall install its
6032: files. In some cases you will have to patch the package Makefiles to
6033: achieve it. If you are lucky, though, it may be as easy as passing an
6034: extra flag to the configuration script; this is the case of GNU Autoconf-
6035: generated files:</p>
6036: <pre class="programlisting">
1.100 rillig 6037: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6038: </pre>
1.75 rillig 6039: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6040: for</em></span> its configuration files, not where they will be originally
6041: installed (although the difference is never explicit,
6042: unfortunately).</p>
6043: </div>
6044: <div class="sect2" lang="en">
6045: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6046: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6047: <p>As said before, pkginstall automatically handles configuration files.
6048: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6049: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6050: directly</strong></span>. Bad news is that many software installation scripts
6051: will, out of the box, mess with the contents of that directory. So what is
6052: the correct procedure to fix this issue?</p>
6053: <p>You must teach the package (usually by manually patching it) to
6054: install any configuration files under the examples hierarchy,
1.76 rillig 6055: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6056: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6057: has the original copies available.</p>
6058: <p>Once the required configuration files are in place (i.e., under the
6059: examples hierarchy), the pkginstall framework can use them as master copies
6060: during the package installation to update what is in
1.76 rillig 6061: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6062: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 6063: used. Check out <a href="#files-outside-prefix" title="14.1.2. File manipulation">Section 14.1.2, “File manipulation”</a> for information
1.75 rillig 6064: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6065: <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>
1.75 rillig 6066: <pre class="programlisting">
1.100 rillig 6067: EGDIR= ${PREFIX}/share/doc/mutt/samples
6068: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6069: </pre>
1.75 rillig 6070: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6071: package and has no meaning outside it.</p>
6072: </div>
6073: <div class="sect2" lang="en">
6074: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6075: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6076: <p>The automatic copying of config files can be toggled by setting the
6077: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6078: installation.</p>
6079: </div>
6080: </div>
6081: <div class="sect1" lang="en">
6082: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6083: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6084: <p>System startup scripts are special files because they must be
6085: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6086: installation prefix. Therefore, the same rules described in <a href="#files-and-dirs-outside-prefix" title="14.1. Files and directories outside the installation prefix">Section 14.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 6087: can be used. However, pkginstall provides a special mechanism to handle
6088: these files.</p>
6089: <p>In order to provide system startup scripts, the package has
6090: to:</p>
6091: <div class="orderedlist"><ol type="1">
1.76 rillig 6092: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6093: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6094: <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
1.76 rillig 6095: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6096: <li>
6097: <p>Tell pkginstall to handle it, appending the name of the script,
6098: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6099: Continuing the previous example:</p>
6100: <pre class="programlisting">
1.100 rillig 6101: RCD_SCRIPTS+= cupsd
1.1 grant 6102: </pre>
1.75 rillig 6103: </li>
6104: </ol></div>
6105: <p>Once this is done, pkginstall will do the following steps for each
6106: script in an automated fashion:</p>
6107: <div class="orderedlist"><ol type="1">
6108: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6109: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6110: variable.</p></li>
6111: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6112: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6113: that this master file must be explicitly registered in the
1.76 rillig 6114: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6115: <li><p>Add code to the installation scripts to copy the startup script
6116: from the examples hierarchy into the system-wide startup scripts
6117: directory.</p></li>
6118: </ol></div>
6119: <div class="sect2" lang="en">
6120: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6121: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6122: <p>The automatic copying of config files can be toggled by setting the
6123: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6124: installation. Note that the scripts will be always copied inside the
1.76 rillig 6125: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6126: matter what the value of this variable is.</p>
6127: </div>
6128: </div>
6129: <div class="sect1" lang="en">
6130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6131: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6132: <p>If a package needs to create special users and/or groups during
6133: installation, it can do so by using the pkginstall framework.</p>
6134: <p>Users can be created by adding entries to the
6135: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6136: syntax:</p>
6137: <pre class="programlisting">
1.100 rillig 6138: user:group
1.1 grant 6139: </pre>
1.87 wiz 6140: <p>Further specification of user details may be done by setting
6141: per-user variables.
6142: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6143: numeric UID for the user.
6144: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6145: user's description or comment.
6146: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6147: user's home directory, and defaults to
6148: <code class="filename">/nonexistent</code> if not specified.
6149: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6150: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6151: not specified.</p>
1.75 rillig 6152: <p>Similarly, groups can be created by adding entries to the
6153: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6154: <pre class="programlisting">
1.100 rillig 6155: group
1.1 grant 6156: </pre>
1.93 rillig 6157: <p>The numeric GID of the group may be set by defining
1.75 rillig 6158: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6159: <p>If a package needs to create the users and groups at an earlier
6160: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6161: either <code class="literal">configure</code> or <code class="literal">build</code> to
6162: indicate the phase before which the users and groups are created. In
6163: this case, the numeric UIDs and GIDs of the created users and groups
6164: are automatically hardcoded into the final installation scripts.</p>
6165: </div>
6166: <div class="sect1" lang="en">
6167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6168: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6169: <p>Packages that install system shells should register them in the shell
1.76 rillig 6170: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6171: administrator. This must be done from the installation scripts to keep
6172: binary packages working on any system. pkginstall provides an easy way to
6173: accomplish this task.</p>
6174: <p>When a package provides a shell interpreter, it has to set the
6175: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6176: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6177: 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>
1.75 rillig 6178: <pre class="programlisting">
1.100 rillig 6179: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6180: </pre>
1.75 rillig 6181: <div class="sect2" lang="en">
6182: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6183: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6184: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6185: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6186: environment variable to <code class="literal">NO</code>.</p>
6187: </div>
6188: </div>
6189: <div class="sect1" lang="en">
6190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6191: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6192: <p>Packages that install X11 fonts should update the database files
6193: that index the fonts within each fonts directory. This can easily be
6194: accomplished within the pkginstall framework.</p>
6195: <p>When a package installs X11 fonts, it must list the directories in
6196: which fonts are installed in the
6197: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6198: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6199: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6200: installation scripts to run the appropriate commands to update the fonts
6201: database files within each of those directories. For convenience, if the
6202: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6203: 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>
1.75 rillig 6204: <pre class="programlisting">
1.100 rillig 6205: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6206: </pre>
1.75 rillig 6207: <div class="sect2" lang="en">
6208: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6209: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6210: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6211: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6212: environment variable to <code class="literal">NO</code>.</p>
6213: </div>
6214: </div>
6215: </div>
6216: <div class="chapter" lang="en">
6217: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6218: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6219: <div class="toc">
6220: <p><b>Table of Contents</b></p>
6221: <dl>
1.90 rillig 6222: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6223: <dt><span class="sect1"><a href="#converting-to-options">15.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
6224: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6225: </dl>
6226: </div>
6227: <p>Many packages have the ability to be built to support different
1.76 rillig 6228: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6229: in pkgsrc that provides generic handling of those options that
6230: determine different ways in which the packages can be built. It's
6231: possible for the user to specify exactly which sets of options will be
6232: built into a package or to allow a set of global default options
6233: apply.</p>
6234: <div class="sect1" lang="en">
6235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6236: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6237: <p>Global default options are listed in
6238: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6239: that should be built into every package if that option is supported.
1.104 rillig 6240: This variable should be set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6241: </div>
6242: <div class="sect1" lang="en">
6243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 6244: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6245: </h2></div></div></div>
1.75 rillig 6246: <p>The following example shows how
1.76 rillig 6247: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6248: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6249: <code class="filename">Makefile</code>, or in a file,
6250: e.g. <code class="filename">options.mk</code>, that is included by the
6251: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6252: <pre class="programlisting">
1.100 rillig 6253: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6254: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6255: PKG_OPTIONS_OPTIONAL_GROUPS= database
6256: PKG_OPTIONS_GROUP.database= mysql pgsql
6257: PKG_SUGGESTED_OPTIONS= wibble-foo
6258: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6259: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6260:
6261: .include "../../mk/bsd.prefs.mk"
6262:
6263: # this package was previously named wibble2
6264: .if defined(PKG_OPTIONS.wibble2)
6265: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6266: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6267: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6268: .endif
6269:
6270: .include "../../mk/bsd.options.mk"
6271:
6272: # Package-specific option-handling
6273:
6274: ###
6275: ### FOO support
6276: ###
6277: .if !empty(PKG_OPTIONS:Mwibble-foo)
6278: CONFIGURE_ARGS+= --enable-foo
6279: .endif
6280:
6281: ###
6282: ### LDAP support
6283: ###
6284: .if !empty(PKG_OPTIONS:Mldap)
6285: . include "../../databases/openldap-client/buildlink3.mk"
6286: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6287: .endif
6288:
6289: ###
6290: ### database support
6291: ###
6292: .if !empty(PKG_OPTIONS:Mmysql)
6293: . include "../../mk/mysql.buildlink3.mk"
6294: .endif
6295: .if !empty(PKG_OPTIONS:Mpgsql)
6296: . include "../../mk/pgsql.buildlink3.mk"
6297: .endif
1.75 rillig 6298: </pre>
6299: <p>The first section contains the information about which build
6300: options are supported by the package, and any default options settings
6301: if needed.</p>
6302: <div class="orderedlist"><ol type="1">
6303: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6304: <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
6305: options. It should be set to
1.78 rillig 6306: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6307: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6308: at the point where the options are processed.</p></li>
1.75 rillig 6309: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6310: build options supported by the package.</p></li>
6311: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6312: list of names of groups of mutually exclusive options. The options in
6313: each group are listed in
6314: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6315: The most specific setting of any option from the group takes
6316: precedence over all other options in the group. Options from the
6317: groups will be automatically added to
6318: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6319: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6320: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6321: packages will fail if no option from the group is
6322: selected.</p></li>
6323: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6324: of names of sets of options. At least one option from each set must
6325: be selected. The options in each set are listed in
6326: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6327: Options from the sets will be automatically added to
6328: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6329: fail if no option from the set is selected.</p></li>
6330: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6331: build options which are enabled by default.</p></li>
6332: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6333: of
6334: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.104 rillig 6335: pairs that map legacy <a href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6336: their option counterparts. Pairs should be added with
6337: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6338: warning will be issued if the user uses a legacy
6339: variable.</p></li>
6340: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6341: of
6342: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6343: pairs that map options that have been renamed to their new
6344: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6345: the listing of global legacy options. A warning will be issued if
6346: the user uses a legacy option.</p></li>
6347: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6348: options implied by deprecated variables used. This can be used for
6349: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6350: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6351: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6352: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6353: a list of warnings about deprecated variables or options used, and
6354: what to use instead.</p></li>
6355: </ol></div>
6356: <p>A package should never modify
6357: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6358: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6359: To suggest a default set of options, use
6360: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6361: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6362: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6363: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6364: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6365: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6366: happen with platform-specific options if none of them is supported on
6367: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6368: empty list and the package is otherwise treated as not using the
6369: options framework.</p>
1.76 rillig 6370: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6371: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6372: build options, properly filtered to remove unsupported and duplicate
6373: options.</p>
6374: <p>The remaining sections contain the logic that is specific to
6375: each option. The correct way to check for an option is to check
6376: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6377: <pre class="programlisting">
1.100 rillig 6378: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6379: </pre>
6380: </div>
6381: <div class="sect1" lang="en">
6382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6383: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6384: <p>Options that enable similar features in different packages (like
6385: optional support for a library) should use a common name in all
6386: packages that support it (like the name of the library). If another
6387: package already has an option with the same meaning, use the same
6388: name.</p>
6389: <p>Options that enable features specific to one package, where it's
6390: unlikely that another (unrelated) package has the same (or a similar)
6391: optional feature, should use a name prefixed with
6392: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6393: <p>If a group of related packages share an optional feature
6394: specific to that group, prefix it with the name of the
6395: “<span class="quote">main</span>” package
6396: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6397: <p>For new options, add a line to
1.76 rillig 6398: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6399: fields, separated by tab. The first field is the option name, the
6400: second its description. The description should be a whole sentence
6401: (starting with an uppercase letter and ending with a period) that
6402: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6403: support.</span>” The file is sorted by option names.</p>
6404: </div>
6405: </div>
6406: <div class="chapter" lang="en">
6407: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6408: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6409: <div class="toc">
6410: <p><b>Table of Contents</b></p>
6411: <dl>
1.90 rillig 6412: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6413: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6414: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6415: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6416: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6417: <dd><dl>
6418: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6419: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6420: </dl></dd>
6421: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6422: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6423: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6424: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6425: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6426: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6427: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6428: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6429: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6430: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6431: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6432: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6433: </dl>
6434: </div>
6435: <div class="sect1" lang="en">
6436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6437: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6438: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6439: built. Building a package is separated into different
6440: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6441: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6442: described in the following sections. Each phase is splitted into
6443: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6444: containing phase, prefixed by one of <code class="varname">pre-</code>,
6445: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6446: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6447: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6448: <p>Never override the regular targets (like
6449: <code class="varname">fetch</code>), if you have to, override the
6450: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6451: <p>The basic steps for building a program are always the same. First
1.87 wiz 6452: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6453: the local system and then extracted. After any pkgsrc-specific patches
6454: to compile properly are applied, the software can be configured, then
6455: built (usually by compiling), and finally the generated binaries, etc.
6456: can be put into place on the system.</p>
1.97 rillig 6457: <p>To get more details about what is happening at each step,
6458: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6459: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6460: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6461: </div>
6462: <div class="sect1" lang="en">
6463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6464: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6465: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6466: the next section, here's a brief discussion on where programs are
6467: installed, and which variables influence this.</p>
1.75 rillig 6468: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6469: where all files of the final program shall be installed. It is
6470: usually set to <code class="varname">LOCALBASE</code>
6471: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6472: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6473: <code class="varname">PREFIX</code> needs to be put
6474: into the various places in the program's source where paths to
1.90 rillig 6475: these files are encoded. See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> and <a href="#fixes.libtool" title="18.3.1. Shared libraries - libtool">Section 18.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6476: <p>When choosing which of these variables to use,
1.87 wiz 6477: follow the following rules:</p>
1.75 rillig 6478: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6479: <li><p><code class="varname">PREFIX</code> always points to the location
6480: where the current pkg will be installed. When referring to a
6481: pkg's own installation path, use
6482: “<span class="quote">${PREFIX}</span>”.</p></li>
6483: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6484: are installed. If you need to construct a -I or -L argument
6485: to the compiler to find includes and libraries installed by
6486: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6487: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6488: installed all packages in <code class="filename">/usr/local</code>. As
6489: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6490: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6491: <li><p><code class="varname">X11BASE</code> is where the actual X11
6492: distribution (from xsrc, etc.) is installed. When looking for
6493: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6494: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6495: <li>
6496: <p>X11-based packages are special in that they may be
6497: installed in either <code class="varname">X11BASE</code> or
6498: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6499: <p>Usually, X11 packages should be installed under
1.88 wiz 6500: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6501: will need to include
6502: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6503: request the presence of X11 and to get the right compilation
6504: flags.</p>
1.75 rillig 6505: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6506: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6507: files. These packages are special and they must be placed under
6508: <code class="varname">X11BASE</code>. To accomplish this, set either
6509: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6510: your package.</p>
1.75 rillig 6511: <p>Some notes: If you need
1.87 wiz 6512: to find includes or libraries installed by a pkg that has
6513: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6514: its pkg <code class="filename">Makefile</code>, you need to look in
6515: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6516: <code class="filename">${LOCALBASE}</code>. To force installation of
6517: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6518: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87 wiz 6519: is enabled by default.</p>
1.75 rillig 6520: </li>
1.88 wiz 6521: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6522: the installed location of an X11
6523: package. <code class="varname">X11PREFIX</code> will be set to
6524: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6525: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6526: installed.</p></li>
6527: <li>
6528: <p>If xpkgwedge is installed, it is possible to have some
6529: packages installed in <code class="varname">X11BASE</code> and some in
6530: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6531: installed package, the <code class="varname">EVAL_PREFIX</code>
6532: definition can be used. It takes pairs in the format
6533: “<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>
6534: variable <code class="varname">DIRNAME</code> will be set to the prefix
6535: of the installed package <package>, or
6536: “<span class="quote">${X11PREFIX}</span>” if the package is not
6537: installed.</p>
1.75 rillig 6538: <p>This is best illustrated by example.</p>
6539: <p>The following lines are taken from
1.87 wiz 6540: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6541: <pre class="programlisting">
1.100 rillig 6542: EVAL_PREFIX+= GTKDIR=gtk+
6543: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6544: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6545: CONFIGURE_ARGS+= --enable-multibyte
6546: </pre>
1.88 wiz 6547: <p>Specific defaults can be defined for the packages
6548: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6549: definition of the form:</p>
1.75 rillig 6550: <pre class="programlisting">
1.100 rillig 6551: GTKDIR_DEFAULT= ${LOCALBASE}
6552: </pre>
1.75 rillig 6553: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6554: to the first definition in
6555: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6556: </li>
1.76 rillig 6557: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6558: 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
6559: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6560: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6561: </ul></div>
6562: </div>
6563: <div class="sect1" lang="en">
6564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6565: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6566: <p>When building a package, a number of directories is used to store
1.87 wiz 6567: source files, temporary files, pkgsrc-internal files, and so on. These
6568: directories are explained here.</p>
1.75 rillig 6569: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6570: are two common base directories for these relative directories:
6571: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6572: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6573: inside the package itself.</p>
1.75 rillig 6574: <div class="variablelist"><dl>
6575: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6576: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6577: root directory. Generally, you don't need
6578: it.</p></dd>
1.97 rillig 6579: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6580: <dd><p>This is an absolute pathname that points to the
6581: current package.</p></dd>
1.75 rillig 6582: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6583: <dd><p>This is a pathname relative to
1.87 wiz 6584: <code class="varname">PKGSRCDIR</code> that points to the current
6585: package.</p></dd>
1.75 rillig 6586: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6587: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6588: where all work takes place. The distfiles are extracted to this
1.87 wiz 6589: directory. It also contains temporary directories and log files used by
6590: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6591: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6592: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6593: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6594: where the distfiles are extracted. It is usually a direct subdirectory
6595: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6596: that isn't hidden. This variable may be changed by a package
6597: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6598: </dl></div>
6599: </div>
6600: <div class="sect1" lang="en">
6601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6602: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6603: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6604: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6605: phase. This will automatically run all phases that are required for this
6606: phase. The default phase is <code class="varname">build</code>, that is, when you
6607: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6608: the package will be built, but not installed.</p>
1.75 rillig 6609: </div>
6610: <div class="sect1" lang="en">
6611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6612: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6613: <p>The first step in building a package is to fetch the
1.88 wiz 6614: distribution files (distfiles) from the sites that are providing
6615: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6616: phase.</p>
1.81 rillig 6617: <div class="sect2" lang="en">
6618: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6619: <a name="build.fetch.what"></a>16.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6620: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6621: defines all URLs from where the distfile, whose name is
6622: derived from the <code class="varname">DISTNAME</code> variable, is
6623: fetched. The more complicated cases are described
6624: below.</p>
6625: <p>The variable <code class="varname">DISTFILES</code> specifies
6626: the list of distfiles that have to be fetched. Its value
6627: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6628: so that most packages don't need to define it at all.
6629: <code class="varname">EXTRACT_SUFX</code> is
6630: <code class="literal">.tar.gz</code> by default, but can be changed
6631: freely. Note that if your package requires additional
6632: distfiles to the default one, you cannot just append the
6633: additional filenames using the <code class="literal">+=</code>
6634: operator, but you have write for example:</p>
1.81 rillig 6635: <pre class="programlisting">
1.100 rillig 6636: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6637: </pre>
1.88 wiz 6638: <p>Each distfile is fetched from a list of sites, usually
6639: <code class="varname">MASTER_SITES</code>. If the package has multiple
6640: <code class="varname">DISTFILES</code> or multiple
6641: <code class="varname">PATCHFILES</code> from different sites, you can
6642: set
6643: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6644: to the list of URLs where the file
6645: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6646: (including the suffix) can be found.</p>
6647: <pre class="programlisting">
1.100 rillig 6648: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6649: DISTFILES+= foo-file.tar.gz
6650: SITES.foo-file.tar.gz= \
6651: http://www.somewhere.com/somehow/ \
6652: http://www.somewhereelse.com/mirror/somehow/
6653: </pre>
1.81 rillig 6654: <p>When actually fetching the distfiles, each item from
1.88 wiz 6655: <code class="varname">MASTER_SITES</code> or
6656: <code class="varname">SITES.*</code> gets the name of each distfile
6657: appended to it, without an intermediate slash. Therefore,
6658: all site values have to end with a slash or other separator
6659: character. This allows for example to set
6660: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6661: that gets the name of the distfile as a parameter. In this
6662: case, the definition would look like:</p>
1.81 rillig 6663: <pre class="programlisting">
1.100 rillig 6664: MASTER_SITES= http://www.example.com/download.cgi?file=
6665: </pre>
1.81 rillig 6666: <p>There are some predefined values for
1.88 wiz 6667: <code class="varname">MASTER_SITES</code>, which can be used in
6668: packages. The names of the variables should speak for
6669: themselves.</p>
6670: <pre class="programlisting">
1.100 rillig 6671: ${MASTER_SITE_APACHE}
6672: ${MASTER_SITE_BACKUP}
6673: ${MASTER_SITE_CYGWIN}
6674: ${MASTER_SITE_DEBIAN}
6675: ${MASTER_SITE_FREEBSD}
6676: ${MASTER_SITE_FREEBSD_LOCAL}
6677: ${MASTER_SITE_GENTOO}
6678: ${MASTER_SITE_GNOME}
6679: ${MASTER_SITE_GNU}
6680: ${MASTER_SITE_GNUSTEP}
6681: ${MASTER_SITE_IFARCHIVE}
6682: ${MASTER_SITE_KDE}
6683: ${MASTER_SITE_MOZILLA}
6684: ${MASTER_SITE_MYSQL}
6685: ${MASTER_SITE_OPENOFFICE}
6686: ${MASTER_SITE_PERL_CPAN}
6687: ${MASTER_SITE_PGSQL}
6688: ${MASTER_SITE_R_CRAN}
6689: ${MASTER_SITE_SOURCEFORGE}
6690: ${MASTER_SITE_SOURCEFORGE_JP}
6691: ${MASTER_SITE_SUNSITE}
6692: ${MASTER_SITE_SUSE}
6693: ${MASTER_SITE_TEX_CTAN}
6694: ${MASTER_SITE_XCONTRIB}
6695: ${MASTER_SITE_XEMACS}
6696: </pre>
1.88 wiz 6697: <p>Some explanations for the less self-explaining ones:
6698: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93 rillig 6699: 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
6700: 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>
1.88 wiz 6701: <p>If you choose one of these predefined sites, you may
6702: want to specify a subdirectory of that site. Since these
6703: macros may expand to more than one actual site, you
6704: <span class="emphasis"><em>must</em></span> use the following construct to
6705: specify a subdirectory:</p>
1.81 rillig 6706: <pre class="programlisting">
1.100 rillig 6707: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6708: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6709: </pre>
1.81 rillig 6710: <p>Note the trailing slash after the subdirectory
1.88 wiz 6711: name.</p>
1.81 rillig 6712: </div>
6713: <div class="sect2" lang="en">
6714: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6715: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6716: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6717: all the distfiles exist in a local directory
1.93 rillig 6718: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6719: user). If the files do not exist, they are fetched using
6720: commands of the form</p>
1.75 rillig 6721: <pre class="programlisting">
1.100 rillig 6722: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6723: </pre>
1.88 wiz 6724: <p>where <code class="literal">${site}</code> varies through
6725: several possibilities in turn: first,
6726: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6727: sites specified in either <code class="varname">SITES.file</code> if
6728: defined, else <code class="varname">MASTER_SITES</code> or
6729: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6730: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6731: all except the first and the last can be optionally sorted
6732: by the user, via setting either
6733: <code class="varname">MASTER_SORT_RANDOM</code>, and
6734: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6735: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97 rillig 6736: <p>The distfiles mirror run by the NetBSD Foundation uses the
6737: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6738: distfiles, if they are freely distributable. Packages setting
6739: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6740: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6741: mirrored.</p>
1.81 rillig 6742: </div>
1.75 rillig 6743: </div>
6744: <div class="sect1" lang="en">
6745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6746: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6747: <p>After the distfile(s) are fetched, their checksum is
6748: generated and compared with the checksums stored in the
6749: distinfo file. If the checksums don't match, the build is
6750: aborted. This is to ensure the same distfile is used for
6751: building, and that the distfile wasn't changed, e.g. by some
6752: malign force, deliberately changed distfiles on the master
6753: distribution site or network lossage.</p>
1.75 rillig 6754: </div>
6755: <div class="sect1" lang="en">
6756: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6757: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6758: <p>When the distfiles are present on the local system, they
1.88 wiz 6759: need to be extracted, as they usually come in the form of some
6760: compressed archive format.</p>
1.75 rillig 6761: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6762: extracted. If you only need some of them, you can set the
6763: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6764: files.</p>
6765: <p>Extracting the files is usually done by a little
1.93 rillig 6766: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6767: already knows how to extract various archive formats, so most
6768: likely you will not need to change anything here. But if you
6769: need, the following variables may help you:</p>
1.75 rillig 6770: <div class="variablelist"><dl>
6771: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6772: <dd><p>Use these variables to override the default
1.88 wiz 6773: options for an extract command, which are defined in
1.93 rillig 6774: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6775: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6776: <dd><p>This variable can be set to
1.93 rillig 6777: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6778: default value), <code class="literal">pax</code>, or an
1.88 wiz 6779: absolute pathname pointing to the command with which tar
6780: archives should be
6781: extracted.</p></dd>
1.75 rillig 6782: </dl></div>
1.88 wiz 6783: <p>If the <code class="filename">extract</code> program doesn't
6784: serve your needs, you can also override the
6785: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6786: command used for extracting the files. This command is
6787: executed in the <code class="filename">${WRKSRC}</code>
6788: directory. During execution of this command, the shell
6789: variable <code class="varname">extract_file</code> holds the absolute
6790: pathname of the file that is going to be extracted.</p>
1.75 rillig 6791: <p>And if that still does not suffice, you can override the
1.88 wiz 6792: <code class="varname">do-extract</code> target in the package
6793: Makefile.</p>
1.75 rillig 6794: </div>
6795: <div class="sect1" lang="en">
6796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6797: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6798: <p>After extraction, all the patches named by the
1.88 wiz 6799: <code class="varname">PATCHFILES</code>, those present in the patches
6800: subdirectory of the package as well as in
6801: $LOCALPATCHES/$PKGPATH (e.g.
6802: <code class="filename">/usr/local/patches/graphics/png</code>) are
6803: applied. Patchfiles ending in <code class="filename">.Z</code> or
6804: <code class="filename">.gz</code> are uncompressed before they are
6805: applied, files ending in <code class="filename">.orig</code> or
6806: <code class="filename">.rej</code> are ignored. Any special options to
6807: <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.90 rillig 6808: <code class="varname">PATCH_DIST_ARGS</code>. See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more details.</p>
1.88 wiz 6809: <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
6810: it fail if the patches apply with some lines of fuzz. Please
6811: fix (regen) the patches so that they apply cleanly. The
6812: rationale behind this is that patches that don't apply cleanly
6813: may end up being applied in the wrong place, and cause severe
6814: harm there.</p>
1.75 rillig 6815: </div>
6816: <div class="sect1" lang="en">
6817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6818: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6819: <p>This is covered in <a href="#tools" title="Chapter 17. Tools needed for building or running">Chapter 17, <i>Tools needed for building or running</i></a>.
1.88 wiz 6820: </p>
1.75 rillig 6821: </div>
6822: <div class="sect1" lang="en">
6823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6824: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6825: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6826: linkers. The following variables can be used to tweak the
6827: wrappers.</p>
1.75 rillig 6828: <div class="variablelist"><dl>
6829: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6830: <dd><p>The command used to print progress
1.88 wiz 6831: messages. Does nothing by default. Set to
6832: <code class="literal">${ECHO}</code> to see the progress
6833: messages.</p></dd>
1.75 rillig 6834: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6835: <dd><p>This variable can be set to
1.88 wiz 6836: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6837: depending on whether you want additional information in the
6838: wrapper log file.</p></dd>
1.75 rillig 6839: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6840: <dd><p>This variable can be set to
1.88 wiz 6841: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6842: on whether the wrapper should use its cache, which will
6843: improve the speed. The default value is
6844: <code class="literal">yes</code>, but is forced to
6845: <code class="literal">no</code> if the platform does not support
6846: it.</p></dd>
1.75 rillig 6847: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6848: <dd><p>A list of reordering commands. A reordering
6849: command has the form
6850: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6851: It ensures that that
6852: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6853: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6854: </p></dd>
1.75 rillig 6855: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6856: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6857: investigate further]</p></dd>
1.75 rillig 6858: </dl></div>
6859: </div>
6860: <div class="sect1" lang="en">
6861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6862: <a name="build.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6863: <p>Most pieces of software need information on the header
6864: files, system calls, and library routines which are available
6865: on the platform they run on. The process of determining this
6866: information is known as configuration, and is usually
6867: automated. In most cases, a script is supplied with the
6868: distfiles, and its invocation results in generation of header
6869: files, Makefiles, etc.</p>
6870: <p>If the package contains a configure script, this can be
6871: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6872: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6873: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6874: “<span class="quote">yes</span>” instead. What happens in the
6875: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6876: <pre class="programlisting">
1.100 rillig 6877: .for d in ${CONFIGURE_DIRS}
6878: cd ${WRKSRC} \
6879: && cd ${d} \
6880: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6881: .endfor
6882: </pre>
1.88 wiz 6883: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6884: “<span class="quote">.</span>”) is a list of pathnames relative to
6885: <code class="varname">WRKSRC</code>. In each of these directories, the
6886: configure script is run with the environment
6887: <code class="varname">CONFIGURE_ENV</code> and arguments
6888: <code class="varname">CONFIGURE_ARGS</code>. The variables
6889: <code class="varname">CONFIGURE_ENV</code>,
6890: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6891: “<span class="quote">./configure</span>”) and
6892: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6893: package.</p>
6894: <p>If the program uses an <code class="filename">Imakefile</code>
6895: for configuration, the appropriate steps can be invoked by
6896: setting <code class="varname">USE_IMAKE</code> to
6897: “<span class="quote">yes</span>”. (If you only want the package installed in
6898: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6899: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6900: xmkmf's environment by adding them to the
6901: <code class="varname">SCRIPTS_ENV</code> variable.</p>
6902: <p>If there is no configure step at all, set
6903: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6904: </div>
6905: <div class="sect1" lang="en">
6906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6907: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6908: <p>For building a package, a rough equivalent of the
6909: following code is executed.</p>
1.75 rillig 6910: <pre class="programlisting">
1.100 rillig 6911: .for d in ${BUILD_DIRS}
6912: cd ${WRKSRC} \
6913: && cd ${d} \
6914: && env ${MAKE_ENV} \
6915: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6916: -f ${MAKE_FILE} \
6917: ${BUILD_TARGET}
6918: .endfor
6919: </pre>
1.88 wiz 6920: <p><code class="varname">BUILD_DIRS</code> (default:
6921: “<span class="quote">.</span>”) is a list of pathnames relative to
6922: <code class="varname">WRKSRC</code>. In each of these directories,
6923: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6924: <code class="varname">MAKE_ENV</code> and arguments
6925: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6926: <code class="varname">MAKE_ENV</code>,
6927: <code class="varname">BUILD_MAKE_FLAGS</code>,
6928: <code class="varname">MAKE_FILE</code> and
6929: <code class="varname">BUILD_TARGET</code> may all be changed by the
6930: package.</p>
1.75 rillig 6931: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6932: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6933: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6934: default value of <code class="varname">MAKE_FILE</code> is
6935: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6936: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6937: <p>If there is no build step at all, set
6938: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6939: </div>
6940: <div class="sect1" lang="en">
6941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6942: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6943: <p>[TODO]</p>
6944: </div>
6945: <div class="sect1" lang="en">
6946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6947: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6948: <p>Once the build stage has completed, the final step is to
1.88 wiz 6949: install the software in public directories, so users can
6950: access the programs and files.</p>
1.75 rillig 6951: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6952: equivalent of the following code is executed. Additionally,
6953: before and after this code, much magic is performed to do
6954: consistency checks, registering the package, and so on.</p>
6955: <pre class="programlisting">
1.100 rillig 6956: .for d in ${INSTALL_DIRS}
6957: cd ${WRKSRC} \
6958: && cd ${d} \
6959: && env ${MAKE_ENV} \
6960: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6961: -f ${MAKE_FILE} \
6962: ${INSTALL_TARGET}
6963: .endfor
6964: </pre>
1.75 rillig 6965: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6966: <span class="emphasis"><em>build</em></span> phase.
6967: <code class="varname">INSTALL_DIRS</code> defaults to
6968: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6969: is “<span class="quote">install</span>” by default, plus
6970: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6971: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6972: defined.</p>
1.75 rillig 6973: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6974: variables are useful. They are all variations of the
6975: <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
6976: permissions preset. <code class="varname">INSTALL</code> is the plain
6977: install command. The specialized variants, together with their
6978: intended use, are:</p>
1.75 rillig 6979: <div class="variablelist"><dl>
6980: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6981: <dd><p>directories that contain
6982: binaries</p></dd>
1.75 rillig 6983: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6984: <dd><p>directories that contain
6985: scripts</p></dd>
1.75 rillig 6986: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6987: <dd><p>directories that contain shared and static
6988: libraries</p></dd>
1.75 rillig 6989: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6990: <dd><p>directories that contain data
6991: files</p></dd>
1.75 rillig 6992: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6993: <dd><p>directories that contain man
6994: pages</p></dd>
1.75 rillig 6995: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6996: <dd><p>binaries that can be stripped from debugging
6997: symbols</p></dd>
1.75 rillig 6998: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6999: <dd><p>binaries that cannot be
7000: stripped</p></dd>
1.75 rillig 7001: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7002: <dd><p>game
7003: binaries</p></dd>
1.75 rillig 7004: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7005: <dd><p>shared and static
7006: libraries</p></dd>
1.75 rillig 7007: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7008: <dd><p>data files</p></dd>
7009: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7010: <dd><p>data files for
7011: games</p></dd>
1.75 rillig 7012: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7013: <dd><p>man pages</p></dd>
7014: </dl></div>
7015: <p>Some other variables are:</p>
7016: <div class="variablelist"><dl>
7017: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7018: <dd><p>A list of directories relative to
1.88 wiz 7019: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7020: beginning of the <span class="emphasis"><em>install</em></span> phase.
7021: The package is supposed to create all needed directories itself
7022: before installing files to it and list all other directories here.
7023: </p></dd>
1.75 rillig 7024: </dl></div>
1.97 rillig 7025: <p>In the rare cases that a package shouldn't install anything,
7026: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7027: mostly relevant for packages in the <code class="filename">regress</code>
7028: category.</p>
1.75 rillig 7029: </div>
7030: <div class="sect1" lang="en">
7031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7032: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7033: <p>Once the install stage has completed, a binary package of
7034: the installed files can be built. These binary packages can be
7035: used for quick installation without previous compilation, e.g. by
7036: the <span><strong class="command">make bin-install</strong></span> or by using
7037: <span><strong class="command">pkg_add</strong></span>.</p>
7038: <p>By default, the binary packages are created in
7039: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7040: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7041: one for each category in the <code class="varname">CATEGORIES</code>
7042: variable. <code class="varname">PACKAGES</code> defaults to
7043: <code class="filename">pkgsrc/packages</code>.</p>
1.97 rillig 7044: <p>If there should be no binary package, set
7045: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7046: This should only be used in rare cases, like when a package
7047: definitely is only usable on the machine where it is built and even
7048: then, a binary package can be useful.</p>
1.88 wiz 7049: </div>
7050: <div class="sect1" lang="en">
7051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7052: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 7053: <p>Once you're finished with a package, you can clean the work
7054: directory by running <span><strong class="command">make clean</strong></span>. If you want
7055: to clean the work directories of all dependencies too, use
7056: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 7057: </div>
7058: <div class="sect1" lang="en">
7059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7060: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7061: <div class="variablelist"><dl>
7062: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7063: <dd><p>For any of the main targets described in the
7064: previous section, two auxiliary targets exist with
1.87 wiz 7065: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7066: prefix for the main target's name. These targets are
1.88 wiz 7067: invoked before and after the main target is called,
7068: allowing extra configuration or installation steps be
7069: performed from a package's Makefile, for example, which
7070: a program's configure script or install target
7071: omitted.</p></dd>
1.75 rillig 7072: <dt><span class="term">do-*</span></dt>
1.88 wiz 7073: <dd><p>Should one of the main targets do the wrong thing,
7074: and should there be no variable to fix this, you can
7075: redefine it with the do-* target. (Note that redefining
7076: the target itself instead of the do-* target is a bad
7077: idea, as the pre-* and post-* targets won't be called
7078: anymore, etc.) You will not usually need to do
7079: this.</p></dd>
1.75 rillig 7080: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7081: <dd>
7082: <p>If you did a <span><strong class="command">make install</strong></span> and
7083: you noticed some file was not installed properly, you
7084: can repeat the installation with this target, which will
7085: ignore the “<span class="quote">already installed</span>” flag.</p>
7086: <p>This is the default value of
7087: <code class="varname">DEPENDS_TARGET</code> except in the case of
7088: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7089: package</strong></span>, where the defaults are
7090: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7091: respectively.</p>
7092: </dd>
1.75 rillig 7093: <dt><span class="term">deinstall</span></dt>
7094: <dd>
1.88 wiz 7095: <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
7096: current directory, effectively de-installing the
7097: package. The following variables can be used to tune the
7098: behaviour:</p>
1.75 rillig 7099: <div class="variablelist"><dl>
7100: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7101: <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>
7102: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7103: <dd><p>Remove all packages that require (depend on)
7104: the given package. This can be used to remove any
7105: packages that may have been pulled in by a given
7106: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 7107: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7108: <code class="filename">pkgsrc/x11/kde</code>, this is
7109: likely to remove whole KDE. Works by adding
7110: “<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>
7111: command line.</p></dd>
1.75 rillig 7112: </dl></div>
7113: </dd>
1.88 wiz 7114: <dt><span class="term">bin-install</span></dt>
7115: <dd><p>Install a binary package from local disk and via FTP
7116: from a list of sites (see the
7117: <code class="varname">BINPKG_SITES</code> variable), and do a
7118: <span><strong class="command">make package</strong></span> if no binary package is
7119: available anywhere. The arguments given to
7120: <span><strong class="command">pkg_add</strong></span> can be set via
7121: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7122: operation, etc.</p></dd>
1.75 rillig 7123: <dt><span class="term">update</span></dt>
7124: <dd>
1.88 wiz 7125: <p>This target causes the current package to be
7126: updated to the latest version. The package and all
7127: depending packages first get de-installed, then current
7128: versions of the corresponding packages get compiled and
7129: installed. This is similar to manually noting which
7130: packages are currently installed, then performing a
7131: series of <span><strong class="command">make deinstall</strong></span> and
7132: <span><strong class="command">make install</strong></span> (or whatever
7133: <code class="varname">UPDATE_TARGET</code> is set to) for these
7134: packages.</p>
7135: <p>You can use the “<span class="quote">update</span>” target to
7136: resume package updating in case a previous <span><strong class="command">make
7137: update</strong></span> was interrupted for some reason.
7138: However, in this case, make sure you don't call
7139: <span><strong class="command">make clean</strong></span> or otherwise remove the
7140: list of dependent packages in <code class="varname">WRKDIR</code>.
7141: Otherwise, you lose the ability to automatically update
7142: the current package along with the dependent packages
7143: you have installed.</p>
7144: <p>Resuming an interrupted <span><strong class="command">make
7145: update</strong></span> will only work as long as the package
7146: tree remains unchanged. If the source code for one of
7147: the packages to be updated has been changed, resuming
7148: <span><strong class="command">make update</strong></span> will most certainly
7149: fail!</p>
7150: <p>The following variables can be used either on the
1.104 rillig 7151: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 7152: alter the behaviour of <span><strong class="command">make
7153: update</strong></span>:</p>
1.75 rillig 7154: <div class="variablelist"><dl>
7155: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7156: <dd><p>Install target to recursively use for the
7157: updated package and the dependent packages.
7158: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7159: set, “<span class="quote">install</span>” otherwise for
7160: <span><strong class="command">make update</strong></span>. Other good
7161: targets are “<span class="quote">package</span>” or
7162: “<span class="quote">bin-install</span>”. Do not set this to
7163: “<span class="quote">update</span>” or you will get stuck in an
7164: endless loop!</p></dd>
1.75 rillig 7165: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7166: <dd><p>Don't clean up after updating. Useful if
7167: you want to leave the work sources of the updated
7168: packages around for inspection or other purposes.
7169: Be sure you eventually clean up the source tree
7170: (see the “<span class="quote">clean-update</span>” target below)
7171: or you may run into troubles with old source code
7172: still lying around on your next
7173: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7174: update</strong></span>.</p></dd>
1.75 rillig 7175: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7176: <dd><p>Deinstall each package before installing
7177: (making <code class="varname">DEPENDS_TARGET</code>). This
7178: may be necessary if the
7179: “<span class="quote">clean-update</span>” target (see below) was
7180: called after interrupting a running <span><strong class="command">make
7181: update</strong></span>.</p></dd>
1.75 rillig 7182: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7183: <dd><p>Allows you to disable recursion and hardcode
7184: the target for packages. The default is
7185: “<span class="quote">update</span>” for the update target,
7186: facilitating a recursive update of prerequisite
7187: packages. Only set
7188: <code class="varname">DEPENDS_TARGET</code> if you want to
7189: disable recursive updates. Use
7190: <code class="varname">UPDATE_TARGET</code> instead to just
7191: set a specific target for each package to be
7192: installed during <span><strong class="command">make update</strong></span>
7193: (see above).</p></dd>
1.75 rillig 7194: </dl></div>
7195: </dd>
7196: <dt><span class="term">clean-update</span></dt>
7197: <dd>
1.88 wiz 7198: <p>Clean the source tree for all packages that would
7199: get updated if <span><strong class="command">make update</strong></span> was called
7200: from the current directory. This target should not be
7201: used if the current package (or any of its depending
7202: packages) have already been de-installed (e.g., after
7203: calling <span><strong class="command">make update</strong></span>) or you may lose
7204: some packages you intended to update. As a rule of
7205: thumb: only use this target <span class="emphasis"><em>before</em></span>
7206: the first time you run <span><strong class="command">make update</strong></span>
7207: and only if you have a dirty package tree (e.g., if you
7208: used <code class="varname">NOCLEAN</code>).</p>
7209: <p>If you are unsure about whether your tree is
7210: clean, you can either perform a <span><strong class="command">make
7211: clean</strong></span> at the top of the tree, or use the
7212: following sequence of commands from the directory of the
7213: package you want to update (<span class="emphasis"><em>before</em></span>
7214: running <span><strong class="command">make update</strong></span> for the first
7215: time, otherwise you lose all the packages you wanted to
7216: update!):</p>
1.87 wiz 7217: <pre class="screen">
7218: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7219: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7220: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7221: </pre>
1.88 wiz 7222: <p>The following variables can be used either on the
1.104 rillig 7223: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7224: <span><strong class="command">make clean-update</strong></span>:</p>
1.75 rillig 7225: <div class="variablelist"><dl>
7226: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88 wiz 7227: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7228: reconstruct the list of directories to update for
7229: this package. Only use this if <span><strong class="command">make
7230: update</strong></span> successfully installed all
7231: packages you wanted to update. Normally, this is
7232: done automatically on <span><strong class="command">make
7233: update</strong></span>, but may have been suppressed by
7234: the <code class="varname">NOCLEAN</code> variable (see
7235: above).</p></dd>
1.75 rillig 7236: </dl></div>
7237: </dd>
1.88 wiz 7238: <dt><span class="term">replace</span></dt>
7239: <dd>
7240: <p>Update the installation of the current package. This
7241: differs from update in that it does not replace dependent
1.93 rillig 7242: 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
1.88 wiz 7243: target to work.</p>
7244: <p><span class="emphasis"><em>Be careful when using this
7245: target!</em></span> There are no guarantees that dependent
7246: packages will still work, in particular they will most
7247: certainly break if you <span><strong class="command">make replace</strong></span> a
7248: library package whose shared library major version changed
7249: between your installed version and the new one. For this
7250: reason, this target is not officially supported and only
7251: recommended for advanced users.</p>
7252: </dd>
1.75 rillig 7253: <dt><span class="term">info</span></dt>
7254: <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
1.88 wiz 7255: package. You can use this to check which version of a
7256: package is installed.</p></dd>
7257: <dt><span class="term">index</span></dt>
7258: <dd>
7259: <p>This is a top-level command, i.e. it should be used in
7260: the <code class="filename">pkgsrc</code> directory. It creates a
7261: database of all packages in the local pkgsrc tree, including
7262: dependencies, comment, maintainer, and some other useful
7263: information. Individual entries are created by running
7264: <span><strong class="command">make describe</strong></span> in the packages'
7265: directories. This index file is saved as
7266: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7267: verbose format by running <span><strong class="command">make
7268: print-index</strong></span>. You can search in it with
7269: <span><strong class="command">make search
7270: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7271: extract a list of all packages that depend on a particular
7272: one by running <span><strong class="command">make show-deps
7273: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7274: <p>Running this command takes a very long time, some
7275: hours even on fast machines!</p>
7276: </dd>
1.75 rillig 7277: <dt><span class="term">readme</span></dt>
1.88 wiz 7278: <dd>
7279: <p>This target generates a
7280: <code class="filename">README.html</code> file, which can be
1.91 rillig 7281: 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
1.88 wiz 7282: contain references to any packages which are in the
7283: <code class="varname">PACKAGES</code> directory on the local
7284: host. The generated files can be made to refer to URLs
7285: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7286: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7287: wanted to generate <code class="filename">README.html</code>
7288: files which pointed to binary packages on the local
7289: machine, in the directory
7290: <code class="filename">/usr/packages</code>, set
7291: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7292: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7293: <code class="varname">${PACKAGES}</code> directory and its
7294: subdirectories will be searched for all the binary
7295: packages.</p>
7296: <p>The target can be run at the toplevel or in category
7297: directories, in which case it descends recursively.</p>
7298: </dd>
1.75 rillig 7299: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7300: <dd><p>This is a top-level command, run it in
7301: <code class="filename">pkgsrc</code>. Use this target to create a
7302: file <code class="filename">README-all.html</code> which contains a
7303: list of all packages currently available in the NetBSD
7304: Packages Collection, together with the category they belong
7305: to and a short description. This file is compiled from the
7306: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7307: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7308: readme</strong></span>.</p></dd>
1.75 rillig 7309: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7310: <dd><p>This is very much the same as the
7311: “<span class="quote">readme</span>” target (see above), but is to be
7312: used when generating a pkgsrc tree to be written to a
7313: CD-ROM. This target also produces
7314: <code class="filename">README.html</code> files, and can be made
7315: to refer to URLs based on
7316: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7317: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7318: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7319: <dd><p>This target shows which distfiles and patchfiles
7320: are needed to build the package
7321: (<code class="varname">ALLFILES</code>, which contains all
7322: <code class="varname">DISTFILES</code> and
1.87 wiz 7323: <code class="varname">PATCHFILES</code>, but not
7324: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7325: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7326: <dd><p>This target shows nothing if the package is not
7327: installed. If a version of this package is installed,
7328: but is not the version provided in this version of
7329: pkgsrc, then a warning message is displayed. This target
7330: can be used to show which of your installed packages are
7331: downlevel, and so the old versions can be deleted, and
7332: the current ones added.</p></dd>
1.75 rillig 7333: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7334: <dd><p>This target shows the directory in the pkgsrc
7335: hierarchy from which the package can be built and
7336: installed. This may not be the same directory as the one
7337: from which the package was installed. This target is
7338: intended to be used by people who may wish to upgrade
7339: many packages on a single host, and can be invoked from
7340: the top-level pkgsrc Makefile by using the
1.87 wiz 7341: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7342: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7343: <dd><p>This target shows which installed packages match
7344: the current package's <code class="varname">DEPENDS</code>. Useful
7345: if out of date dependencies are causing build
7346: problems.</p></dd>
1.75 rillig 7347: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7348: <dd><p>After a package is installed, check all its
7349: binaries and (on ELF platforms) shared libraries to see
7350: if they find the shared libs they need. Run by default
1.104 rillig 7351: if <code class="varname">PKG_DEVELOPER</code> is set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75 rillig 7352: <dt><span class="term">print-PLIST</span></dt>
7353: <dd>
7354: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7355: upgraded pkg, this prints out an attempt to generate a
7356: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7357: -newer work/.extract_done</strong></span>. An attempt is made
7358: to care for shared libs etc., but it is
1.87 wiz 7359: <span class="emphasis"><em>strongly</em></span> recommended to review the
7360: result before putting it into
7361: <code class="filename">PLIST</code>. On upgrades, it's useful to
7362: diff the output of this command against an already
7363: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7364: <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
7365: other methods that don't update file access times, be
7366: sure to add these files manually to your
1.87 wiz 7367: <code class="filename">PLIST</code>, as the “<span class="quote">find
7368: -newer</span>” command used by this target won't catch
7369: them!</p>
1.90 rillig 7370: <p>See <a href="#print-PLIST" title="12.3. Tweaking output of make print-PLIST">Section 12.3, “Tweaking output of <span><strong class="command">make print-PLIST</strong></span>”</a> for more
1.87 wiz 7371: information on this target.</p>
1.75 rillig 7372: </dd>
7373: <dt><span class="term">bulk-package</span></dt>
7374: <dd>
1.88 wiz 7375: <p>Used to do bulk builds. If an appropriate binary
7376: package already exists, no action is taken. If not, this
7377: target will compile, install and package it (and its
7378: depends, if <code class="varname">PKG_DEPENDS</code> is set
7379: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7380: After creating the binary package, the sources, the
7381: just-installed package and its required packages are
7382: removed, preserving free disk space.</p>
7383: <p><span class="emphasis"><em>Beware that this target may deinstall
7384: all packages installed on a system!</em></span></p>
1.75 rillig 7385: </dd>
7386: <dt><span class="term">bulk-install</span></dt>
7387: <dd>
1.88 wiz 7388: <p>Used during bulk-installs to install required
7389: packages. If an up-to-date binary package is available,
7390: 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,
7391: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7392: but the installed binary won't be removed.</p>
1.88 wiz 7393: <p>A binary package is considered
7394: “<span class="quote">up-to-date</span>” to be installed via
7395: <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>
7396: <div class="itemizedlist"><ul type="disc">
7397: <li><p>None of the package's files
7398: (<code class="filename">Makefile</code>, ...) were modified
7399: since it was built.</p></li>
7400: <li><p>None of the package's required (binary)
7401: packages were modified since it was built.</p></li>
1.75 rillig 7402: </ul></div>
1.88 wiz 7403: <p><span class="emphasis"><em>Beware that this target may deinstall
7404: all packages installed on a system!</em></span></p>
1.75 rillig 7405: </dd>
7406: </dl></div>
7407: </div>
7408: </div>
7409: <div class="chapter" lang="en">
7410: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7411: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7412: <div class="toc">
7413: <p><b>Table of Contents</b></p>
7414: <dl>
1.90 rillig 7415: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7416: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7417: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 7418: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7419: </dl>
7420: </div>
1.87 wiz 7421: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7422: by pkgsrc and also for individual packages to define what commands
7423: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7424: or for later run-time of an installed packaged (such as
7425: <code class="varname">DEPENDS</code>).
7426: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7427: package will not be used.</p>
7428: <p>When building a package, the replacement tools are
1.75 rillig 7429: made available in a directory (as symlinks or wrapper scripts)
7430: that is early in the executable search path. Just like the buildlink
1.87 wiz 7431: system, this helps with consistent builds.</p>
7432: <p>A tool may be needed to help build a specific package. For example,
7433: perl, GNU make (gmake) or yacc may be needed.</p>
7434: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7435: tool may be inefficient for building a package with pkgsrc.
7436: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7437: yacc) or a better sed.</p>
7438: <p>The tools used by a package can be listed by running
7439: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7440: <div class="sect1" lang="en">
7441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7442: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7443: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7444: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7445: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7446: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7447: These can be seen by running:
1.87 wiz 7448: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7449: <p>If a package needs a specific program to build
1.75 rillig 7450: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7451: to define the tools needed.</p>
1.75 rillig 7452: </div>
7453: <div class="sect1" lang="en">
7454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7455: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7456: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7457: and not the native version for a build dependency.
7458: And the :run means that it is used for a
7459: run-time dependencies also (and becomes a DEPENDS).
7460: The default is a build dependency which can be set with
7461: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7462: and pkg-config:build.)</p>
1.75 rillig 7463: <pre class="programlisting">
7464: USE_TOOLS+= mktemp:pkgsrc
7465: USE_TOOLS+= gmake perl:run pkg-config
7466: </pre>
1.87 wiz 7467: <p>When using the tools framework, a
1.75 rillig 7468: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7469: which contains the full path to the appropriate tool. For example,
7470: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7471: on Linux systems.</p>
7472: <p>If you always need a pkgsrc version of the
1.75 rillig 7473: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7474: </p>
7475: </div>
7476: <div class="sect1" lang="en">
7477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7478: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7479: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7480: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7481: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7482: the name of the common tools. For example:</p>
7483: <pre class="programlisting">
7484: .if exists(/usr/bin/bzcat)
7485: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7486: .elif exists(/usr/bin/bzip2)
7487: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7488: .endif
1.69 rillig 7489:
1.75 rillig 7490: TOOLS_PLATFORM.true?= true # shell builtin
7491: </pre>
7492: </div>
1.97 rillig 7493: <div class="sect1" lang="en">
7494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7495: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
7496: <div class="qandaset">
7497: <dl>
7498: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
7499: </dt>
7500: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
7501: tools?</a>
7502: </dt>
7503: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
7504: package is using while being built? I want to know whether it
7505: uses sed or not.</a>
7506: </dt>
7507: </dl>
7508: <table border="0" summary="Q and A Set">
7509: <col align="left" width="1%">
7510: <tbody>
7511: <tr class="question">
7512: <td align="left" valign="top">
1.105 ! weinem 7513: <a name="tools.new"></a><a name="id2707918"></a><b>17.4.1.</b>
1.97 rillig 7514: </td>
7515: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7516: </tr>
7517: <tr class="answer">
7518: <td align="left" valign="top"></td>
7519: <td align="left" valign="top"><p>TODO</p></td>
7520: </tr>
7521: <tr class="question">
7522: <td align="left" valign="top">
1.105 ! weinem 7523: <a name="tools.listall"></a><a name="id2707928"></a><b>17.4.2.</b>
1.97 rillig 7524: </td>
7525: <td align="left" valign="top"><p>How do I get a list of all available
7526: tools?</p></td>
7527: </tr>
7528: <tr class="answer">
7529: <td align="left" valign="top"></td>
7530: <td align="left" valign="top"><p>TODO</p></td>
7531: </tr>
7532: <tr class="question">
7533: <td align="left" valign="top">
1.105 ! weinem 7534: <a name="tools.used"></a><a name="id2708007"></a><b>17.4.3.</b>
1.97 rillig 7535: </td>
7536: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7537: package is using while being built? I want to know whether it
7538: uses sed or not.</p></td>
7539: </tr>
7540: <tr class="answer">
7541: <td align="left" valign="top"></td>
7542: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7543: to do it.)</p></td>
7544: </tr>
7545: </tbody>
7546: </table>
7547: </div>
7548: </div>
1.75 rillig 7549: </div>
7550: <div class="chapter" lang="en">
7551: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7552: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75 rillig 7553: <div class="toc">
7554: <p><b>Table of Contents</b></p>
7555: <dl>
1.90 rillig 7556: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7557: <dd><dl>
1.90 rillig 7558: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7559: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">18.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
7560: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7561: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7562: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7563: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7564: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7565: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7566: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7567: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7568: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7569: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7570: </dl></dd>
7571: <dt><span class="sect1"><a href="#fixes.fetch">18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7572: <dd><dl>
7573: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7574: <dt><span class="sect2"><a href="#modified-distfiles-same-name">18.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
7575: </dl></dd>
7576: <dt><span class="sect1"><a href="#fixes.configure">18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7577: <dd><dl>
7578: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7579: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7580: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7581: </dl></dd>
7582: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7583: <dd><dl>
7584: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7585: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7586: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7587: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7588: </dl></dd>
7589: <dt><span class="sect1"><a href="#fixes.build">18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7590: <dd><dl>
7591: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7592: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7593: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7594: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7595: </dl></dd>
7596: <dt><span class="sect1"><a href="#fixes.install">18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7597: <dd><dl>
7598: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7599: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 7600: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103 wiz 7601: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
7602: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7603: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
7604: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
7605: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
7606: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
7607: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
7608: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
7609: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
7610: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
7611: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
7612: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
7613: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
7614: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
7615: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87 wiz 7616: emulation</a></span></dt>
1.103 wiz 7617: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
7618: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7619: </dl></dd>
1.90 rillig 7620: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7621: </dl>
7622: </div>
7623: <div class="sect1" lang="en">
7624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7625: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7626: <div class="sect2" lang="en">
7627: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7628: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7629: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7630: different platforms. As a result, it is important to ensure,
7631: where possible, that packages in pkgsrc are portable. This
7632: chapter mentions some particular details you should pay
7633: attention to while working on pkgsrc.</p>
1.78 rillig 7634: </div>
7635: <div class="sect2" lang="en">
7636: <div class="titlepage"><div><div><h3 class="title">
1.104 rillig 7637: <a name="pulling-vars-from-etc-mk.conf"></a>18.1.2. How to pull in user-settable variables from <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7638: </h3></div></div></div>
1.78 rillig 7639: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7640: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.104 rillig 7641: which is <a href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7642: want to use those variables in the preprocessor directives of
7643: <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
7644: <code class="literal">.for</code>), you need to include the file
7645: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7646: loads the user preferences.</p>
1.78 rillig 7647: <p>But note that some variables may not be completely defined
1.87 wiz 7648: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7649: included, as they may contain references to variables that are
7650: not yet defined. In shell commands this is no problem, since
7651: variables are actually macros, which are only expanded when they
7652: are used. But in the preprocessor directives mentioned above and
7653: in dependency lines (of the form <code class="literal">target:
7654: dependencies</code>) the variables are expanded at load
7655: time.</p>
1.78 rillig 7656: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7657: <h3 class="title">Note</h3>
7658: <p>Currently there is no exhaustive list of all
1.87 wiz 7659: variables that tells you whether they can be used at load time
7660: or only at run time, but it is in preparation.</p>
1.78 rillig 7661: </div>
7662: </div>
7663: <div class="sect2" lang="en">
7664: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7665: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7666: <p>Occasionally, packages require interaction from the user,
7667: and this can be in a number of ways:</p>
1.78 rillig 7668: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7669: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7670: interaction such as entering username/password or accepting a
7671: license on a web page.</p></li>
1.88 wiz 7672: <li><p>When extracting the distfiles, some packages may ask for
7673: passwords.</p></li>
1.78 rillig 7674: <li><p>help to configure the package before it is built</p></li>
7675: <li><p>help during the build process</p></li>
7676: <li><p>help during the installation of a package</p></li>
7677: </ul></div>
1.88 wiz 7678: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7679: provided to notify the pkgsrc mechanism of an interactive stage
7680: which will be needed, and this should be set in the package's
7681: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7682: <pre class="programlisting">
1.100 rillig 7683: INTERACTIVE_STAGE= build
1.87 wiz 7684: </pre>
1.78 rillig 7685: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7686: <pre class="programlisting">
1.100 rillig 7687: INTERACTIVE_STAGE= configure install
1.87 wiz 7688: </pre>
1.88 wiz 7689: <p>The user can then decide to skip this package by setting the
7690: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7691: </div>
7692: <div class="sect2" lang="en">
7693: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7694: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7695: <p>Authors of software can choose the licence under which
7696: software can be copied. This is due to copyright law, and reasons
7697: for license choices are outside the scope of pkgsrc. The pkgsrc
7698: system recognizes that there are a number of licenses which some
7699: users may find objectionable or difficult or impossible to comply
7700: with. The Free Software Foundation has declared some licenses
7701: "Free", and the Open Source Initiative has a definition of "Open
7702: Source". The pkgsrc system, as a policy choice, does not label
7703: packages which have licenses that are Free or Open Source.
7704: However, packages without a license meeting either of those tests
7705: are labeled with a license tag denoting the license. Note that a
7706: package with no license to copy trivially does not meet either the
7707: Free or Open Source test.</p>
7708: <p>For packages which are not Free or Open Source, pkgsrc will
7709: not build the package unless the user has indicated to pkgsrc that
7710: packages with that particular license may be built. Note that
7711: this documentation avoids the term "accepted the license". The
7712: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7713: accidentally building a package with a non-free license;
1.98 wiz 7714: judgement and responsibility remain with the user. (Installation
7715: of binary packages are not currently subject to this mechanism;
7716: this is a bug.)</p>
7717: <p>One might want to only install packages with a BSD license,
7718: or the GPL, and not the other. The pkgsrc license tag mechanism
7719: does not provide a way to do this. It might be possible to put in
7720: tags for free licenses, and have a default
7721: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7722: widely viewed as having a very poor ratio of benefit to
7723: work.</p>
1.78 rillig 7724: <p>The license tag mechanism is intended to address
1.87 wiz 7725: copyright-related issues surrounding building, installing and
7726: using a package, and not to address redistribution issues (see
7727: <code class="varname">RESTRICTED</code> and
7728: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7729: definition of licenses for which tags are not needed implies
7730: that packages with redistribution restrictions should have
1.98 wiz 7731: tags, because Free or Open Source programs do not have
7732: redistribution restrictions.</p>
7733: <p>Denoting that a package may be copied according to a
7734: particular license is done by placing the license in
1.87 wiz 7735: <code class="filename">pkgsrc/licenses</code> and setting the
7736: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7737: 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>
1.87 wiz 7738: <pre class="programlisting">
1.100 rillig 7739: LICENSE= xv-license
1.87 wiz 7740: </pre>
7741: <p>When trying to build, the user will get a notice that the
1.98 wiz 7742: package is covered by a license which has not been placed in the
7743: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7744: <pre class="programlisting">
1.100 rillig 7745: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7746: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7747: ===> To view the license, enter "/usr/bin/make show-license".
7748: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7749: ===> ACCEPTABLE_LICENSES+=xv-license
7750: *** Error code 1
1.87 wiz 7751: </pre>
1.78 rillig 7752: <p>The license can be viewed with <span><strong class="command">make
1.98 wiz 7753: show-license</strong></span>, and if the user so chooses, the line
1.104 rillig 7754: printed above can be added to <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7755: convey to pkgsrc that it should not in the future fail because of
7756: that license:</p>
1.78 rillig 7757: <pre class="programlisting">
1.100 rillig 7758: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7759: </pre>
1.98 wiz 7760: <p>When adding a package with a new license, the license text
7761: should be added to <code class="filename">pkgsrc/licenses</code> for
7762: displaying. A list of known licenses can be seen in this
1.91 rillig 7763: directory.</p>
1.98 wiz 7764: <p>When the license changes (in a way other than formatting),
7765: please make sure that the new license has a different name (e.g.,
7766: append the version number if it exists, or the date). Just
7767: because a user told pkgsrc to build programs under a previous
7768: version of a license does not mean that pkgsrc should build
1.99 rillig 7769: programs under the new licenses. The higher-level point is that
1.98 wiz 7770: pkgsrc does not evaluate licenses for reasonableness; the only
7771: test is a mechanistic test of whether a particular text has been
7772: approved by either of two bodies.</p>
1.78 rillig 7773: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7774: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7775: is deprecated because it does not crisply refer to a particular
7776: license text. Another problem with such usage is that it does not
7777: enable a user to tell pkgsrc to proceed for a single package
7778: without also telling pkgsrc to proceed for all packages with that
7779: tag.</p>
1.75 rillig 7780: </div>
7781: <div class="sect2" lang="en">
7782: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7783: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7784: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7785: Because a license tag is required unless the package is Free or
7786: Open Source, all packages with restrictions should have license
7787: tags. By declaring the restrictions, package tools can
7788: automatically refrain from e.g. placing binary packages on FTP
7789: sites.</p>
7790: <p>There are four restrictions that may be encoded, which are
7791: the cross product of sources (distfiles) and binaries not being
7792: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7793: language in any license, and because non-Free licenses tend to be
7794: different from each other, pkgsrc adopts a definition of FTP and
7795: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7796: should not be made available over the Internet at no charge.
7797: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7798: made available on some kind of media, together with other source
7799: and binary packages, and which is sold for a distribution charge.
7800: </p>
7801: <p>In order to encode these restrictions, the package system
1.87 wiz 7802: defines five make variables that can be set to note these
7803: restrictions:</p>
1.75 rillig 7804: <div class="itemizedlist"><ul type="disc">
7805: <li>
7806: <p><code class="varname">RESTRICTED</code></p>
7807: <p>This variable should be set whenever a restriction
1.87 wiz 7808: exists (regardless of its kind). Set this variable to a
1.98 wiz 7809: string containing the reason for the restriction. It should
7810: be understood that those wanting to understand the restriction
7811: will have to read the license, and perhaps seek advice of
7812: counsel.</p>
1.75 rillig 7813: </li>
7814: <li>
7815: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7816: <p>Binaries may not be placed on CD-ROM containing other
7817: binary packages, for which a distribution charge may be made.
7818: In this case, set this variable to
7819: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7820: </li>
7821: <li>
7822: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7823: <p>Binaries may not made available on the Internet without
7824: charge. In this case, set this variable to
7825: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7826: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7827: </li>
7828: <li>
7829: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7830: <p>Distfiles may not be placed on CD-ROM, together with
7831: other distfiles, for which a fee may be charged. In this
7832: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7833: </p>
1.75 rillig 7834: </li>
7835: <li>
7836: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7837: <p>Distfiles may not made available via FTP at no charge.
7838: In this case, set this variable to
7839: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7840: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7841: </li>
7842: </ul></div>
7843: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7844: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7845: generic make variables to denote restrictions is deprecated,
7846: because they unconditionally prevent users from generating
7847: binary packages!</p>
1.75 rillig 7848: </div>
7849: <div class="sect2" lang="en">
7850: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7851: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7852: <p>Your package may depend on some other package being present
1.88 wiz 7853: - and there are various ways of expressing this dependency.
7854: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7855: <code class="varname">DEPENDS</code> definitions, the
7856: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7857: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7858: to handle dependencies, and which uses the variables named above.
1.90 rillig 7859: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7860: <p>The basic difference between the two variables is as
1.87 wiz 7861: follows: The <code class="varname">DEPENDS</code> definition registers
7862: that pre-requisite in the binary package so it will be pulled in
7863: when the binary package is later installed, whilst the
7864: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7865: dependency that is only needed for building the package.</p>
1.75 rillig 7866: <p>This means that if you only need a package present whilst
1.87 wiz 7867: you are building, it should be noted as a
7868: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7869: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7870: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7871: <pre class="programlisting">
1.100 rillig 7872: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7873: </pre>
1.75 rillig 7874: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7875: may include any of the wildcard version numbers recognized by
7876: <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>
1.75 rillig 7877: <div class="orderedlist"><ol type="1">
7878: <li>
7879: <p>If your package needs another package's binaries or
1.87 wiz 7880: libraries to build or run, and if that package has a
7881: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7882: <pre class="programlisting">
1.100 rillig 7883: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7884: </pre>
1.75 rillig 7885: </li>
7886: <li>
7887: <p>If your package needs to use another package to build
1.87 wiz 7888: itself and there is no <code class="filename">buildlink3.mk</code>
7889: file available, use the <code class="varname">BUILD_DEPENDS</code>
7890: definition:</p>
1.75 rillig 7891: <pre class="programlisting">
1.100 rillig 7892: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7893: </pre>
1.75 rillig 7894: </li>
7895: <li>
7896: <p>If your package needs a library with which to link and
1.76 rillig 7897: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7898: available, this is specified using the
7899: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7900: <pre class="programlisting">
1.100 rillig 7901: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7902: </pre>
1.75 rillig 7903: <p>You can also use wildcards in package dependences:</p>
7904: <pre class="programlisting">
1.100 rillig 7905: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7906: </pre>
1.75 rillig 7907: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7908: creating binary packages. The dependency is checked when
7909: installing the binary package and any package which matches
7910: the pattern will be used. Wildcard dependencies should be
7911: used with care.</p>
1.75 rillig 7912: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7913: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7914: such as “<span class="quote">tk-postgresql</span>” matching a
7915: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7916: <p>Wildcards can also be used to specify that a package
1.87 wiz 7917: will only build against a certain minimum version of a
7918: pre-requisite:</p>
1.75 rillig 7919: <pre class="programlisting">
1.100 rillig 7920: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7921: </pre>
1.75 rillig 7922: <p>This means that the package will build against version
1.87 wiz 7923: 3.5.4 of the tiff library or newer. Such a dependency may
7924: be warranted if, for example, the API of the library has
7925: changed with version 3.5.4 and a package would not compile
7926: against an earlier version of tiff.</p>
1.75 rillig 7927: <p>Please note that such dependencies should only be
1.87 wiz 7928: updated if a package requires a newer pre-requisite, but
1.93 rillig 7929: not to denote recommendations such as
1.87 wiz 7930: ABI changes that do not prevent a package from building
7931: correctly. Such recommendations can be expressed using
7932: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7933: <pre class="programlisting">
1.100 rillig 7934: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7935: </pre>
1.75 rillig 7936: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7937: line, this denotes that while a package will build against
7938: tiff>=3.5.4, at least version 3.6.1 is recommended.
7939: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7940: dependencies unless explicitly ignored (in which case a
7941: warning will be printed).</p>
1.75 rillig 7942: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7943: use the required <code class="varname">DEPENDS</code>, set
7944: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7945: it easier and faster to update packages built using pkgsrc,
7946: since older compatible dependencies can continue to be
7947: used. This is useful for people who watch their rebuilds
7948: very carefully; it is not very good as a general-purpose
7949: hammer. If you use it, you need to be mindful of possible
7950: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7951: <p>Packages that are built with recommendations ignored
1.87 wiz 7952: may not be uploaded to ftp.NetBSD.org by developers and
7953: should not be used across different systems that may have
7954: different versions of binary packages installed.</p>
1.75 rillig 7955: <p>For security fixes, please update the package
1.90 rillig 7956: vulnerabilities file. See <a href="#security-handling" title="18.1.10. Handling packages with security problems">Section 18.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 7957: information.</p>
1.75 rillig 7958: </li>
7959: <li>
7960: <p>If your package needs some executable to be able to run
1.87 wiz 7961: correctly and if there's no
7962: <code class="filename">buildlink3.mk</code> file, this is specified
7963: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7964: <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
1.87 wiz 7965: be able to execute the latex binary from the teTeX package
7966: when it runs, and that is specified:</p>
1.75 rillig 7967: <pre class="programlisting">
1.100 rillig 7968: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7969: </pre>
1.75 rillig 7970: <p>The comment about wildcard dependencies from previous
1.87 wiz 7971: paragraph applies here, too.</p>
1.75 rillig 7972: </li>
7973: </ol></div>
7974: <p>If your package needs files from another package to build,
1.87 wiz 7975: add the relevant distribution files to
7976: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7977: 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.
1.87 wiz 7978: (It relies on the jpeg sources being present in source form
7979: during the build.)</p>
1.75 rillig 7980: </div>
7981: <div class="sect2" lang="en">
7982: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7983: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7984: <p>Your package may conflict with other packages a user might
1.87 wiz 7985: already have installed on his system, e.g. if your package
1.88 wiz 7986: installs the same set of files as another package in the pkgsrc
7987: tree.</p>
1.75 rillig 7988: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7989: space-separated list of packages (including version string) your
7990: package conflicts with.</p>
1.91 rillig 7991: <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>
7992: 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>
1.87 wiz 7993: install the same shared library, thus you set in
7994: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7995: <pre class="programlisting">
1.100 rillig 7996: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 7997: </pre>
7998: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7999: <pre class="programlisting">
1.100 rillig 8000: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8001: </pre>
1.75 rillig 8002: <p>Packages will automatically conflict with other packages
1.87 wiz 8003: with the name prefix and a different version
8004: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8005: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 8006: </div>
8007: <div class="sect2" lang="en">
8008: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8009: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8010: <p>There are several reasons why a package might be
1.88 wiz 8011: instructed to not build under certain circumstances. If the
1.87 wiz 8012: package builds and runs on most platforms, the exceptions
8013: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8014: the package builds and runs on a small handful of platforms,
8015: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8016: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8017: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8018: (OS-version-platform) that can use glob-style
8019: wildcards.</p>
1.88 wiz 8020: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8021: 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
1.88 wiz 8022: backwards compatible with other versions of the OS, and should be
8023: uploaded to a version specific directory on the FTP server. Mark
8024: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8025: “<span class="quote">yes</span>”. This variable is not currently used by any of
8026: the package system internals, but may be used in the
8027: future.</p>
1.75 rillig 8028: <p>If the package should be skipped (for example, because it
1.87 wiz 8029: provides functionality already provided by the system), set
1.88 wiz 8030: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8031: the package should fail because some preconditions are not met,
8032: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8033: message.</p>
1.75 rillig 8034: </div>
8035: <div class="sect2" lang="en">
8036: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8037: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8038: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8039: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8040: be set in the package Makefile. This will be carried into any
8041: binary package that is made from this pkgsrc entry. A
8042: “<span class="quote">preserved</span>” package will
8043: 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
8044: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8045: </div>
8046: <div class="sect2" lang="en">
8047: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8048: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8049: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8050: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8051: and after committing that file, use <span><strong class="command">make upload</strong></span>
8052: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8053: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8054: <code class="varname">PKGREVISION</code> should be increased (this
8055: is of course not necessary if the problem is fixed by using
8056: a newer release of the software).</p>
1.75 rillig 8057: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8058: branch, be sure to submit a pullup request!</p>
1.75 rillig 8059: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8060: semi-automatically by a weekly cron job.</p>
1.75 rillig 8061: </div>
8062: <div class="sect2" lang="en">
8063: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8064: <a name="bumping-pkgrevision"></a>18.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 8065: <p>When making fixes to an existing package it can be useful
1.87 wiz 8066: to change the version number in <code class="varname">PKGNAME</code>. To
8067: avoid conflicting with future versions by the original author, a
8068: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8069: on package versions by setting <code class="varname">PKGREVISION=1</code>
8070: (2, ...). The “<span class="quote">nb</span>” is treated like a
8071: “<span class="quote">.</span>” by the package tools. e.g.</p>
8072: <pre class="programlisting">
1.100 rillig 8073: DISTNAME= foo-17.42
8074: PKGREVISION= 9
1.87 wiz 8075: </pre>
1.75 rillig 8076: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8077: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8078: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8079: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8080: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8081: <p>When a new release of the package is released, the
1.87 wiz 8082: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8083: minor release of the above package, things should be like:</p>
1.75 rillig 8084: <pre class="programlisting">
1.100 rillig 8085: DISTNAME= foo-17.43
1.87 wiz 8086: </pre>
8087: <p><code class="varname">PKGREVISION</code> should be incremented for any
8088: non-trivial change in the resulting binary package. Without a
8089: <code class="varname">PKGREVISION</code> bump, someone with the previous
8090: version installed has no way of knowing that their package is out
8091: of date. Thus, changes without increasing
8092: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8093: trivial that no reasonable person would want to upgrade", and this
8094: is the rough test for when increasing
8095: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8096: changes that do not merit increasing
8097: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8098: <div class="itemizedlist"><ul type="disc">
8099: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8100: or comments in Makefile.</p></li>
8101: <li><p>
8102: Changing build variables if the resulting binary package is the same.</p></li>
8103: <li><p>
8104: Changing <code class="filename">DESCR</code>.</p></li>
8105: <li><p>
8106: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8107: </ul></div>
1.87 wiz 8108: <p>Examples of changes that do merit an increase to
8109: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8110: <div class="itemizedlist"><ul type="disc">
8111: <li><p>
8112: Security fixes</p></li>
8113: <li><p>
8114: Changes or additions to a patch file</p></li>
8115: <li><p>
8116: Changes to the <code class="filename">PLIST</code></p></li>
8117: </ul></div>
1.78 rillig 8118: <p>PKGREVISION must also be incremented when dependencies have ABI
8119: changes.</p>
1.75 rillig 8120: </div>
1.79 rillig 8121: <div class="sect2" lang="en">
8122: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8123: <a name="fixes.subst"></a>18.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8124: <p>When you want to replace the same text in multiple files
1.87 wiz 8125: or when the replacement text varies, patches alone cannot help.
8126: This is where the SUBST framework comes in. It provides an
8127: easy-to-use interface for replacing text in files.
8128: Example:</p>
8129: <pre class="programlisting">
1.100 rillig 8130: SUBST_CLASSES+= fix-paths
8131: SUBST_STAGE.fix-paths= pre-configure
8132: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8133: SUBST_FILES.fix-paths= src/*.c
8134: SUBST_FILES.fix-paths+= scripts/*.sh
8135: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8136: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8137: </pre>
1.79 rillig 8138: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8139: that are used to identify the different SUBST blocks that are
8140: defined. The SUBST framework is heavily used by pkgsrc, so it is
8141: important to always use the <code class="literal">+=</code> operator with
8142: this variable. Otherwise some substitutions may be
8143: skipped.</p>
1.79 rillig 8144: <p>The remaining variables of each SUBST block are
1.87 wiz 8145: parameterized with the identifier from the first line
8146: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8147: parameters to a function call.</p>
1.79 rillig 8148: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8149: which the replacement will take place. All combinations of
8150: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8151: <code class="literal">post-</code> together with a phase name are
8152: possible, though only few are actually used. Most commonly used
8153: are <code class="literal">post-patch</code> and
8154: <code class="literal">pre-configure</code>. Of these two,
8155: <code class="literal">pre-configure</code> should be preferred because
8156: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8157: have the state after applying the patches but before making any
8158: other changes. This is especially useful when you are debugging
8159: a package in order to create new patches for it. Similarly,
8160: <code class="literal">post-build</code> is preferred over
8161: <code class="literal">pre-install</code>, because the install phase should
8162: generally be kept as simple as possible. When you use
8163: <code class="literal">post-build</code>, you have the same files in the
8164: working directory that will be installed later, so you can check
8165: if the substitution has succeeded.</p>
1.79 rillig 8166: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8167: that is printed just before the substitution is done.</p>
1.79 rillig 8168: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8169: globbing patterns that specifies the files in which the
8170: substitution will take place. The patterns are interpreted
8171: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8172: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 8173: <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
8174: command should be prefixed with <code class="literal">-e</code>, so that
8175: all SUBST blocks look uniform.</p>
1.79 rillig 8176: <p>There are some more variables, but they are so seldomly
1.87 wiz 8177: used that they are only documented in the
8178: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8179: </div>
1.75 rillig 8180: </div>
8181: <div class="sect1" lang="en">
8182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8183: <a name="fixes.fetch"></a>18.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75 rillig 8184: <div class="sect2" lang="en">
8185: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8186: <a name="no-plain-download"></a>18.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8187: <p>If you need to download from a dynamic URL you can set
1.87 wiz 8188: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8189: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8190: with the name of each file to download as an argument, expecting
8191: it to output the URL of the directory from which to download
1.91 rillig 8192: 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
1.87 wiz 8193: example of this usage.</p>
1.75 rillig 8194: <p>If the download can't be automated, because the user must
1.87 wiz 8195: submit personal information to apply for a password, or must pay
8196: for the source, or whatever, you can set
8197: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8198: displayed to the user before aborting the build. Example:</p>
8199: <pre class="programlisting">
1.100 rillig 8200: FETCH_MESSAGE= "Please download the files"
8201: FETCH_MESSAGE+= " "${DISTFILES:Q}
8202: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8203: </pre>
1.75 rillig 8204: </div>
8205: <div class="sect2" lang="en">
8206: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8207: <a name="modified-distfiles-same-name"></a>18.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8208: <p>Sometimes authors of a software package make some
1.87 wiz 8209: modifications after the software was released, and they put up a
8210: new distfile without changing the package's version number. If a
8211: package is already in pkgsrc at that time, the checksum will
8212: no longer match. The contents of the new distfile should be
8213: compared against the old one before changing anything, to make
8214: sure the distfile was really updated on purpose, and that
8215: no trojan horse or so crept in.
1.97 rillig 8216: Please mention that the distfiles were compared and what was found
8217: in your commit message.
1.87 wiz 8218: Then, the correct way to work around this is to
8219: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8220: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8221: <code class="varname">DISTFILES</code> and
1.93 rillig 8222: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8223: subdirectory of the local distfiles directory.
8224: (See <a href="#bumping-pkgrevision" title="18.1.11. How to handle incrementing versions when fixing an existing package">Section 18.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
8225: In case this
1.87 wiz 8226: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8227: including the <code class="filename">nbX</code> suffix) or a date stamp
8228: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8229: Do not forget regenerating the <code class="filename">distinfo</code> file
8230: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8231: path in the filenames.
1.97 rillig 8232: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8233: Furthermore, a mail to the package's authors seems appropriate
8234: telling them that changing distfiles after releases without
8235: changing the file names is not good practice.</p>
1.75 rillig 8236: </div>
8237: </div>
8238: <div class="sect1" lang="en">
8239: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8240: <a name="fixes.configure"></a>18.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75 rillig 8241: <div class="sect2" lang="en">
8242: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8243: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8244: <p>pkgsrc supports many different machines, with different
1.87 wiz 8245: object formats like a.out and ELF, and varying abilities to do
8246: shared library and dynamic loading at all. To accompany this,
8247: varying commands and options have to be passed to the
8248: compiler, linker, etc. to get the Right Thing, which can be
8249: pretty annoying especially if you don't have all the machines
8250: at your hand to test things. The
1.91 rillig 8251: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87 wiz 8252: can help here, as it just “<span class="quote">knows</span>” how to build
8253: both static and dynamic libraries from a set of source files,
8254: thus being platform-independent.</p>
8255: <p>Here's how to use libtool in a package in seven simple
8256: steps:</p>
1.75 rillig 8257: <div class="orderedlist"><ol type="1">
8258: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8259: Makefile.</p></li>
1.75 rillig 8260: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8261: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8262: add it to the definition of <code class="varname">CC</code>, if only
8263: libraries are being built in a given Makefile. This one command
8264: will build both PIC and non-PIC library objects, so you need not
8265: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8266: <li>
8267: <p>For the linking of the library, remove any
1.87 wiz 8268: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8269: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8270: <pre class="programlisting">
1.100 rillig 8271: ${LIBTOOL} --mode=link \
8272: ${CC} -o ${.TARGET:.a=.la} \
8273: ${OBJS:.o=.lo} \
8274: -rpath ${PREFIX}/lib \
8275: -version-info major:minor
1.87 wiz 8276: </pre>
1.75 rillig 8277: <p>Note that the library is changed to have a
1.87 wiz 8278: <code class="filename">.la</code> extension, and the objects are
8279: changed to have a <code class="filename">.lo</code>
8280: extension. Change <code class="varname">OBJS</code> as
8281: necessary. This automatically creates all of the
8282: <code class="filename">.a</code>,
8283: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8284: necessary) in the build directory. Be sure to include
8285: “<span class="quote">-version-info</span>”, especially when major and
8286: minor are zero, as libtool will otherwise strip off the
8287: shared library version.</p>
1.75 rillig 8288: <p>From the libtool manual:</p>
8289: <pre class="programlisting">
1.100 rillig 8290: So, libtool library versions are described by three integers:
1.69 rillig 8291:
1.100 rillig 8292: CURRENT
8293: The most recent interface number that this library implements.
1.69 rillig 8294:
1.100 rillig 8295: REVISION
8296: The implementation number of the CURRENT interface.
1.69 rillig 8297:
1.100 rillig 8298: AGE
8299: The difference between the newest and oldest interfaces that
8300: this library implements. In other words, the library implements
8301: all the interface numbers in the range from number `CURRENT -
8302: AGE' to `CURRENT'.
1.1 grant 8303:
1.100 rillig 8304: If two libraries have identical CURRENT and AGE numbers, then the
8305: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8306: </pre>
1.75 rillig 8307: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8308: different results for a.out and ELF (excluding symlinks)
8309: in only one case. An ELF library of the form
8310: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8311: will have a symlink of
8312: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8313: on an a.out platform. This is handled
8314: automatically.</p>
1.75 rillig 8315: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8316: directory of the library being built.</p>
1.76 rillig 8317: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8318: <code class="filename">.la</code> file, the other files will be
8319: added automatically.</p>
1.75 rillig 8320: </li>
8321: <li>
1.76 rillig 8322: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8323: 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
8324: shared libraries, use “<span class="quote">-module
8325: -avoid-version</span>” to prevent them getting version
8326: tacked on.</p>
1.76 rillig 8327: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8328: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8329: </li>
8330: <li>
8331: <p>When linking programs that depend on these libraries
1.87 wiz 8332: <span class="emphasis"><em>before</em></span> they are installed, preface
8333: 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}
8334: --mode=link</span>”, and it will find the correct
8335: libraries (static or shared), but please be aware that
8336: libtool will not allow you to specify a relative path in
8337: -L (such as “<span class="quote">-L../somelib</span>”), because it
8338: expects you to change that argument to be the
8339: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8340: <pre class="programlisting">
1.100 rillig 8341: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8342: </pre>
1.75 rillig 8343: <p>should be changed to:</p>
8344: <pre class="programlisting">
1.100 rillig 8345: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8346: </pre>
1.75 rillig 8347: <p>and it will do the right thing with the libraries.</p>
8348: </li>
8349: <li>
8350: <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>
1.87 wiz 8351: 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}
8352: --mode=install</span>”, and change the library name to
8353: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8354: <pre class="programlisting">
1.100 rillig 8355: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8356: </pre>
1.76 rillig 8357: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8358: shared library, any needed symlinks, and run
8359: <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>
1.75 rillig 8360: </li>
1.76 rillig 8361: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8362: the <code class="filename">.la</code>
8363: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8364: </ol></div>
8365: </div>
8366: <div class="sect2" lang="en">
8367: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8368: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8369: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8370: package Makefile. This will override the package's own libtool
8371: in most cases. For older libtool using packages, libtool is
8372: made by ltconfig script during the do-configure step; you can
8373: check the libtool script location by doing <span><strong class="command">make
8374: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8375: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8376: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8377: default, it is set to “<span class="quote">libtool */libtool
8378: */*/libtool</span>”. If this does not match the location of the
8379: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8380: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8381: libraries built and installed, then use
8382: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8383: <p>If your package makes use of the platform-independent library
1.87 wiz 8384: for loading dynamic shared objects, that comes with libtool
8385: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8386: <p>Some packages use libtool incorrectly so that the package
8387: may not work or build in some circumstances. Some of the more
8388: common errors are:</p>
1.75 rillig 8389: <div class="itemizedlist"><ul type="disc">
8390: <li>
8391: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8392: executable or library. This in itself isn't a problem if one of two things
8393: has been done:</p>
1.75 rillig 8394: <div class="orderedlist"><ol type="1">
8395: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8396: <code class="filename">libfoo.la</code>, not
8397: <code class="filename">foo.la</code></p></li>
1.75 rillig 8398: <li><p>The -dlopen option is used when linking an executable.</p></li>
8399: </ol></div>
8400: </li>
8401: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8402: The function lt_dlinit() should be called and the macro
8403: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8404: executables.</p></li>
1.75 rillig 8405: </ul></div>
8406: </div>
8407: <div class="sect2" lang="en">
8408: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8409: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8410: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8411: to regenerate the configure script and Makefile.in makefile
8412: templates, then they should be executed in a pre-configure
8413: target.</p>
1.75 rillig 8414: <p>For packages that need only autoconf:</p>
8415: <pre class="programlisting">
1.100 rillig 8416: AUTOCONF_REQD= 2.50 # if default version is not good enough
8417: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8418: ...
1.1 grant 8419:
1.100 rillig 8420: pre-configure:
8421: cd ${WRKSRC} && autoconf
1.1 grant 8422:
1.100 rillig 8423: ...
1.87 wiz 8424: </pre>
1.75 rillig 8425: <p>and for packages that need automake and autoconf:</p>
8426: <pre class="programlisting">
1.100 rillig 8427: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8428: USE_TOOLS+= automake # use "automake14" for automake-1.4
8429: ...
8430:
8431: pre-configure:
8432: set -e; cd ${WRKSRC}; \
8433: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8434:
1.100 rillig 8435: ...
1.87 wiz 8436: </pre>
1.75 rillig 8437: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8438: require GNU Make.</p>
1.75 rillig 8439: <p>There are times when the configure process makes
1.87 wiz 8440: additional changes to the generated files, which then causes
8441: the build process to try to re-execute the automake sequence.
8442: This is prevented by touching various files in the configure
8443: stage. If this causes problems with your package you can set
8444: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8445: Makefile.</p>
1.75 rillig 8446: </div>
8447: </div>
8448: <div class="sect1" lang="en">
8449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8450: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8451: <div class="sect2" lang="en">
8452: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8453: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8454: <p>Compilers for the C, C++, and Fortran languages comes with
8455: the NetBSD base system. By default, pkgsrc assumes that a package
8456: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8457: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8458: <p>To declare which language's compiler a package needs, set
8459: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8460: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8461: “<span class="quote">fortran</span>” (and any combination). The default is
8462: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8463: written in C++, usually need a C compiler for the configure
8464: phase.</p>
8465: </div>
8466: <div class="sect2" lang="en">
8467: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8468: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8469: <p>If a program is written in Java, use the Java framework in
8470: pkgsrc. The package must include
8471: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8472: provides the following variables:</p>
8473: <div class="itemizedlist"><ul type="disc">
8474: <li><p><code class="varname">USE_JAVA</code> defines if a build
8475: dependency on the JDK is added. If
8476: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8477: there is only a runtime dependency on the JDK. The default is
8478: “<span class="quote">yes</span>”, which also adds a build dependency on the
8479: JDK.</p></li>
8480: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8481: a package needs a Java2 implementation. The supported values
8482: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8483: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8484: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8485: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8486: above. This variable is not set by default.</p></li>
8487: </ul></div>
8488: </div>
8489: <div class="sect2" lang="en">
8490: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8491: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8492: <p>If your package contains interpreted perl scripts, add
8493: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8494: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8495: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8496: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8497: that you want adjusted. Every occurrence of
8498: <code class="filename">*/bin/perl</code> will be replaced with the full
8499: path to the perl executable.</p>
8500: <p>If a particular version of perl is needed, set the
8501: <code class="varname">PERL5_REQD</code> variable to the version number. The
8502: default is “<span class="quote">5.0</span>”.</p>
1.103 wiz 8503: <p>See <a href="#perl-modules" title="18.6.6. Packages installing perl modules">Section 18.6.6, “Packages installing perl modules”</a> for information
1.87 wiz 8504: about handling perl modules.</p>
8505: </div>
8506: <div class="sect2" lang="en">
8507: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8508: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8509: <p>Currently, there is no special handling for other languages
8510: in pkgsrc. If a compiler package provides a
8511: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8512: just add a (build) dependency on the appropriate compiler
8513: package.</p>
8514: </div>
8515: </div>
8516: <div class="sect1" lang="en">
8517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8518: <a name="fixes.build"></a>18.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8519: <p>The most common failures when building a package are that
8520: some platforms do not provide certain header files, functions or
8521: libraries, or they provide the functions in a library that the
8522: original package author didn't know. To work around this, you
8523: can rewrite the source code in most cases so that it does not
8524: use the missing functions or provides a replacement function.</p>
8525: <div class="sect2" lang="en">
8526: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8527: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8528: <p>If a package already comes with a GNU configure script, the
8529: preferred way to fix the build failure is to change the
8530: configure script, not the code. In the other cases, you can
8531: utilize the C preprocessor, which defines certain macros
8532: depending on the operating system and hardware architecture it
8533: compiles for. These macros can be queried using for example
8534: <code class="varname">#if defined(__i386)</code>. Almost every operating
8535: system, hardware architecture and compiler has its own macro.
8536: For example, if the macros <code class="varname">__GNUC__</code>,
8537: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8538: are all defined, you know that you are using NetBSD on an i386
8539: compatible CPU, and your compiler is GCC.</p>
8540: <p>The list of the following macros for hardware and
8541: operating system depends on the compiler that is used. For
8542: example, if you want to conditionally compile code on Solaris,
8543: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8544: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8545: <div class="sect3" lang="en">
8546: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8547: <a name="fixes.build.cpp.os"></a>18.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8548: <p>To distinguish between 4.4 BSD-derived systems and the
8549: rest of the world, you should use the following code.</p>
8550: <pre class="programlisting">
1.100 rillig 8551: #include <sys/param.h>
8552: #if (defined(BSD) && BSD >= 199306)
8553: /* BSD-specific code goes here */
8554: #else
8555: /* non-BSD-specific code goes here */
8556: #endif
1.75 rillig 8557: </pre>
1.77 rillig 8558: <p>If this distinction is not fine enough, you can also test
8559: for the following macros.</p>
1.75 rillig 8560: <pre class="programlisting">
1.100 rillig 8561: FreeBSD __FreeBSD__
8562: DragonFly __DragonFly__
8563: Interix __INTERIX
8564: IRIX __sgi (TODO: get a definite source for this)
8565: Linux linux, __linux, __linux__
8566: NetBSD __NetBSD__
8567: OpenBSD __OpenBSD__
8568: Solaris sun, __sun
1.75 rillig 8569: </pre>
8570: </div>
8571: <div class="sect3" lang="en">
8572: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8573: <a name="fixes.build.cpp.arch"></a>18.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8574: <pre class="programlisting">
1.100 rillig 8575: i386 i386, __i386, __i386__
8576: MIPS __mips
8577: SPARC sparc, __sparc
1.75 rillig 8578: </pre>
8579: </div>
8580: <div class="sect3" lang="en">
8581: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8582: <a name="fixes.build.cpp.compiler"></a>18.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8583: <pre class="programlisting">
1.100 rillig 8584: GCC __GNUC__ (major version), __GNUC_MINOR__
8585: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8586: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8587: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8588: </pre>
8589: </div>
8590: </div>
1.78 rillig 8591: <div class="sect2" lang="en">
8592: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8593: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8594: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8595: combinations of compiler version and architecture and almost
8596: always relation to optimisation being enabled. Common symptoms
8597: are gcc internal errors or never finishing compiling a
1.78 rillig 8598: file.</p>
8599: <p>Typically, a workaround involves testing the
8600: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8601: optimisation for that combination of file,
8602: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8603: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8604: number of examples.</p>
8605: </div>
8606: <div class="sect2" lang="en">
8607: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8608: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8609: <p>This error message often means that a package did not
1.78 rillig 8610: link to a shared library it needs. The following functions are
8611: known to cause this error message over and over.</p>
8612: <div class="informaltable">
8613: <a name="undefined-reference-functions"></a><table border="1">
8614: <colgroup>
8615: <col>
8616: <col>
8617: <col>
8618: </colgroup>
8619: <thead><tr>
8620: <th>Function</th>
8621: <th>Library</th>
8622: <th>Affected platforms</th>
8623: </tr></thead>
8624: <tbody>
8625: <tr>
8626: <td>accept, bind, connect</td>
8627: <td>-lsocket</td>
8628: <td>Solaris</td>
8629: </tr>
8630: <tr>
8631: <td>crypt</td>
8632: <td>-lcrypt</td>
8633: <td>DragonFly, NetBSD</td>
8634: </tr>
8635: <tr>
8636: <td>dlopen, dlsym</td>
8637: <td>-ldl</td>
8638: <td>Linux</td>
8639: </tr>
8640: <tr>
8641: <td>gethost*</td>
8642: <td>-lnsl</td>
8643: <td>Solaris</td>
8644: </tr>
8645: <tr>
8646: <td>inet_aton</td>
8647: <td>-lresolv</td>
8648: <td>Solaris</td>
8649: </tr>
8650: <tr>
8651: <td>nanosleep, sem_*, timer_*</td>
8652: <td>-lrt</td>
8653: <td>Solaris</td>
8654: </tr>
8655: <tr>
8656: <td>openpty</td>
8657: <td>-lutil</td>
8658: <td>Linux</td>
8659: </tr>
8660: </tbody>
8661: </table>
8662: </div>
8663: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8664: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8665: -l<em class="replaceable"><code>foo</code></em></code> to the package
8666: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8667: bmake</strong></span>.</p>
1.92 rillig 8668: <div class="sect3" lang="en">
8669: <div class="titlepage"><div><div><h4 class="title">
8670: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8671: <p>When you are using the SunPro compiler, there is another
8672: possibility. That compiler cannot handle the following code:</p>
8673: <pre class="programlisting">
1.100 rillig 8674: extern int extern_func(int);
1.93 rillig 8675:
1.100 rillig 8676: static inline int
8677: inline_func(int x)
8678: {
1.92 rillig 8679: return extern_func(x);
1.100 rillig 8680: }
1.93 rillig 8681:
1.100 rillig 8682: int main(void)
8683: {
1.92 rillig 8684: return 0;
1.100 rillig 8685: }
1.92 rillig 8686: </pre>
8687: <p>It generates the code for <code class="function">inline_func</code> even if
8688: that function is never used. This code then refers to
8689: <code class="function">extern_func</code>, which can usually not be resolved. To
8690: solve this problem you can try to tell the package to disable inlining
8691: of functions.</p>
8692: </div>
1.87 wiz 8693: </div>
8694: <div class="sect2" lang="en">
8695: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8696: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8697: <p>Sometimes packages fail to build because the compiler runs
8698: into an operating system specific soft limit. With the
8699: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8700: to unlimit the resources. Currently, the allowed values are
8701: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8702: Setting this variable is similar to running the shell builtin
8703: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8704: segment size or maximum stack size of a process, respectively, to
8705: their hard limits.</p>
1.78 rillig 8706: </div>
1.75 rillig 8707: </div>
8708: <div class="sect1" lang="en">
8709: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8710: <a name="fixes.install"></a>18.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 8711: <div class="sect2" lang="en">
8712: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8713: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8714: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8715: with some operating systems cannot create more than one
8716: directory at a time. As such, you should call
8717: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8718: <pre class="programlisting">
1.100 rillig 8719: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8720: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8721: </pre>
1.78 rillig 8722: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8723: dir2</code></span>” to the
8724: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8725: automatically do the right thing.</p>
1.75 rillig 8726: </div>
8727: <div class="sect2" lang="en">
8728: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8729: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8730: <p>In general, documentation should be installed into
1.87 wiz 8731: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8732: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8733: includes the version number of the package).</p>
1.84 wiz 8734: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8735: directory where HTML documentation is installed with the
8736: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8737: is needed because otherwise the documentation ends up in
8738: <code class="filename">${PREFIX}/share/doc/html</code> or other
8739: places.</p>
8740: <p>An exception to the above is that library API documentation
1.91 rillig 8741: 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
1.87 wiz 8742: browsers (devhelp) should be left at their default location, which
8743: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8744: documentation can be recognized from files ending in
8745: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8746: (It is also acceptable to install such files in
8747: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8748: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8749: <code class="filename">.devhelp*</code> file must be directly in that
8750: directory then, no additional subdirectory level is allowed in
8751: this case. This is usually achieved by using
8752: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8753: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8754: though.)</p>
1.75 rillig 8755: </div>
8756: <div class="sect2" lang="en">
8757: <div class="titlepage"><div><div><h3 class="title">
1.100 rillig 8758: <a name="installing-score-files"></a>18.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8759: <p>Certain packages, most of them in the games category, install
1.87 wiz 8760: a score file that allows all users on the system to record their
8761: highscores. In order for this to work, the binaries need to be
8762: installed setgid and the score files owned by the appropriate
8763: group and/or owner (traditionally the "games" user/group). The
8764: following variables, documented in more detail in
8765: <code class="filename">mk/defaults/mk.conf</code>, control this
8766: behaviour: <code class="varname">SETGIDGAME</code>,
8767: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8768: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8769: <p>Note that per default, setgid installation of games is
1.87 wiz 8770: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8771: the other variables accordingly.</p>
1.75 rillig 8772: <p>A package should therefor never hard code file ownership or
1.87 wiz 8773: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8774: <code class="varname">INSTALL_GAME_DATA</code> to set these
8775: correctly.</p>
1.75 rillig 8776: </div>
8777: <div class="sect2" lang="en">
8778: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8779: <a name="destdir-support"></a>18.6.4. Adding DESTDIR support to packages</h3></div></div></div>
8780: <div class="itemizedlist"><ul type="disc">
8781: <li><p>All installation operations have to be prefixed with
8782: <code class="filename">${DESTDIR}</code>.</p></li>
8783: <li><p>automake gets this DESTDIR mostly right
8784: automatically. Many manual rules and pre/post-install often are
8785: incorrect; fix them.</p></li>
8786: <li><p>If files are installed with special owner/group
8787: either use @owner/@group in the <code class="filename">PLIST</code>
8788: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8789: (discouraged). Note that @owner/@group are sticky during
8790: install, keep this in mind.</p></li>
8791: <li><p>In general, packages should support
8792: <code class="varname">UNPRIVILEGED</code> to be able to use
8793: DESTDIR.</p></li>
8794: </ul></div>
8795: </div>
8796: <div class="sect2" lang="en">
8797: <div class="titlepage"><div><div><h3 class="title">
8798: <a name="hardcoded-paths"></a>18.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8799: <p>Your package may also contain scripts with hardcoded paths to
8800: other interpreters besides (or as well as) perl. To correct the
8801: full pathname to the script interpreter, you need to set the
8802: following definitions in your <code class="filename">Makefile</code> (we
8803: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8804: <pre class="programlisting">
1.100 rillig 8805: REPLACE_INTERPRETER+= tcl
8806: REPLACE.tcl.old= .*/bin/tclsh
8807: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8808: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8809: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8810: </pre>
1.75 rillig 8811: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8812: <h3 class="title">Note</h3>
8813: <p>Before March 2006, these variables were called
1.87 wiz 8814: <code class="varname">_REPLACE.*</code> and
8815: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8816: </div>
8817: </div>
8818: <div class="sect2" lang="en">
8819: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8820: <a name="perl-modules"></a>18.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8821: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8822: the Makefile fragment
8823: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8824: <span><strong class="command">do-configure</strong></span> target for the standard perl
8825: configuration for such modules as well as various hooks to tune
8826: this configuration. See comments in this file for
8827: details.</p>
1.75 rillig 8828: <p>Perl5 modules will install into different places depending
1.87 wiz 8829: on the version of perl used during the build process. To
8830: address this, pkgsrc will append lines to the
8831: <code class="filename">PLIST</code> corresponding to the files listed in
8832: the installed <code class="filename">.packlist</code> file generated by
8833: most perl5 modules. This is invoked by defining
8834: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8835: paths to packlist files, e.g.:</p>
1.75 rillig 8836: <pre class="programlisting">
1.100 rillig 8837: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8838: </pre>
1.75 rillig 8839: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8840: <code class="varname">PERL5_SITEARCH</code>, and
8841: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8842: in which perl5 modules may be installed, and may be used by
8843: perl5 packages that don't have a packlist. These three
8844: variables are also substituted for in the
8845: <code class="filename">PLIST</code>.</p>
1.75 rillig 8846: </div>
8847: <div class="sect2" lang="en">
8848: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8849: <a name="faq.info-files"></a>18.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8850: <p>Some packages install info files or use the
1.87 wiz 8851: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8852: commands. <code class="varname">INFO_FILES</code> should be defined in
8853: the package Makefile so that <code class="filename">INSTALL</code> and
8854: <code class="filename">DEINSTALL</code> scripts will be generated to
8855: handle registration of the info files in the Info directory
8856: file. The “<span class="quote">install-info</span>” command used for the info
8857: files registration is either provided by the system, or by a
8858: special purpose package automatically added as dependency if
8859: needed.</p>
1.75 rillig 8860: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8861: <code class="filename">${PREFIX}</code> where info files are primarily
8862: located. <code class="varname">PKGINFODIR</code> defaults to
8863: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8864: <p>The info files for the package should be listed in the
1.87 wiz 8865: package <code class="filename">PLIST</code>; however any split info files
8866: need not be listed.</p>
1.75 rillig 8867: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8868: at build time must add “<span class="quote">makeinfo</span>” to
8869: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8870: version of the “<span class="quote">makeinfo</span>” command is needed it
8871: should be noted with the <code class="varname">TEXINFO_REQD</code>
8872: variable in the package <code class="filename">Makefile</code>. By
8873: default, a minimum version of 3.12 is required. If the system
8874: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8875: does not match the required minimum, a build dependency on the
1.91 rillig 8876: <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
1.87 wiz 8877: be added automatically.</p>
1.75 rillig 8878: <p>The build and installation process of the software provided
1.87 wiz 8879: by the package should not use the
8880: <span><strong class="command">install-info</strong></span> command as the registration of
8881: info files is the task of the package
8882: <code class="filename">INSTALL</code> script, and it must use the
8883: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8884: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8885: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8886: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8887: in <code class="varname">PATH</code>.</p>
1.75 rillig 8888: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8889: no effect except the logging of a message. The script overriding
8890: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8891: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8892: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8893: </div>
8894: <div class="sect2" lang="en">
8895: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8896: <a name="manpages"></a>18.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8897: <p>All packages that install manual pages should install them
1.87 wiz 8898: into the same directory, so that there is one common place to look
8899: for them. In pkgsrc, this place is
8900: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8901: should be used in packages. The default for
8902: <code class="varname">PKGMANDIR</code> is
8903: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8904: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8905: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8906: <h3 class="title">Note</h3>
1.87 wiz 8907: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8908: is far from complete.</p>
1.75 rillig 8909: </div>
1.81 rillig 8910: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8911: <code class="filename">man/</code> as the top level directory for the man
8912: page file entries, and the pkgsrc framework will convert as
8913: needed. In all other places, the correct
8914: <code class="varname">PKGMANDIR</code> must be used.</p>
8915: <p>Packages that are
8916: configured with <code class="varname">GNU_CONFIGURE</code> set as
8917: “<span class="quote">yes</span>”, by default will use the
8918: <code class="filename">./configure</code>
8919: --mandir switch to set where the man pages should be installed.
8920: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8921: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8922: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8923: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8924: to “<span class="quote">no</span>”.
8925: Or if the <code class="filename">./configure</code> script uses
8926: a non-standard use of --mandir, you can set
8927: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8928: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8929: information on installation of compressed manual pages.</p>
1.75 rillig 8930: </div>
8931: <div class="sect2" lang="en">
8932: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8933: <a name="gconf2-data-files"></a>18.6.9. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8934: <p>If a package installs <code class="filename">.schemas</code> or
8935: <code class="filename">.entries</code> files, used by GConf2,
8936: you need to take some extra steps to make sure they get registered
8937: in the database:</p>
1.75 rillig 8938: <div class="orderedlist"><ol type="1">
1.76 rillig 8939: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8940: instead of its <code class="filename">buildlink3.mk</code> file. This
8941: takes care of rebuilding the GConf2 database at installation and
8942: deinstallation time, and tells the package where to install
8943: GConf2 data files using some standard configure arguments. It
8944: also disallows any access to the database directly from the
8945: package.</p></li>
1.75 rillig 8946: <li><p>Ensure that the package installs its
1.87 wiz 8947: <code class="filename">.schemas</code> files under
8948: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8949: installed under <code class="filename">${PREFIX}/etc</code>, you will
8950: need to manually patch the package.</p></li>
1.75 rillig 8951: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8952: directory, as they will be handled automatically. See
1.103 wiz 8953: <a href="#faq.conf" title="8.13. How do I change the location of configuration files?">Section 8.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.75 rillig 8954: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 8955: your <code class="filename">Makefile</code> with a list of all
8956: <code class="filename">.schemas</code> files installed by the package, if
8957: any. Names must not contain any directories in them.</p></li>
1.75 rillig 8958: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 8959: your <code class="filename">Makefile</code> with a
8960: list of all <code class="filename">.entries</code> files installed by the
8961: package, if any. Names must not contain any directories in
8962: them.</p></li>
1.75 rillig 8963: </ol></div>
8964: </div>
8965: <div class="sect2" lang="en">
8966: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8967: <a name="scrollkeeper-data-files"></a>18.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8968: <p>If a package installs <code class="filename">.omf</code> files, used by
8969: scrollkeeper, you need to take some extra steps to make sure they
8970: get registered in the database:</p>
1.75 rillig 8971: <div class="orderedlist"><ol type="1">
8972: <li><p>Include
1.87 wiz 8973: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8974: instead of its <code class="filename">buildlink3.mk</code> file. This
8975: takes care of rebuilding the scrollkeeper database at
8976: installation and deinstallation time, and disallows any access
8977: to it directly from the package.</p></li>
1.75 rillig 8978: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8979: <code class="filename">libdata/scrollkeeper</code> directory, as they
8980: will be handled automatically.</p></li>
1.76 rillig 8981: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8982: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8983: </ol></div>
8984: </div>
8985: <div class="sect2" lang="en">
8986: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8987: <a name="x11-fonts"></a>18.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8988: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8989: the fonts database in the directory where they get installed at
8990: installation and deinstallation time. This can be automatically
8991: done by using the pkginstall framework.</p>
1.75 rillig 8992: <p>You can list the directories where fonts are installed in the
1.87 wiz 8993: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8994: variables, where <em class="replaceable"><code>type</code></em> can be one of
8995: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8996: Also make sure that the database file
8997: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8998: <p>Note that you should not create new directories for fonts;
1.87 wiz 8999: instead use the standard ones to avoid that the user needs to
9000: manually configure his X server to find them.</p>
1.75 rillig 9001: </div>
9002: <div class="sect2" lang="en">
9003: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9004: <a name="gtk2-modules"></a>18.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9005: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9006: take some extra steps to get them registered in the GTK2 database
9007: properly:</p>
1.75 rillig 9008: <div class="orderedlist"><ol type="1">
9009: <li><p>Include
1.87 wiz 9010: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9011: <code class="filename">buildlink3.mk</code> file. This takes care of
9012: rebuilding the database at installation and deinstallation time.</p></li>
9013: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9014: your package installs GTK2 immodules.</p></li>
9015: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9016: GTK2 loaders.</p></li>
1.75 rillig 9017: <li>
1.87 wiz 9018: <p>Patch the package to not touch any of the GTK2
9019: databases directly. These are:</p>
1.75 rillig 9020: <div class="itemizedlist"><ul type="disc">
1.76 rillig 9021: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9022: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9023: </ul></div>
9024: </li>
1.87 wiz 9025: <li><p>Check the <code class="filename">PLIST</code> and remove
9026: any entries under the <code class="filename">libdata/gtk-2.0</code>
9027: directory, as they will be handled automatically.</p></li>
1.75 rillig 9028: </ol></div>
9029: </div>
9030: <div class="sect2" lang="en">
9031: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9032: <a name="sgml-xml-data"></a>18.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9033: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9034: registered in system-wide catalogs (like DTDs, sub-catalogs,
9035: etc.), you need to take some extra steps:</p>
1.75 rillig 9036: <div class="orderedlist"><ol type="1">
9037: <li><p>Include
1.87 wiz 9038: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9039: your <code class="filename">Makefile</code>, which takes care of
9040: registering those files in system-wide catalogs at
9041: installation and deinstallation time.</p></li>
1.75 rillig 9042: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9043: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9044: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9045: any XML catalogs installed by the package.</p></li>
1.75 rillig 9046: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9047: to be added to the SGML catalog. These come in groups of
9048: three strings; see xmlcatmgr(1) for more information
9049: (specifically, arguments recognized by the 'add' action).
9050: Note that you will normally not use this variable.</p></li>
1.75 rillig 9051: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9052: to be added to the XML catalog. These come in groups of three
9053: strings; see xmlcatmgr(1) for more information (specifically,
9054: arguments recognized by the 'add' action). Note that you will
9055: normally not use this variable.</p></li>
1.75 rillig 9056: </ol></div>
9057: </div>
9058: <div class="sect2" lang="en">
9059: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9060: <a name="mime-database"></a>18.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9061: <p>If a package provides extensions to the MIME database by
1.87 wiz 9062: installing <code class="filename">.xml</code> files inside
9063: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9064: need to take some extra steps to ensure that the database is kept
9065: consistent with respect to these new files:</p>
1.75 rillig 9066: <div class="orderedlist"><ol type="1">
9067: <li><p>Include
1.87 wiz 9068: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9069: (avoid using the <code class="filename">buildlink3.mk</code> file from
9070: this same directory, which is reserved for inclusion from
9071: other <code class="filename">buildlink3.mk</code> files). It takes
9072: care of rebuilding the MIME database at installation and
9073: deinstallation time, and disallows any access to it directly
9074: from the package.</p></li>
1.75 rillig 9075: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9076: <code class="filename">share/mime</code> directory,
9077: <span class="emphasis"><em>except</em></span> for files saved under
9078: <code class="filename">share/mime/packages</code>. The former are
9079: handled automatically by
9080: the update-mime-database program, but the latter are
9081: package-dependent and must be removed by the package that
9082: installed them in the first place.</p></li>
1.76 rillig 9083: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9084: from the PLIST. They will be handled by the shared-mime-info
9085: package.</p></li>
1.75 rillig 9086: </ol></div>
9087: </div>
9088: <div class="sect2" lang="en">
9089: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9090: <a name="intltool"></a>18.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9091: <p>If a package uses intltool during its build, add
9092: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9093: which forces it to use the intltool package provided by pkgsrc,
9094: instead of the one bundled with the distribution file.</p>
1.75 rillig 9095: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9096: latest available version; this way, the package benefits of any
9097: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9098: </div>
9099: <div class="sect2" lang="en">
9100: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9101: <a name="startup-scripts"></a>18.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9102: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9103: the startup directory by default, but you can enable it, by adding
9104: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.104 rillig 9105: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9106: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9107: it will automatically remove the scripts when the package is
9108: deinstalled.</p>
1.75 rillig 9109: </div>
9110: <div class="sect2" lang="en">
9111: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9112: <a name="tex-packages"></a>18.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9113: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9114: the <code class="filename">ls-R</code> database of the tree needs to be
9115: updated.</p>
1.75 rillig 9116: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9117: <h3 class="title">Note</h3>
9118: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 9119: packages should install files
9120: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9121: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 9122: </div>
9123: <div class="orderedlist"><ol type="1">
9124: <li><p>Include
1.87 wiz 9125: <code class="filename">../../print/teTeX/module.mk</code> instead
9126: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9127: takes care of rebuilding the <code class="filename">ls-R</code>
9128: database at installation and deinstallation time.</p></li>
1.75 rillig 9129: <li>
9130: <p>If your package installs files into a texmf
1.87 wiz 9131: tree other than the one
9132: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9133: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9134: trees that need database update.</p>
1.75 rillig 9135: <p>If your package also installs font map files that need
1.87 wiz 9136: to be registered using <span><strong class="command">updmap</strong></span>,
9137: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9138: such font map files. Then <span><strong class="command">updmap</strong></span> will
9139: be run automatically at installation/deinstallation to
9140: enable/disable font map files for TeX output
9141: drivers.</p>
1.75 rillig 9142: </li>
1.76 rillig 9143: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9144: databases are included in <code class="filename">PLIST</code>, as
9145: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9146: </ol></div>
9147: </div>
1.85 jmmv 9148: <div class="sect2" lang="en">
9149: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9150: <a name="emulation-packages"></a>18.6.18. Packages supporting running binaries in
1.87 wiz 9151: emulation</h3></div></div></div>
9152: <p>There are some packages that provide libraries and
9153: executables for running binaries from a one operating system
9154: on a different one (if the latter supports it). One example
9155: is running Linux binaries on NetBSD.</p>
1.91 rillig 9156: <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>
1.87 wiz 9157: helps in extracting and packaging Linux rpm packages.</p>
9158: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9159: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9160: if all libraries for each installed executable can be found by
9161: the dynamic linker. Since the standard dynamic linker is run,
9162: this fails for emulation packages, because the libraries used
9163: by the emulation are not in the standard directories.</p>
9164: </div>
9165: <div class="sect2" lang="en">
9166: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9167: <a name="hicolor-theme"></a>18.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9168: <p>If a package installs images under the
1.87 wiz 9169: <code class="filename">share/icons/hicolor</code> and/or updates the
9170: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9171: database, you need to take some extra steps to make sure that the
9172: shared theme directory is handled appropriately and that the cache
9173: database is rebuilt:</p>
1.85 jmmv 9174: <div class="orderedlist"><ol type="1">
9175: <li><p>Include
1.87 wiz 9176: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9177: <li><p>Check the <code class="filename">PLIST</code> and remove the
9178: entry that refers to the theme cache.</p></li>
1.85 jmmv 9179: <li><p>Ensure that the PLIST does not remove the shared icon
9180: directories from the <code class="filename">share/icons/hicolor</code>
9181: hierarchy because they will be handled automatically.</p></li>
9182: </ol></div>
9183: <p>The best way to verify that the PLIST is correct with
9184: respect to the last two points is to regenerate it using
9185: <span><strong class="command">make print-PLIST</strong></span>.</p>
9186: </div>
9187: <div class="sect2" lang="en">
9188: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9189: <a name="desktop-files"></a>18.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9190: <p>If a package installs <code class="filename">.desktop</code> files
9191: under <code class="filename">share/applications</code> and these include
9192: MIME information, you need to take extra steps to ensure that they
9193: are registered into the MIME database:</p>
9194: <div class="orderedlist"><ol type="1">
9195: <li><p>Include
9196: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9197: <li><p>Check the PLIST and remove the entry that refers to the
9198: <code class="filename">share/applications/mimeinfo.cache</code> file.
9199: It will be handled automatically.</p></li>
9200: </ol></div>
9201: <p>The best way to verify that the PLIST is correct with
9202: respect to the last point is to regenerate it using <span><strong class="command">make
9203: print-PLIST</strong></span>.</p>
1.75 rillig 9204: </div>
9205: </div>
1.87 wiz 9206: <div class="sect1" lang="en">
9207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9208: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9209: <p>In some cases one does not have the time to solve a problem
9210: immediately. There are currently two ways to declare that one knows
9211: that a package has problems.</p>
9212: <div class="itemizedlist"><ul type="disc">
9213: <li><p>The first way is to plainly mark it as broken. For
9214: this, one just sets the variable <code class="varname">BROKEN</code> to the
9215: reason why the package is broken (similar to the
9216: <code class="varname">RESTRICTED</code> variable). A user trying to build
9217: the package will immediately be shown this message, and the build
9218: will not be even tried.</p></li>
9219: <li><p>After each pkgsrc freeze period (a time when the
9220: tree is stabilized and a new pkgsrc branch is cut), the packages
9221: that were not building in the official branch build on the latest
9222: NetBSD release will be marked as broken on that branch. This is
9223: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9224: branch name (or appending the branch name to it). If a user tries
9225: to build such a package and the build fails, the user gets a
9226: message that says that the package was broken on the respective
9227: branch(es).</p></li>
9228: </ul></div>
9229: <p>Both types of packages are removed from pkgsrc in irregular
9230: intervals.</p>
9231: </div>
1.75 rillig 9232: </div>
9233: <div class="chapter" lang="en">
9234: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9235: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 9236: <p>To check out all the gotchas when building a package, here are
9237: the steps that I do in order to get a package working. Please note
9238: this is basically the same as what was explained in the previous
9239: sections, only with some debugging aids.</p>
1.75 rillig 9240: <div class="itemizedlist"><ul type="disc">
1.104 rillig 9241: <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.75 rillig 9242: <li>
1.91 rillig 9243: <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>,
1.88 wiz 9244: create a directory for a new package, change into it, then run
9245: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 9246: <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>
9247: <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>
9248: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9249: </li>
1.76 rillig 9250: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9251: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 9252: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 9253: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9254: configure step to the package's
9255: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9256: <li>
9257: <p>Make the package compile, doing multiple rounds of</p>
9258: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9259: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9260: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9261: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9262: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9263: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9264: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9265: <p>Doing this step as non-root user will ensure that no files
9266: are modified that shouldn't be, especially during the build
9267: phase. <span><strong class="command">mkpatches</strong></span>,
9268: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 rillig 9269: 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>
1.88 wiz 9270: package.</p>
1.75 rillig 9271: </li>
1.88 wiz 9272: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9273: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9274: <li>
1.76 rillig 9275: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9276: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9277: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9278: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9279: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9280: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9281: <p>You usually need to be <code class="username">root</code> to do
9282: this. Look if there are any files left:</p>
1.75 rillig 9283: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9284: <p>If this reveals any files that are missing in
1.88 wiz 9285: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9286: </li>
9287: <li>
1.88 wiz 9288: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9289: package again and make a binary package:</p>
1.75 rillig 9290: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9291: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9292: </li>
9293: <li>
9294: <p>Delete the installed package:</p>
1.88 wiz 9295: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75 rillig 9296: </li>
9297: <li>
1.88 wiz 9298: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9299: command, which shouldn't find anything now:</p>
1.75 rillig 9300: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9301: </li>
9302: <li>
9303: <p>Reinstall the binary package:</p>
1.93 rillig 9304: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75 rillig 9305: </li>
1.88 wiz 9306: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9307: <li>
1.91 rillig 9308: <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
1.88 wiz 9309: reports:</p>
1.75 rillig 9310: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9311: </li>
1.90 rillig 9312: <li><p>Submit (or commit, if you have cvs access); see <a href="#submit" title="Chapter 20. Submitting and Committing">Chapter 20, <i>Submitting and Committing</i></a>.</p></li>
1.75 rillig 9313: </ul></div>
9314: </div>
9315: <div class="chapter" lang="en">
9316: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9317: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9318: <div class="toc">
9319: <p><b>Table of Contents</b></p>
9320: <dl>
1.90 rillig 9321: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9322: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9323: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9324: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9325: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9326: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9327: </dl>
9328: </div>
9329: <div class="sect1" lang="en">
9330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9331: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9332: <p>Our policy is that we accept binaries only from pkgsrc
9333: developers to guarantee that the packages don't contain any
9334: trojan horses etc. This is not to annoy anyone but rather to
9335: protect our users! You're still free to put up your home-made
9336: binary packages and tell the world where to get them. NetBSD
9337: developers doing bulk builds and wanting to upload them please
9338: see <a href="#bulk-upload" title="6.3.8. Uploading results of a bulk build">Section 6.3.8, “Uploading results of a bulk build”</a>.</p>
9339: </div>
9340: <div class="sect1" lang="en">
9341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9342: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9343: <p>First, check that your package is complete, compiles and
1.90 rillig 9344: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9345: 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>
1.82 rillig 9346: archive that contains all files that make up the package.
1.87 wiz 9347: Finally, send this package to the pkgsrc bug tracking system,
9348: 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
9349: that, go to the web page
1.103 wiz 9350: <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87 wiz 9351: which contains some instructions and a link to a form, where you
9352: can submit packages.</p>
9353: <p>In the form of the problem report, the category should be
9354: “<span class="quote">pkg</span>”, the synopsis should include the package name
9355: and version number, and the description field should contain a
9356: short description of your package (contents of the COMMENT
9357: variable or DESCR file are OK). The uuencoded package data should
9358: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9359: <p>If you want to submit several packages, please send a
9360: separate PR for each one, it's easier for us to track things
9361: that way.</p>
9362: <p>Alternatively, you can also import new packages into
9363: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9364: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9365: for details.</p>
9366: </div>
9367: <div class="sect1" lang="en">
9368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9369: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9370: <p>Please note all package additions, updates, moves, and
1.93 rillig 9371: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9372: important to keep this file up to date and conforming to the
9373: existing format, because it will be used by scripts to
9374: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9375: sites. Additionally, check the
1.76 rillig 9376: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9377: for the package you updated or removed, in case it was mentioned
9378: there.</p>
9379: <p>When the <code class="varname">PKGREVISION</code> of a package is
9380: bumped, the change should appear in
1.93 rillig 9381: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9382: related or otherwise relevant. Mass bumps that result from a
9383: dependency being updated should not be mentioned. In all other
9384: cases it's the developer's decision.</p>
9385: <p>There is a make target that helps in creating proper
1.93 rillig 9386: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
1.75 rillig 9387: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9388: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9389: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9390: file is up-to-date (to avoid having to resolve conflicts later-on)
9391: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9392: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9393: For new packages, or package moves or removals, set the
9394: <code class="varname">CTYPE</code> variable on the command line to "Added",
9395: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.104 rillig 9396: in <a href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75 rillig 9397: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9398: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9399: </div>
9400: <div class="sect1" lang="en">
9401: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9402: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9403: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9404: access to the pkgsrc repository. Please remember that cvs
9405: imports files relative to the current working directory, and that
9406: the pathname that you
9407: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9408: to place the files in the repository. Newly created packages should be
9409: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9410: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9411: <pre class="programlisting">
1.100 rillig 9412: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9413: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9414: </pre>
1.87 wiz 9415: <p>Remember to move the directory from which you imported out of
1.75 rillig 9416: the way, or cvs will complain the next time you “<span class="quote">cvs
9417: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9418: package to the category's <code class="filename">Makefile</code>.</p>
9419: <p>The commit message of the initial import should include part of the
1.76 rillig 9420: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9421: what the package is/does.</p>
9422: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9423: add</span>” because the former gets everything with a single command,
1.87 wiz 9424: and provides a consistent tag.</p>
1.75 rillig 9425: </div>
9426: <div class="sect1" lang="en">
9427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9428: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9429: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9430: changes between old and new versions into the commit log when updating
1.87 wiz 9431: a package. There are various reasons for this:</p>
1.75 rillig 9432: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9433: <li><p>A URL is volatile, and can change over time. It may go away completely
9434: or its information may be overwritten by newer information.</p></li>
9435: <li><p>Having the change information between old and new versions in our CVS
9436: repository is very useful for people who use either cvs or anoncvs.</p></li>
9437: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9438: repository is very useful for people who read the pkgsrc-changes mailing
9439: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9440: the package.</p></li>
1.75 rillig 9441: </ul></div>
1.87 wiz 9442: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9443: has been released, it should not automatically be upgraded in the CVS
9444: repository. We prefer to be conservative in the packages that are
9445: included in pkgsrc - development or beta packages are not really the
9446: best thing for most places in which pkgsrc is used. Please use your
9447: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9448: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9449: </div>
9450: <div class="sect1" lang="en">
9451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9452: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9453: <div class="orderedlist"><ol type="1">
9454: <li><p>Make a copy of the directory somewhere else.</p></li>
9455: <li>
9456: <p>Remove all CVS dirs.</p>
1.87 wiz 9457: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9458: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87 wiz 9459: <p>and use that for further work.</p>
1.75 rillig 9460: </li>
9461: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9462: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9463: instead of “<span class="quote">../../category/package</span>”.</p></li>
9464: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9465: place.</p></li>
9466: <li>
9467: <p>Check if any package depends on it:
9468: </p>
9469: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9470: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9471: </li>
9472: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9473: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9474: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9475: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9476: <li>
9477: <p>Commit the changed and removed files:</p>
9478: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87 wiz 9479: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9480: </li>
9481: </ol></div>
9482: </div>
9483: </div>
9484: <div class="chapter" lang="en">
9485: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9486: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9487: <p>This section contains the answers to questions that may
9488: arise when you are writing a package. If you don't find your
9489: question answered here, first have a look in the other chapters,
9490: and if you still don't have the answer, ask on the
9491: <code class="literal">pkgsrc-users</code> mailing list.</p>
9492: <div class="qandaset">
9493: <dl>
1.93 rillig 9494: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9495: MAKEFLAGS, .MAKEFLAGS and
9496: MAKE_FLAGS?</a>
9497: </dt>
1.93 rillig 9498: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9499: MAKE, GMAKE and
9500: MAKE_PROGRAM?</a>
9501: </dt>
1.93 rillig 9502: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9503: CC, PKG_CC and
9504: PKGSRC_COMPILER?</a>
9505: </dt>
1.93 rillig 9506: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9507: BUILDLINK_LDFLAGS,
9508: BUILDLINK_LDADD and
9509: BUILDLINK_LIBS?</a>
9510: </dt>
1.93 rillig 9511: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9512: VARNAME=BUILDLINK_PREFIX.foo
9513: say it's empty?</a>
9514: </dt>
1.93 rillig 9515: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9516: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9517: don't understand the := inside
9518: it.</a>
9519: </dt>
1.93 rillig 9520: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9521: developers?</a>
9522: </dt>
1.93 rillig 9523: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9524: documentation?</a>
9525: </dt>
1.92 rillig 9526: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
9527: do?</a>
9528: </dt>
1.75 rillig 9529: </dl>
9530: <table border="0" summary="Q and A Set">
9531: <col align="left" width="1%">
9532: <tbody>
9533: <tr class="question">
9534: <td align="left" valign="top">
1.105 ! weinem 9535: <a name="devfaq.makeflags"></a><a name="id2713609"></a><b>21.1.</b>
1.75 rillig 9536: </td>
9537: <td align="left" valign="top"><p>What is the difference between
9538: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9539: <code class="varname">MAKE_FLAGS</code>?</p></td>
9540: </tr>
9541: <tr class="answer">
1.91 rillig 9542: <td align="left" valign="top"></td>
1.75 rillig 9543: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9544: 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
9545: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9546: the <code class="varname">MAKE_PROGRAM</code> when building the
9547: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9548: </tr>
9549: <tr class="question">
9550: <td align="left" valign="top">
1.105 ! weinem 9551: <a name="devfaq.make"></a><a name="id2713648"></a><b>21.2.</b>
1.75 rillig 9552: </td>
9553: <td align="left" valign="top"><p>What is the difference between
9554: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9555: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9556: </tr>
9557: <tr class="answer">
1.91 rillig 9558: <td align="left" valign="top"></td>
1.75 rillig 9559: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9560: <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
9561: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9562: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9563: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9564: Make program that is used for building the
9565: package.</p></td>
9566: </tr>
9567: <tr class="question">
9568: <td align="left" valign="top">
1.105 ! weinem 9569: <a name="devfaq.cc"></a><a name="id2713688"></a><b>21.3.</b>
1.75 rillig 9570: </td>
9571: <td align="left" valign="top"><p>What is the difference between
9572: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9573: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9574: </tr>
9575: <tr class="answer">
1.91 rillig 9576: <td align="left" valign="top"></td>
1.75 rillig 9577: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9578: compiler, which can be configured by the pkgsrc user.
9579: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9580: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9581: path to a compiler, but the type of compiler that should be
1.76 rillig 9582: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9583: information about the latter variable.</p></td>
9584: </tr>
9585: <tr class="question">
9586: <td align="left" valign="top">
1.105 ! weinem 9587: <a name="devfaq.bl3flags"></a><a name="id2713728"></a><b>21.4.</b>
1.75 rillig 9588: </td>
9589: <td align="left" valign="top"><p>What is the difference between
9590: <code class="varname">BUILDLINK_LDFLAGS</code>,
9591: <code class="varname">BUILDLINK_LDADD</code> and
9592: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9593: </tr>
9594: <tr class="answer">
1.91 rillig 9595: <td align="left" valign="top"></td>
1.75 rillig 9596: <td align="left" valign="top"><p>[FIXME]</p></td>
9597: </tr>
9598: <tr class="question">
9599: <td align="left" valign="top">
1.105 ! weinem 9600: <a name="devfaq.bl3prefix"></a><a name="id2713816"></a><b>21.5.</b>
1.75 rillig 9601: </td>
9602: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9603: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9604: say it's empty?</p></td>
9605: </tr>
9606: <tr class="answer">
1.91 rillig 9607: <td align="left" valign="top"></td>
1.75 rillig 9608: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9609: available in the “<span class="quote">wrapper</span>” phase and later. To
9610: “<span class="quote">simulate</span>” the wrapper phase, append
9611: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9612: command.</p></td>
9613: </tr>
1.78 rillig 9614: <tr class="question">
9615: <td align="left" valign="top">
1.105 ! weinem 9616: <a name="devfaq.master_sites"></a><a name="id2713846"></a><b>21.6.</b>
1.78 rillig 9617: </td>
9618: <td align="left" valign="top"><p>What does
9619: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9620: don't understand the <code class="literal">:=</code> inside
9621: it.</p></td>
9622: </tr>
9623: <tr class="answer">
1.91 rillig 9624: <td align="left" valign="top"></td>
1.78 rillig 9625: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9626: assignment operator, like you might expect at first sight.
9627: Instead, it is a degenerate form of
9628: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9629: 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
9630: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9631: case of <code class="varname">MASTER_SITE_*</code>,
9632: <em class="replaceable"><code>old_string</code></em> is the empty string and
9633: <em class="replaceable"><code>new_string</code></em> is
9634: <code class="literal">package/</code>. That's where the
9635: <code class="literal">:</code> and the <code class="literal">=</code> fall
9636: together.</p></td>
9637: </tr>
9638: <tr class="question">
9639: <td align="left" valign="top">
1.105 ! weinem 9640: <a name="devfaq.mailinglists"></a><a name="id2713923"></a><b>21.7.</b>
1.78 rillig 9641: </td>
9642: <td align="left" valign="top"><p>Which mailing lists are there for package
9643: developers?</p></td>
9644: </tr>
9645: <tr class="answer">
1.91 rillig 9646: <td align="left" valign="top"></td>
1.78 rillig 9647: <td align="left" valign="top"><div class="variablelist"><dl>
1.103 wiz 9648: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 9649: <dd><p>This is a list for technical discussions related
9650: to pkgsrc development, e.g. soliciting feedback for changes to
9651: pkgsrc infrastructure, proposed new features, questions related
9652: to porting pkgsrc to a new platform, advice for maintaining a
9653: package, patches that affect many packages, help requests moved
9654: from pkgsrc-users when an infrastructure bug is found,
9655: etc.</p></dd>
1.103 wiz 9656: <dt><span class="term"><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 9657: <dd><p>All bug reports in category "pkg" sent with
9658: <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
9659: directly; use one of the other mailing
9660: lists.</p></dd>
9661: </dl></div></td>
9662: </tr>
1.80 rillig 9663: <tr class="question">
9664: <td align="left" valign="top">
1.105 ! weinem 9665: <a name="devfaq.documentation"></a><a name="id2713961"></a><b>21.8.</b>
1.80 rillig 9666: </td>
9667: <td align="left" valign="top"><p>Where is the pkgsrc
9668: documentation?</p></td>
9669: </tr>
9670: <tr class="answer">
1.91 rillig 9671: <td align="left" valign="top"></td>
1.80 rillig 9672: <td align="left" valign="top">
9673: <p>There are many places where you can find
9674: documentation about pkgsrc:</p>
9675: <div class="itemizedlist"><ul type="disc">
9676: <li><p>The pkgsrc guide (this document) is a collection
9677: of chapters that explain large parts of pkgsrc, but some
9678: chapters tend to be outdated. Which ones they are is hard to
9679: say.</p></li>
9680: <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
9681: about certain features, announcements of new parts of the pkgsrc
9682: infrastructure and sometimes even announcements that a certain
9683: feature has been marked as obsolete. The benefit here is that
9684: each message has a date appended to it.</p></li>
9685: <li><p>Many of the files in the
9686: <code class="filename">mk/</code> directory start with a comment that
9687: describes the purpose of the file and how it can be used by the
1.92 rillig 9688: pkgsrc user and package authors. An easy way to find this
9689: documentation is to run <span><strong class="command">bmake
9690: help</strong></span>.</p></li>
1.80 rillig 9691: <li><p>The CVS log messages are a rich source of
9692: information, but they tend to be highly abbreviated, especially
9693: for actions that occur often. Some contain a detailed
9694: description of what has changed, but they are geared towards the
9695: other pkgsrc developers, not towards an average pkgsrc user.
9696: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9697: don't know what has been before, these messages may not be worth
9698: too much to you.</p></li>
9699: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9700: documented</span>”, that is the documentation exists only in the
9701: mind of the developer who wrote the code. To get this
1.93 rillig 9702: information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80 rillig 9703: to see who has written it and ask on the
9704: <code class="literal">tech-pkg</code> mailing list, so that others can
9705: find your questions later (see above). To be sure that the
9706: developer in charge reads the mail, you may CC him or
9707: her.</p></li>
9708: </ul></div>
9709: </td>
9710: </tr>
1.92 rillig 9711: <tr class="question">
9712: <td align="left" valign="top">
1.105 ! weinem 9713: <a name="devfaq.too-much-time"></a><a name="id2714160"></a><b>21.9.</b>
1.92 rillig 9714: </td>
9715: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9716: do?</p></td>
9717: </tr>
9718: <tr class="answer">
9719: <td align="left" valign="top"></td>
9720: <td align="left" valign="top">
1.93 rillig 9721: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9722: anyway.</p>
9723: <div class="itemizedlist"><ul type="disc">
9724: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9725: <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
9726: will tell you about newer versions of installed packages that are
9727: available, but not yet updated in pkgsrc.</p></li>
9728: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.105 ! weinem 9729: — it contains a list of suggested new packages and a list of
1.92 rillig 9730: cleanups and enhancements for pkgsrc that would be nice to
9731: have.</p></li>
9732: <li><p>Review packages for which review was requested on
9733: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9734: mailing list.</p></li>
9735: </ul></div>
9736: </td>
9737: </tr>
1.75 rillig 9738: </tbody>
9739: </table>
9740: </div>
9741: </div>
1.85 jmmv 9742: <div class="chapter" lang="en">
9743: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9744: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9745: <div class="toc">
9746: <p><b>Table of Contents</b></p>
9747: <dl>
1.90 rillig 9748: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9749: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9750: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9751: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9752: </dl>
9753: </div>
9754: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9755: site</a>:</p>
9756: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9757: environment, an intuitive and attractive desktop for users, and the
9758: GNOME development platform, an extensive framework for building
9759: applications that integrate into the rest of the desktop.</p></blockquote></div>
9760: <p>pkgsrc provides a seamless way to automatically build and install
9761: a complete GNOME environment <span class="emphasis"><em>under many different
9762: platforms</em></span>. We can say with confidence that pkgsrc is one of
9763: the most advanced build and packaging systems for GNOME due to its
9764: included technologies buildlink3, the wrappers and tools framework and
9765: automatic configuration file management. Lots of efforts are put into
9766: achieving a completely clean deinstallation of installed software
9767: components.</p>
9768: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9769: the above also means that great efforts are put into making GNOME work
9770: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9771: pkgsrc as its preferred packaging system, contributing lots of
9772: portability fixes to make GNOME build and install under it.</p>
9773: <p>This chapter is aimed at pkgsrc developers and other people
9774: interested in helping our GNOME porting and packaging efforts. It
9775: provides instructions on how to manage the existing packages and some
9776: important information regarding their internals.</p>
9777: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9778: <h3 class="title">We need your help!</h3>
9779: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9780: and GNOME and are willing to learn new exciting stuff, please jump
9781: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9782: work</a> list! There is still a long way to go to get a
9783: fully-functional GNOME desktop under NetBSD and we need your help to
9784: achieve it!</p>
9785: </div>
9786: <div class="sect1" lang="en">
9787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9788: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9789: <p>pkgsrc includes three GNOME-related meta packages:</p>
9790: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9791: <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
1.85 jmmv 9792: the core GNOME desktop environment. It only includes the necessary
9793: bits to get it to boot correctly, although it may lack important
9794: functionality for daily operation. The idea behind this package is
9795: to let end users build their own configurations on top of this one,
9796: first installing this meta package to achieve a functional setup and
9797: then adding individual applications.</p></li>
1.91 rillig 9798: <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
1.85 jmmv 9799: complete installation of the GNOME platform and desktop as defined
9800: by the GNOME project; this is based on the components distributed in
9801: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9802: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9803: official FTP server. Developer-only tools found in those
9804: directories are not installed unless required by some other
9805: component to work properly. Similarly, packages from the bindings
9806: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9807: in unless required as a dependency for an end-user component. This
1.91 rillig 9808: 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>
9809: <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>:
1.85 jmmv 9810: Installs all the tools required to build a GNOME component when
9811: fetched from the CVS repository. These are required to let the
9812: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9813: </ul></div>
9814: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9815: sorted in a way that eases updates: a package may depend on other
9816: packages listed before it but not on any listed after it. It is very
9817: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9818: change it to alphabetical sorting!</em></span></p>
9819: </div>
9820: <div class="sect1" lang="en">
9821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9822: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9823: <p>Almost all GNOME applications are written in C and use a common
9824: set of tools as their build system. Things get different with the new
9825: bindings to other languages (such as Python), but the following will
9826: give you a general idea on the minimum required tools:</p>
9827: <div class="itemizedlist"><ul type="disc">
9828: <li>
9829: <p>Almost all GNOME applications use the GNU Autotools as their
9830: build system. As a general rule you will need to tell this to your
9831: package:</p>
1.100 rillig 9832: <pre class="programlisting">
9833: GNU_CONFIGURE=yes
1.85 jmmv 9834: USE_LIBTOOL=yes
1.100 rillig 9835: USE_TOOLS+=gmake
9836: </pre>
1.85 jmmv 9837: </li>
9838: <li>
9839: <p>If the package uses pkg-config to detect dependencies, add this
9840: tool to the list of required utilities:</p>
9841: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9842: <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
1.85 jmmv 9843: the end of the build process to ensure that you did not miss to
9844: specify any dependency in your package and that the version
9845: requirements are all correct.</p>
9846: </li>
1.93 rillig 9847: <li><p>If the package uses intltool, be sure to add
9848: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9849: to handle dependencies and to force the package to use the latest
9850: available version.</p></li>
9851: <li>
9852: <p>If the package uses gtk-doc (a documentation generation
9853: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9854: tool is rather big and the distfile should come with pregenerated
9855: documentation anyway; if it does not, it is a bug that you ought to
9856: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9857: the default):</p>
9858: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9859: <p>The default location of installed HTML files
9860: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9861: and should not be changed unless the package insists on installing
9862: them somewhere else. Otherwise programs as
9863: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9864: do that with an entry similar to:</p>
9865: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9866: </li>
9867: </ul></div>
9868: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9869: files under the installation prefix to maintain databases. In this
9870: context, shared means that those exact same directories and files are
9871: used among several different packages, leading to conflicts in the
9872: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9873: handle the most common cases, so you have to forget about using
9874: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9875: omitting shared files from them. If you find yourself doing those,
9876: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9877: <p>The following table lists the common situations that result in
9878: using shared directories or files. For each of them, the appropriate
9879: solution is given. After applying the solution be sure to
9880: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9881: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9882: <div class="table">
1.90 rillig 9883: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9884: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9885: <colgroup>
9886: <col>
9887: <col>
9888: </colgroup>
9889: <thead><tr>
9890: <th>If the package...</th>
9891: <th>Then...</th>
9892: </tr></thead>
9893: <tbody>
9894: <tr>
9895: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.103 wiz 9896: <td>See <a href="#scrollkeeper-data-files" title="18.6.10. Packages installing scrollkeeper data files">Section 18.6.10, “Packages installing scrollkeeper data files”</a>.</td>
1.85 jmmv 9897: </tr>
9898: <tr>
9899: <td>Installs icons under the
9900: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9901: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.103 wiz 9902: <td>See <a href="#hicolor-theme" title="18.6.19. Packages installing hicolor theme icons">Section 18.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 9903: </tr>
9904: <tr>
9905: <td>Installs files under
9906: <code class="filename">share/mime/packages</code>.</td>
1.103 wiz 9907: <td>See <a href="#mime-database" title="18.6.14. Packages installing extensions to the MIME database">Section 18.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 9908: </tr>
9909: <tr>
9910: <td>Installs <code class="filename">.desktop</code> files under
9911: <code class="filename">share/applications</code> and these include MIME
9912: information.</td>
1.103 wiz 9913: <td>See <a href="#desktop-files" title="18.6.20. Packages installing desktop files">Section 18.6.20, “Packages installing desktop files”</a>.</td>
1.85 jmmv 9914: </tr>
9915: </tbody>
1.91 rillig 9916: </table></div>
1.85 jmmv 9917: </div>
1.91 rillig 9918: <br class="table-break">
1.85 jmmv 9919: </div>
9920: <div class="sect1" lang="en">
9921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9922: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9923: <p>When seeing GNOME as a whole, there are two kinds of
9924: updates:</p>
9925: <div class="variablelist"><dl>
9926: <dt><span class="term">Major update</span></dt>
9927: <dd>
9928: <p>Given that there is still a very long way for GNOME 3 (if it
9929: ever appears), we consider a major update one that goes from a
9930: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9931: where <code class="literal">Y</code> is even and greater than
9932: <code class="literal">X</code>. These are hard to achieve because they
9933: introduce lots of changes in the components' code and almost all
9934: GNOME distfiles are updated to newer versions. Some of them can
9935: even break API and ABI compatibility with the previous major
9936: version series. As a result, the update needs to be done all at
9937: once to minimize breakage.</p>
9938: <p>A major update typically consists of around 80 package
9939: updates and the addition of some new ones.</p>
9940: </dd>
9941: <dt><span class="term">Minor update</span></dt>
9942: <dd>
9943: <p>We consider a minor update one that goes from a
9944: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9945: one where <code class="literal">Y</code> is greater than
9946: <code class="literal">X</code>. These are easy to achieve because they do
9947: not update all GNOME components, can be done in an incremental way
9948: and do not break API nor ABI compatibility.</p>
9949: <p>A minor update typically consists of around 50 package
9950: updates, although the numbers here may vary a lot.</p>
9951: </dd>
9952: </dl></div>
9953: <p>In order to update the GNOME components in pkgsrc to a new stable
9954: release (either major or minor), the following steps should be
9955: followed:</p>
9956: <div class="orderedlist"><ol type="1">
9957: <li>
9958: <p>Get a list of all the tarballs that form the new release by
9959: using the following commands. These will leave the full list of the
9960: components's distfiles into the <code class="filename">list.txt</code>
9961: file:</p>
1.88 wiz 9962: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9963: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9964: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9965: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9966: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9967: awk '{ print $9 }' >>list.txt</code></strong></pre>
9968: </li>
9969: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9970: bump their version to the release you are updating them to. The
9971: three meta packages should be always consistent with versioning.
9972: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9973: in them.</p></li>
9974: <li>
9975: <p>For each meta package, update all its
9976: <code class="varname">DEPENDS</code> lines to match the latest versions as
9977: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9978: newer version (even if found in the FTP) because the meta packages
9979: are supposed to list the exact versions that form a specific GNOME
9980: release. Exceptions are permitted here if a newer version solves a
9981: serious issue in the overall desktop experience; these typically
9982: come in the form of a revision bump in pkgsrc, not in newer versions
9983: from the developers.</p>
9984: <p>Packages not listed in the <code class="filename">list.txt</code> file
9985: should be updated to the latest version available (if found in
9986: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9987: 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>
1.85 jmmv 9988: </li>
9989: <li>
9990: <p>Generate a patch from the modified meta packages and extract the
9991: list of "new" lines. This will provide you an outline on what
9992: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9993: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt</code></strong></pre>
1.85 jmmv 9994: </li>
9995: <li><p>For major desktop updates it is recommended to zap all your
9996: installed packages and start over from scratch at this point.</p></li>
9997: <li><p>Now comes the longest step by far: iterate over the contents
9998: of <code class="filename">todo.txt</code> and update the packages listed in
9999: it in order. For major desktop updates none of these should be
1.93 rillig 10000: committed until the entire set is completed because there are chances
1.85 jmmv 10001: of breaking not-yet-updated packages.</p></li>
10002: <li><p>Once the packages are up to date and working, commit them to
10003: the tree one by one with appropriate log messages. At the end,
10004: commit the three meta package updates and all the corresponding
10005: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10006: <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>
10007: </ol></div>
10008: </div>
10009: <div class="sect1" lang="en">
10010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10011: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10012: <p>GNOME is a very big component in pkgsrc which approaches 100
10013: packages. Please, it is very important that you always, always,
10014: <span class="strong"><strong>always</strong></span> feed back any portability
1.93 rillig 10015: fixes you do to a GNOME package to the mainstream developers (see <a href="#components.patches.feedback" title="10.3.5. Feedback to the author">Section 10.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 10016: their attention on portability issues and to ensure that future versions
10017: can be built out-of-the box on NetBSD. The less custom patches in
10018: pkgsrc, the easier further updates are. Those developers in charge of
10019: issuing major GNOME updates will be grateful if you do that.</p>
10020: <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
10021: Bugzilla</a>. Not all components use these to track bugs, but most
10022: of them do. Do not be short on your reports: always provide detailed
10023: explanations of the current failure, how it can be improved to achieve
10024: maximum portability and, if at all possible, provide a patch against CVS
10025: head. The more verbose you are, the higher chances of your patch being
10026: accepted.</p>
10027: <p>Also, please avoid using preprocessor magic to fix portability
10028: issues. While the FreeBSD GNOME people are doing a great job in porting
10029: GNOME to their operating system, the official GNOME sources are now
10030: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10031: and similar macros. This hurts portability. Please see our patching
1.93 rillig 10032: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10033: details.</p>
10034: </div>
10035: </div>
1.75 rillig 10036: </div>
10037: <div class="part" lang="en">
10038: <div class="titlepage"><div><div><h1 class="title">
10039: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10040: <div class="partintro" lang="en">
10041: <div></div>
10042: <p>This part of the guide deals with everything
10043: from the infrastructure that is behind the interfaces described
10044: in the developer's guide. A casual package maintainer should not
10045: need anything from this part.</p>
10046: <div class="toc">
10047: <p><b>Table of Contents</b></p>
10048: <dl>
1.90 rillig 10049: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10050: <dd><dl>
1.90 rillig 10051: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10052: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10053: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 10054: <dd><dl>
1.90 rillig 10055: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10056: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 10057: </dl></dd>
1.90 rillig 10058: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10059: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10060: <dd><dl>
1.90 rillig 10061: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10062: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10063: </dl></dd>
1.90 rillig 10064: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10065: <dd><dl>
1.90 rillig 10066: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10067: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10068: </dl></dd>
10069: </dl></dd>
1.90 rillig 10070: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 10071: <dd><dl>
1.90 rillig 10072: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10073: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10074: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10075: <dd><dl>
1.90 rillig 10076: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10077: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10078: </dl></dd>
10079: </dl></dd>
1.90 rillig 10080: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 10081: <dd><dl>
1.90 rillig 10082: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10083: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10084: </dl></dd>
10085: </dl>
10086: </div>
10087: </div>
10088: <div class="chapter" lang="en">
10089: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10090: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10091: <div class="toc">
10092: <p><b>Table of Contents</b></p>
10093: <dl>
1.90 rillig 10094: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10095: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10096: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 10097: <dd><dl>
1.90 rillig 10098: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10099: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 10100: </dl></dd>
1.90 rillig 10101: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10102: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10103: <dd><dl>
1.90 rillig 10104: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10105: <dt><span class="sect2"><a href="#infr.design.intf.action">23.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10106: </dl></dd>
1.90 rillig 10107: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10108: <dd><dl>
1.90 rillig 10109: <dt><span class="sect2"><a href="#infr.order.prefs">23.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10110: <dt><span class="sect2"><a href="#infr.order.pkg">23.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10111: </dl></dd>
10112: </dl>
10113: </div>
10114: <p>The pkgsrc infrastructure consists of many small Makefile
10115: fragments. Each such fragment needs a properly specified
10116: interface. This chapter explains how such an interface looks
10117: like.</p>
10118: <div class="sect1" lang="en">
10119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10120: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10121: <p>Whenever a variable is defined in the pkgsrc
10122: infrastructure, the location and the way of definition provide
10123: much information about the intended use of that variable.
10124: Additionally, more documentation may be found in a header
10125: comment or in this pkgsrc guide.</p>
10126: <p>A special file is
10127: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10128: variables that are intended to be user-defined. They are either
10129: defined using the <code class="literal">?=</code> operator or they are
10130: left undefined because defining them to anything would
10131: effectively mean “<span class="quote">yes</span>”. All these variables may be
10132: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10133: file.</p>
10134: <p>Outside this file, the following conventions apply:
10135: Variables that are defined using the <code class="literal">?=</code>
10136: operator may be overridden by a package.</p>
10137: <p>Variables that are defined using the <code class="literal">=</code>
10138: operator may be used read-only at run-time.</p>
10139: <p>Variables whose name starts with an underscore must not be
10140: accessed outside the pkgsrc infrastructure at all. They may
10141: change without further notice.</p>
10142: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10143: <h3 class="title">Note</h3>
10144: <p>These conventions are currently not applied
10145: consistently to the complete pkgsrc
10146: infrastructure.</p>
10147: </div>
10148: </div>
10149: <div class="sect1" lang="en">
10150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10151: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10152: <p>All variables that contain lists of things should default
10153: to being empty. Two examples that do not follow this rule are
10154: <code class="varname">USE_LANGUAGES</code> and
10155: <code class="varname">DISTFILES</code>. These variables cannot simply be
10156: modified using the <code class="literal">+=</code> operator in package
10157: <code class="filename">Makefile</code>s (or other files included by
10158: them), since there is no guarantee whether the variable is
10159: already set or not, and what its value is. In the case of
10160: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10161: the default value and just define it as in the following
10162: example.</p>
10163: <pre class="programlisting">
1.100 rillig 10164: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10165: </pre>
10166: <p>Because of the selection of this default value, the same
10167: value appears in many package Makefiles. Similarly for
10168: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10169: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10170: doesn't stand out. Nevertheless it is mentioned in many
10171: files.</p>
10172: </div>
10173: <div class="sect1" lang="en">
10174: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10175: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10176: <div class="sect2" lang="en">
10177: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10178: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 10179: <p>Variable evaluation takes place either at load time or at
10180: runtime, depending on the context in which they occur. The
10181: contexts where variables are evaluated at load time are:</p>
10182: <div class="itemizedlist"><ul type="disc">
10183: <li><p>The right hand side of the <code class="literal">:=</code>
10184: and <code class="literal">!=</code> operators,</p></li>
10185: <li><p>Make directives like <code class="literal">.if</code> or
10186: <code class="literal">.for</code>,</p></li>
10187: <li><p>Dependency lines.</p></li>
10188: </ul></div>
10189: <p>A special exception are references to the iteration
10190: variables of <code class="literal">.for</code> loops, which are expanded
10191: inline, no matter in which context they appear.</p>
10192: <p>As the values of variables may change during load time,
10193: care must be taken not to evaluate them by accident. Typical
10194: examples for variables that should not be evaluated at load time
10195: are <code class="varname">DEPENDS</code> and
10196: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10197: clear, here is an example:</p>
10198: <pre class="programlisting">
1.100 rillig 10199: CONFIGURE_ARGS= # none
10200: CFLAGS= -O
10201: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10202:
1.100 rillig 10203: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10204:
1.100 rillig 10205: CFLAGS+= -Wall
1.75 rillig 10206: </pre>
10207: <p>This code shows how the use of the <code class="literal">:=</code>
10208: operator can quickly lead to unexpected results. The first
10209: paragraph is fairly common code. The second paragraph evaluates
10210: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10211: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10212: <code class="literal">-Wall</code> is appended to the
10213: <code class="varname">CFLAGS</code>, but this addition will not appear in
10214: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10215: paragraphs from above typically occur in completely unrelated
10216: files.</p>
10217: </div>
10218: <div class="sect2" lang="en">
10219: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10220: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 10221: <p>After all the files have been loaded, the values of the
10222: variables cannot be changed anymore. Variables that are used in
10223: the shell commands are expanded at this point.</p>
10224: </div>
10225: </div>
10226: <div class="sect1" lang="en">
10227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10228: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10229: <p>There are many ways in which the definition and use of a
10230: variable can be restricted in order to detect bugs and
10231: violations of the (mostly unwritten) policies. See the
10232: <code class="literal">pkglint</code> developer's documentation for further
10233: details.</p>
10234: </div>
10235: <div class="sect1" lang="en">
10236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10237: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10238: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10239: of the following classes. Cases where a file falls into more
10240: than one class should be avoided as it often leads to subtle
10241: bugs.</p>
10242: <div class="sect2" lang="en">
10243: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10244: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10245: <p>In a traditional imperative programming language some of
1.76 rillig 10246: the <code class="filename">.mk</code> files could be described as
1.105 ! weinem 10247: procedures. They take some input parameters and—after
! 10248: inclusion—provide a result in output parameters. Since all
1.76 rillig 10249: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10250: care must be taken not to use parameter names that have already
10251: another meaning. For example, <code class="varname">PKGNAME</code> is a
10252: bad choice for a parameter name.</p>
10253: <p>Procedures are completely evaluated at preprocessing time.
10254: That is, when calling a procedure all input parameters must be
10255: completely resolvable. For example,
10256: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10257: parameter since it is very likely that further text will be
10258: added after calling the procedure, which would effectively apply
10259: the procedure to only a part of the variable. Also, references
10260: to other variables wit will be modified after calling the
10261: procedure.</p>
10262: <p>A procedure can declare its output parameters either as
10263: suitable for use in preprocessing directives or as only
10264: available at runtime. The latter alternative is for variables
10265: that contain references to other runtime variables.</p>
10266: <p>Procedures shall be written such that it is possible to
10267: call the procedure more than once. That is, the file must not
10268: contain multiple-inclusion guards.</p>
10269: <p>Examples for procedures are
1.76 rillig 10270: <code class="filename">mk/bsd.options.mk</code> and
10271: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10272: that the parameters are evaluated at load time, they should be
10273: assigned using the <code class="literal">:=</code> operator, which should
10274: be used only for this purpose.</p>
10275: </div>
10276: <div class="sect2" lang="en">
10277: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10278: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10279: <p>Action files take some input parameters and may define
10280: runtime variables. They shall not define loadtime variables.
10281: There are action files that are included implicitly by the
10282: pkgsrc infrastructure, while other must be included
10283: explicitly.</p>
10284: <p>An example for action files is
1.76 rillig 10285: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10286: </div>
10287: </div>
1.81 rillig 10288: <div class="sect1" lang="en">
10289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10290: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10291: <p>Package <code class="filename">Makefile</code>s usually consist of
10292: a set of variable definitions, and include the file
10293: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10294: Before that, they may also include various other
10295: <code class="filename">*.mk</code> files if they need to query the
10296: availability of certain features like the type of compiler or
10297: the X11 implementation. Due to the heavy use of preprocessor
10298: directives like <code class="literal">.if</code> and
10299: <code class="literal">.for</code>, the order in which the files are loaded
10300: matters.</p>
10301: <p>This section describes at which point the various files
10302: are loaded and gives reasons for that order.</p>
10303: <div class="sect2" lang="en">
10304: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10305: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10306: </h3></div></div></div>
10307: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10308: is to define some essential variables like
10309: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10310: <code class="varname">MACHINE_ARCH</code>.</p>
10311: <p>Then, the user settings are loaded from the file specified
1.104 rillig 10312: in <code class="varname">MAKECONF</code>, which is usually <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
10313: After that, those variables
1.81 rillig 10314: that have not been overridden by the user are loaded from
10315: <code class="filename">mk/defaults/mk.conf</code>.</p>
10316: <p>After the user settings, the system settings and platform
10317: settings are loaded, which may override the user
10318: settings.</p>
10319: <p>Then, the tool definitions are loaded. The tool wrappers
10320: are not yet in effect. This only happens when building a
10321: package, so the proper variables must be used instead of the
10322: direct tool names.</p>
10323: <p>As the last steps, some essential variables from the
10324: wrapper and the package system flavor are loaded, as well as the
10325: variables that have been cached in earlier phases of a package
10326: build.</p>
10327: </div>
10328: <div class="sect2" lang="en">
10329: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10330: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10331: </h3></div></div></div>
1.81 rillig 10332: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10333: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10334: loaded, which fill default values for those variables that have
1.93 rillig 10335: not been defined by the package. These variables may later
1.81 rillig 10336: be used even in unrelated files.</p>
10337: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10338: provides the target <code class="literal">error-check</code> that is added
10339: as a special dependency to all other targets that use
10340: <code class="varname">DELAYED_ERROR_MSG</code> or
10341: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10342: <p>Then, the package-specific hacks from
10343: <code class="filename">hacks.mk</code> are included.</p>
10344: <p>Then, various other files follow. Most of them don't have
10345: any dependencies on what they need to have included before or
10346: after them, though some do.</p>
10347: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10348: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10349: restricts the use of these variables to all the files that have
10350: been included before. Appearances in later files will be
10351: silently ignored.</p>
10352: <p>Then, the files for the main targets are included, in the
10353: order of later execution, though the actual order should not
10354: matter.</p>
10355: <p>At last, some more files are included that don't set any
10356: interesting variables but rather just define make targets to be
10357: executed.</p>
10358: </div>
10359: </div>
1.75 rillig 10360: </div>
10361: <div class="chapter" lang="en">
10362: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10363: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10364: <div class="toc">
10365: <p><b>Table of Contents</b></p>
10366: <dl>
1.90 rillig 10367: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10368: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10369: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10370: <dd><dl>
1.90 rillig 10371: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10372: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10373: </dl></dd>
10374: </dl>
10375: </div>
10376: <p>The pkgsrc infrastructure consists of a large codebase,
10377: and there are many corners where every little bit of a file is
10378: well thought out, making pkgsrc likely to fail as soon as
10379: anything is changed near those parts. To prevent most changes
10380: from breaking anything, a suite of regression tests should go
10381: along with every important part of the pkgsrc infrastructure.
10382: This chapter describes how regression tests work in pkgsrc and
10383: how you can add new tests.</p>
10384: <div class="sect1" lang="en">
10385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10386: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10387: <p></p>
10388: </div>
10389: <div class="sect1" lang="en">
10390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10391: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10392: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.75 rillig 10393: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10394: can simply run that command, which will run all tests in the
1.76 rillig 10395: <code class="filename">regress</code> category.</p>
1.75 rillig 10396: </div>
10397: <div class="sect1" lang="en">
10398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10399: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10400: <p>Every directory in the <code class="filename">regress</code>
10401: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10402: is considered a regression test. This file is a shell program
10403: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10404: The following functions can be overridden to suit your
10405: needs.</p>
10406: <div class="sect2" lang="en">
10407: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10408: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10409: <p>These functions do not take any parameters. They are all
10410: called in “<span class="quote">set -e</span>” mode, so you should be careful
10411: to check the exitcodes of any commands you run in the
10412: test.</p>
10413: <div class="variablelist"><dl>
10414: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10415: <dd><p>This function prepares the environment for the
10416: test. By default it does nothing.</p></dd>
10417: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10418: <dd><p>This function runs the actual test. By default,
10419: it calls <code class="varname">TEST_MAKE</code> with the arguments
10420: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10421: error messages into the file
10422: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10423: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10424: <dd><p>This function is run after the test and is
10425: typically used to compare the actual output from the one that is
10426: expected. It can make use of the various helper functions from
10427: the next section.</p></dd>
10428: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10429: <dd><p>This function cleans everything up after the
10430: test has been run. By default it does nothing.</p></dd>
10431: </dl></div>
10432: </div>
10433: <div class="sect2" lang="en">
10434: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10435: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10436: <div class="variablelist"><dl>
10437: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10438: <dd><p>This function compares the exitcode of the
10439: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10440: If they differ, the test will fail.</p></dd>
10441: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10442: <dd><p>This function checks for each of its parameters
10443: if the output from <span><strong class="command">do_test()</strong></span> matches the
10444: extended regular expression. If it does not, the test will
10445: fail.</p></dd>
10446: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10447: <dd><p>This function checks for each of its parameters
10448: if the output from <span><strong class="command">do_test()</strong></span> does
10449: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10450: If any of the regular expressions matches, the test will
10451: fail.</p></dd>
10452: </dl></div>
10453: </div>
10454: </div>
10455: </div>
10456: <div class="chapter" lang="en">
10457: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10458: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10459: <div class="toc">
10460: <p><b>Table of Contents</b></p>
10461: <dl>
1.90 rillig 10462: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10463: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10464: </dl>
10465: </div>
10466: <p>The pkgsrc system has already been ported to many
10467: operating systems, hardware architectures and compilers. This
10468: chapter explains the necessary steps to make pkgsrc even more
10469: portable.</p>
10470: <div class="sect1" lang="en">
10471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10472: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10473: <p>To port pkgsrc to a new operating system (called
10474: <code class="literal">MyOS</code> in this example), you need to touch the
10475: following files:</p>
10476: <div class="variablelist"><dl>
1.93 rillig 10477: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75 rillig 10478: <dd><p>This file contains some basic definitions, for
10479: example the name of the C
10480: compiler.</p></dd>
1.76 rillig 10481: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10482: <dd><p>Insert code that defines the variables
10483: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10484: <code class="varname">LOWER_OS_VERSION</code>,
10485: <code class="varname">LOWER_VENDOR</code>,
10486: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10487: <code class="varname">APPEND_ELF</code>, and the other variables that
10488: appear in this file.</p></dd>
1.93 rillig 10489: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10490: <dd><p>This file contains the platform-specific
10491: definitions that are used by pkgsrc. Start by copying one of the
10492: other files and edit it to your
10493: needs.</p></dd>
1.93 rillig 10494: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10495: <dd><p>This file contains a list of directories,
10496: together with their permission bits and ownership. These
10497: directories will be created automatically with every package
1.98 wiz 10498: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10499: be removed.</p></dd>
1.93 rillig 10500: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10501: <dd><p>Just copy one of the pre-existing x11.dist files
10502: to your
1.76 rillig 10503: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10504: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10505: <dd><p>On some operating systems, the tools that are
10506: provided with the base system are not good enough for pkgsrc.
10507: 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
10508: narrow limit on the line length they can process. Therefore
10509: pkgsrc brings its own tools, which can be enabled
10510: here.</p></dd>
1.93 rillig 10511: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10512: <dd><p>This file defines the paths to all the tools
10513: that are needed by one or the other package in pkgsrc, as well
10514: as by pkgsrc itself. Find out where these tools are on your
10515: platform and add them.</p></dd>
10516: </dl></div>
10517: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10518: <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>
1.75 rillig 10519: </div>
10520: <div class="sect1" lang="en">
10521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10522: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10523: <p>TODO</p>
10524: </div>
10525: </div>
10526: </div>
10527: <div class="appendix" lang="en">
10528: <div class="titlepage"><div><div><h2 class="title">
10529: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10530: <div class="toc">
10531: <p><b>Table of Contents</b></p>
10532: <dl>
10533: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10534: <dd><dl>
10535: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10536: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10537: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10538: <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>
10539: </dl></dd>
10540: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10541: </dl>
10542: </div>
10543: <p>We checked to find a piece of software that wasn't in the packages
10544: collection, and picked GNU bison. Quite why someone would want to have
10545: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10546: present in the tree is beyond us, but it's useful for the purposes of
10547: this exercise.</p>
10548: <div class="sect1" lang="en">
10549: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10550: <a name="example-files"></a>A.1. files</h2></div></div></div>
10551: <div class="sect2" lang="en">
10552: <div class="titlepage"><div><div><h3 class="title">
10553: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10554: <pre class="programlisting">
1.100 rillig 10555: # $NetBSD$
10556: #
1.1 grant 10557:
1.100 rillig 10558: DISTNAME= bison-1.25
10559: CATEGORIES= devel
10560: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10561:
1.100 rillig 10562: MAINTAINER= thorpej@NetBSD.org
10563: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10564: COMMENT= GNU yacc clone
1.1 grant 10565:
1.100 rillig 10566: GNU_CONFIGURE= yes
10567: INFO_FILES= bison.info
1.1 grant 10568:
1.100 rillig 10569: .include "../../mk/bsd.pkg.mk"
1.1 grant 10570: </pre>
1.75 rillig 10571: </div>
10572: <div class="sect2" lang="en">
10573: <div class="titlepage"><div><div><h3 class="title">
10574: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10575: <pre class="programlisting">
1.100 rillig 10576: GNU version of yacc. Can make re-entrant parsers, and numerous other
10577: 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
10578: of the NetBSD source tree is beyond me.
1.1 grant 10579: </pre>
1.75 rillig 10580: </div>
10581: <div class="sect2" lang="en">
10582: <div class="titlepage"><div><div><h3 class="title">
10583: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10584: <pre class="programlisting">
1.100 rillig 10585: @comment $NetBSD$
10586: bin/bison
10587: man/man1/bison.1.gz
10588: share/bison.simple
10589: share/bison.hairy
1.1 grant 10590: </pre>
1.75 rillig 10591: </div>
10592: <div class="sect2" lang="en">
10593: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10594: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10595: </h3></div></div></div>
1.75 rillig 10596: <p>The NetBSD package system comes with
1.91 rillig 10597: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75 rillig 10598: which helps to check the contents of these
10599: files. After installation it is quite easy to use, just change to the
10600: directory of the package you wish to examine and execute
10601: <span><strong class="command">pkglint</strong></span>:</p>
10602: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10603: looks fine.</pre>
10604: <p>Depending on the supplied command line arguments (see pkglint(1)),
10605: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10606: -Wall</strong></span> for a very thorough check.</p>
10607: </div>
10608: </div>
10609: <div class="sect1" lang="en">
10610: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10611: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10612: <p>Create the directory where the package lives,
10613: plus any auxiliary directories:</p>
10614: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10615: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10616: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10617: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10618: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10619: <code class="filename">PLIST</code> (see <a href="#components" title="Chapter 10. Package components - files, directories and contents">Chapter 10, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10620: then continue with fetching the distfile:</p>
10621: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10622: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10623: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10624: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10625: ftp: Error retrieving file: 500 Internal error
10626:
10627: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10628: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10629: ftp: Error retrieving file: 500 Internal error
10630:
10631: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10632: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10633: Successfully retrieved file.</pre>
10634: <p>Generate the checksum of the distfile into
1.76 rillig 10635: <code class="filename">distinfo</code>:</p>
1.88 wiz 10636: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10637: <p>Now compile:</p>
10638: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10639: >> Checksum OK for bison-1.25.tar.gz.
10640: ===> Extracting for bison-1.25
10641: ===> Patching for bison-1.25
10642: ===> Ignoring empty patch directory
10643: ===> Configuring for bison-1.25
10644: creating cache ./config.cache
10645: checking for gcc... cc
10646: checking whether we are using GNU C... yes
10647: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10648: checking how to run the C preprocessor... cc -E
10649: checking for minix/config.h... no
10650: checking for POSIXized ISC... no
10651: checking whether cross-compiling... no
10652: checking for ANSI C header files... yes
10653: checking for string.h... yes
10654: checking for stdlib.h... yes
10655: checking for memory.h... yes
10656: checking for working const... yes
10657: checking for working alloca.h... no
10658: checking for alloca... yes
10659: checking for strerror... yes
10660: updating cache ./config.cache
10661: creating ./config.status
10662: creating Makefile
10663: ===> Building for bison-1.25
10664: 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
10665: 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
10666: 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
10667: 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
10668: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10669: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
1.1 grant 10670: 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
10671: 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
10672: 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
10673: 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
10674: 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
10675: 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
10676: 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
10677: 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
10678: 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
10679: 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
10680: 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
10681: 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
10682: 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
10683: 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
10684: 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
10685: 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
10686: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10687: rm -f bison.s1
1.75 rillig 10688: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10689: <p>Everything seems OK, so install the files:</p>
10690: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10691: >> Checksum OK for bison-1.25.tar.gz.
10692: ===> Installing for bison-1.25
10693: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10694: rm -f /usr/pkg/bin/bison
10695: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10696: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10697: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10698: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10699: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10700: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10701: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10702: ===> Registering installation for bison-1.25</pre>
10703: <p>You can now use bison, and also - if you decide so - remove it with
10704: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10705: binary package, do this now:</p>
10706: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10707: >> Checksum OK for bison-1.25.tar.gz.
10708: ===> Building package for bison-1.25
10709: Creating package bison-1.25.tgz
10710: Registering depends:.
1.75 rillig 10711: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10712: <p>Now that you don't need the source and object files
10713: any more, clean up:</p>
10714: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10715: ===> Cleaning for bison-1.25</pre>
10716: </div>
10717: </div>
10718: <div class="appendix" lang="en">
10719: <div class="titlepage"><div><div><h2 class="title">
10720: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10721: <div class="toc">
10722: <p><b>Table of Contents</b></p>
10723: <dl>
10724: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10725: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10726: </dl>
10727: </div>
10728: <div class="sect1" lang="en">
10729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10730: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10731: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10732: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10733: => figlet221.tar.gz doesn't seem to exist on this system.
10734: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10735: => [172219 bytes]
10736: Connected to ftp.plig.net.
10737: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10738: 331 Guest login ok, send your complete e-mail address as password.
10739: 230-You are user #5 of 500 simultaneous users allowed.
10740: 230-
1.68 rillig 10741: 230- ___ _ _ _
10742: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10743: 230- | _| _| . |_| . | | | . |_| . | _| . |
10744: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10745: 230- |_| |_| |___| |___|
10746: 230-
10747: 230-** Welcome to ftp.plig.org **
10748: 230-
10749: 230-Please note that all transfers from this FTP site are logged. If you
10750: 230-do not like this, please disconnect now.
10751: 230-
10752: 230-This arhive is available via
10753: 230-
10754: 230-HTTP: http://ftp.plig.org/
10755: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10756: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10757: 230-
10758: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10759: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10760: 230-
10761: 230-
10762: 230 Logged in anonymously.
10763: Remote system type is UNIX.
10764: Using binary mode to transfer files.
10765: 200 Type okay.
10766: 250 "/pub" is new cwd.
10767: 250-"/pub/figlet" is new cwd.
10768: 250-
10769: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10770: 250-
1.75 rillig 10771: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10772: 250-
10773: 250-The official FIGlet web page is:
1.75 rillig 10774: 250- http://www.figlet.org/
1.1 grant 10775: 250-
10776: 250-If you have questions, please mailto:info@figlet.org. If you want to
10777: 250-contribute a font or something else, you can email us.
1.68 rillig 10778: 250
1.1 grant 10779: 250 "/pub/figlet/program" is new cwd.
10780: 250 "/pub/figlet/program/unix" is new cwd.
10781: local: figlet221.tar.gz remote: figlet221.tar.gz
10782: 502 Unimplemented command.
10783: 227 Entering Passive Mode (195,40,6,41,246,104)
10784: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10785: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10786: 226 Transfer completed.
10787: 172219 bytes received in 00:02 (75.99 KB/s)
10788: 221 Goodbye.
10789: => Checksum OK for figlet221.tar.gz.
10790: ===> Extracting for figlet-2.2.1nb2
10791: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10792: ===> Patching for figlet-2.2.1nb2
10793: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10794: ===> Overriding tools for figlet-2.2.1nb2
10795: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10796: ===> Configuring for figlet-2.2.1nb2
10797: ===> Building for figlet-2.2.1nb2
10798: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10799: chmod a+x figlet
10800: gcc -O2 -o chkfont chkfont.c
10801: => Unwrapping files-to-be-installed.
1.14 xtraeme 10802: <code class="prompt">#</code>
1.75 rillig 10803: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10804: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10805: ===> Installing for figlet-2.2.1nb2
10806: install -d -o root -g wheel -m 755 /usr/pkg/bin
10807: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10808: mkdir -p /usr/pkg/share/figlet
10809: cp figlet /usr/pkg/bin
10810: cp chkfont /usr/pkg/bin
10811: chmod 555 figlist showfigfonts
10812: cp figlist /usr/pkg/bin
10813: cp showfigfonts /usr/pkg/bin
10814: cp fonts/*.flf /usr/pkg/share/figlet
10815: cp fonts/*.flc /usr/pkg/share/figlet
10816: cp figlet.6 /usr/pkg/man/man6
10817: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10818: <code class="prompt">#</code></pre>
10819: </div>
10820: <div class="sect1" lang="en">
10821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10822: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10823: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10824: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10825: ===> Packaging figlet-2.2.1nb2
10826: ===> Building binary package for figlet-2.2.1nb2
10827: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10828: Using SrcDir value of /usr/pkg
1.68 rillig 10829: Registering depends:.
1.75 rillig 10830: <code class="prompt">#</code></pre>
10831: </div>
10832: </div>
10833: <div class="appendix" lang="en">
10834: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10835: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10836: <div class="toc">
10837: <p><b>Table of Contents</b></p>
10838: <dl>
10839: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10840: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10841: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10842: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102 rillig 10843: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.76 rillig 10844: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 10845: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10846: source packages</a></span></dt>
10847: </dl>
10848: </div>
10849: <p>As in other big projects, the directory layout of pkgsrc
10850: is quite complex for newbies. This chapter explains where you
10851: find things on the FTP server. The base directory on
1.89 rillig 10852: <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>.
10853: On other servers it may be different, but inside this directory,
10854: everything should look the same, no matter on which server you
10855: are. This directory contains some subdirectories, which are
10856: explained below.</p>
1.76 rillig 10857: <div class="sect1" lang="en">
10858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10859: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10860: <p>For those who only want to manage binary packages on
10861: systems other than NetBSD, we provide the package management
10862: tools in a separate, small tar file.</p>
10863: </div>
10864: <div class="sect1" lang="en">
10865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10866: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10867: <p>The directory <code class="filename">distfiles</code> contains lots
10868: of archive files from all pkgsrc packages, which are mirrored
10869: here. The subdirectories are called after their package names
10870: and are used when the distributed files have names that don't
10871: explicitly contain a version number or are otherwise too generic
10872: (for example <code class="filename">release.tar.gz</code>).</p>
10873: </div>
10874: <div class="sect1" lang="en">
10875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10876: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10877: <p>This directory is currently not in use.</p>
10878: </div>
10879: <div class="sect1" lang="en">
10880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10881: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10882: <p>This directory contains things that individual pkgsrc
10883: developers find worth publishing.</p>
10884: </div>
10885: <div class="sect1" lang="en">
10886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102 rillig 10887: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10888: <p>This directory contains binary packages for the various
10889: platforms that are supported by pkgsrc.
10890: 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>
10891: <div class="itemizedlist"><ul type="disc">
10892: <li><p><code class="varname">OPSYS</code> is the name of the operating system for which the packages have been built,</p></li>
10893: <li><p><code class="varname">ARCH</code> is the hardware architecture,</p></li>
10894: <li><p><code class="varname">OSVERSION</code> is the version of the operating system,</p></li>
10895: <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>
10896: </ul></div>
10897: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10898: can quickly click through the directories on the
10899: server and find the best binary packages for their machines. Since they
10900: usually know the operating system and the hardware architecture, OPSYS
10901: and ARCH are placed first. After these choices, they can select the
10902: best combination of OSVERSION and TAG together, since it is usually the
10903: case that packages stay compatible between different version of the
10904: operating system.</p>
10905: <p>In each of these directories, there is a
10906: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10907: <code class="filename">All</code> which contains all binary packages.
10908: Besides that, there are various category directories that
10909: contain symbolic links to the real binary packages.</p>
10910: </div>
10911: <div class="sect1" lang="en">
10912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10913: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93 rillig 10914: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10915: source packages</h2></div></div></div>
10916: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10917: that is the files that define how to create binary packages from
10918: source archives.</p>
10919: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10920: snapshot of the CVS repository, which is updated regularly. The
10921: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10922: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10923: <p>In the directories for the quarterly branches, there is an
10924: additional file called
10925: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10926: which contains the state of pkgsrc when it was branched.</p>
10927: </div>
1.75 rillig 10928: </div>
10929: <div class="appendix" lang="en">
10930: <div class="titlepage"><div><div><h2 class="title">
10931: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10932: <div class="toc">
10933: <p><b>Table of Contents</b></p>
10934: <dl>
1.79 rillig 10935: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10936: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10937: </dl>
10938: </div>
1.79 rillig 10939: <p>This section contains information on editing the pkgsrc
10940: guide itself.</p>
1.75 rillig 10941: <div class="sect1" lang="en">
10942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10943: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10944: <p>The pkgsrc guide's source code is stored in
10945: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10946: are created from it:</p>
10947: <div class="itemizedlist"><ul type="disc">
10948: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10949: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.101 rillig 10950: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
10951: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 10952: The PDF version of the pkgsrc guide.</p></li>
1.101 rillig 10953: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 10954: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10955: </ul></div>
10956: </div>
10957: <div class="sect1" lang="en">
10958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10959: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10960: <p>The procedure to edit the pkgsrc guide is:</p>
10961: <div class="procedure"><ol type="1">
10962: <li><p>Make sure you have the packages needed to
1.83 wiz 10963: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 10964: 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
10965: 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
1.79 rillig 10966: PostScript and PDF versions. You will need both packages
10967: installed, to make sure documentation is consistent across all
10968: formats.</p></li>
10969: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
10970: right directory. All further steps will take place
10971: here.</p></li>
10972: <li><p>Edit the XML file(s) in
10973: <code class="filename">files/</code>.</p></li>
10974: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
10975: guide for valid XML and to build the final output files. If you
10976: get any errors at this stage, you can just edit the files, as
10977: there are only symbolic links in the working directory, pointing
10978: to the files in <code class="filename">files/</code>.</p></li>
10979: <li><p><span><strong class="command">(cd files && cvs
10980: commit)</strong></span></p></li>
10981: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
10982: regenerate the output files with the proper RCS
10983: Ids.</p></li>
1.91 rillig 10984: <li>
10985: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
10986: commit the files in both <code class="filename">pkgsrc/doc</code> and
10987: <code class="filename">htdocs</code>.</p>
10988: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10989: <h3 class="title">Note</h3>
10990: <p>If you have added, removed or renamed some chapters,
1.83 wiz 10991: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
10992: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 rillig 10993: directory.</p>
10994: </div>
10995: </li>
1.79 rillig 10996: </ol></div>
1.75 rillig 10997: </div>
10998: </div>
10999: </div></body>
1.1 grant 11000: </html>
CVSweb <webmaster@jp.NetBSD.org>