Annotation of pkgsrc/doc/pkgsrc.html, revision 1.104
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.104 ! rillig 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.104 ! rillig 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.75 rillig 1365: </div>
1366: <div class="sect3" lang="en">
1367: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1368: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1369: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1370: system, normally HFS+. It is possible to use the default
1371: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1372: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1373: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1374: place the package database directory outside the
1375: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1376: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1377: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1378: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1379: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1380: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1381: to ensure that the partition map correctly reflects
1.89 rillig 1382: “<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 1383: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1384: disk that is booted from. You can unmount the partition, but even if
1385: you newfs it, the partition type will be incorrect and the
1386: automounter won't mount it. It can be mounted manually, but it won't
1387: appear in Finder.</p>
1.75 rillig 1388: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1389: the Installation program starts, go up to the menu and select Disk
1390: Utility. Now, you will be able to select the partition you want
1.89 rillig 1391: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1392: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1393: will appear in Finder.</p>
1.75 rillig 1394: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1395: by root only.</p>
1.75 rillig 1396: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1397: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1398: </div>
1399: </div>
1400: <div class="sect2" lang="en">
1401: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1402: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1403: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1404: other versions may work.</p>
1.75 rillig 1405: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1406: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1407: <div class="orderedlist"><ol type="1">
1408: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1409: <code class="filename">/var/db/pkg</code>. It is therefore
1410: recommended that you choose a different location (e.g.
1411: <code class="filename">/usr/pkgdb</code>) by
1412: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1413: <li>
1414: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1415: good idea to move them out of the way to avoid confusion, e.g.</p>
1416: <pre class="screen">
1417: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1418: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1419: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1420: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1421: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1422: </pre>
1.75 rillig 1423: </li>
1.104 ! rillig 1424: <li><p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1425: <code class="filename">/etc/mk.conf.example</code> file
1426: when you use the bootstrap script.</p></li>
1.75 rillig 1427: </ol></div>
1428: </div>
1429: <div class="sect2" lang="en">
1430: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1431: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1432: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1433: providing a Unix-like environment with a tighter kernel integration than
1434: available with Cygwin. It is part of the Windows Services for Unix
1435: package, available for free for any licensed copy of Windows 2000, XP
1436: (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 1437: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1438: are not officially supported. (The main difference in 3.0/3.1 is lack
1439: of pthreads, but other parts of libc may also be lacking.)</p>
1440: <p>Services for Unix Applications (aka SUA) is an integrated component
1441: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1442: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1443: <div class="sect3" lang="en">
1444: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1445: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1446: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1447: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1448: <div class="itemizedlist"><ul type="disc">
1449: <li><p>Utilities -> Base Utilities</p></li>
1450: <li><p>Interix GNU Components -> (all)</p></li>
1451: <li><p>Remote Connectivity</p></li>
1452: <li><p>Interix SDK</p></li>
1453: </ul></div>
1454: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1455: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1456: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1457: pkgsrc (or from a binary package).</p>
1.75 rillig 1458: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1459: not need to be installed, but Remote Connectivity itself should be
1460: installed in order to have a working inetd.</p>
1.75 rillig 1461: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1462: behavior for Interix programs, and whether to make pathnames default to
1463: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1464: enabled. (Without case-sensitivity, a large number of packages including
1465: perl will not build.)</p>
1.75 rillig 1466: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1467: works (via the Data Execution Prevention feature). In order to use
1468: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1469: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1470: must be installed. Hotfixes are available from Microsoft through a
1471: support contract; however, a NetBSD developer has made most Interix
1472: 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 1473: <p>In addition to the hotfix noted above, it may be necessary to
1474: disable Data Execution Prevention entirely to make Interix functional.
1475: This may happen only with certain types of CPUs; the cause is not fully
1476: understood at this time. If gcc or other applications still segfault
1477: repeatedly after installing one of the hotfixes note above, the
1478: following option can be added to the appropriate "boot.ini" line on the
1479: Windows boot drive: /NoExecute=AlwaysOff
1480: (WARNING, this will disable DEP completely, which may be a security
1481: risk if applications are often run as a user in the Administrators
1482: group!)</p>
1.75 rillig 1483: </div>
1484: <div class="sect3" lang="en">
1485: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1486: <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 1487: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1488: with pkgsrc, note the following things.</p>
1.75 rillig 1489: <div class="itemizedlist"><ul type="disc">
1490: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1491: Windows Services for UNIX, then click Change. In the installer, choose
1492: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1493: <li>
1494: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1495: change the following registry key:</p>
1.75 rillig 1496: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1497: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1498: </li>
1499: <li>
1500: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1501: following registry key:</p>
1.75 rillig 1502: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1503: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1504: </li>
1505: </ul></div>
1506: </div>
1507: <div class="sect3" lang="en">
1508: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1509: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1510: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1511: running "pkg_add") must be a member of the local Administrators
1512: group. Such a user must also be used to run the bootstrap. This is
1513: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1514: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1515: automatically complain if this is not the case. This ensures that
1516: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1517: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1518: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1519: NOT be used in conjunction with pkgsrc. If you choose to use them at
1520: the same time as the pkgsrc packages, ensure that you use the proper
1521: pkg_* tools for each type of binary package.</p>
1.75 rillig 1522: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1523: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1524: don't have a termcap/terminfo entry for it, but the following .termcap
1525: entry provides adequate emulation in most cases:</p>
1.75 rillig 1526: <pre class="programlisting">
1.100 rillig 1527: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1528: </pre>
1.75 rillig 1529: </div>
1530: <div class="sect3" lang="en">
1531: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1532: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1533: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1534: for a full Unix-like platform, it has some drawbacks that should
1535: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1536: <div class="itemizedlist"><ul type="disc">
1537: <li>
1538: <p><span class="strong"><strong>X11:</strong></span></p>
1539: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1540: and can run X11 based applications, but it does
1541: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1542: <a href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1543: <a href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1544: (available in a trimmed version for Interix from Interop Systems as the
1545: <a href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1546: and the free X11 server included with
1547: <a href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1548: </li>
1549: <li>
1550: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1551: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1552: Win32 applications, it does not currently support various X11
1553: protocol extensions for acceleration (such as MIT-SHM or DGA).
1554: Most interactive applications to a local X server will run
1555: reasonably fast, but full motion video and other graphics
1556: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1557: </li>
1558: <li>
1559: <p><span class="strong"><strong>Audio:</strong></span></p>
1560: <p>Interix has no native support for audio output. For audio
1.87 wiz 1561: support, pkgsrc uses the <span><strong class="command">esound</strong></span> client/server
1562: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1563: <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 1564: <span class="emphasis"><em>not</em></span> contain the <span><strong class="command">esd</strong></span>
1565: server component. To output audio via an Interix host, the
1.91 rillig 1566: <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 1567: must also be installed.</p>
1.75 rillig 1568: </li>
1569: <li>
1570: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1571: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1572: is not currently possible to access CD/DVD drives, USB devices,
1573: or SCSI devices through non-filesystem means. Among other things,
1574: this makes it impossible to use Interix directly for CD/DVD
1575: burning.</p>
1.75 rillig 1576: </li>
1577: <li>
1578: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1579: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1580: drives are also not directly accessible in Interix. However,
1581: support is in work to make tape drive access possible by using
1582: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1583: esound server).</p>
1.75 rillig 1584: </li>
1585: </ul></div>
1586: </div>
1587: <div class="sect3" lang="en">
1588: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1589: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1590: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1591: Windows system; any member of the local Administrators group will
1592: suffice. However, some packages currently assume that the user
1593: named "root" is the privileged user. To accommodate these, you
1594: may create such a user; make sure it is in the local group
1595: Administrators (or your language equivalent).</p>
1596: <p><span><strong class="command">pkg_add</strong></span> creates directories of mode
1597: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1598: time being, install packages as the local Administrator (or
1599: your language equivalent), or run the following command after
1600: installing a package to work around the issue:</p>
1.75 rillig 1601: <pre class="screen">
1.87 wiz 1602: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1603: </pre>
1.75 rillig 1604: </div>
1605: </div>
1606: <div class="sect2" lang="en">
1607: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1608: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1609: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1610: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1611: according to your preference. If you do not have a license for the MIPSpro
1612: 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 1613: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.87 wiz 1614: 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>,
1615: etc.</p>
1.86 schwarz 1616: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1617: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1618: you start out using "abi=n32", that's what all your packages will be built
1619: with.</p>
1620: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1621: <code class="varname">CFLAGS</code> in your environment or the
1.104 ! rillig 1622: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1623: try to link n32 object files with lib64 or vice versa. Check your
1624: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1625: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1626: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1627: as it appears that IRIX linker occasionally runs into issues when trying to
1628: link over a network-mounted file system.</p>
1.75 rillig 1629: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1630: as imake(1), but you may want to set some options depending on your local
1631: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1632: course, your compiler's man pages for details.</p>
1.75 rillig 1633: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1634:
1.87 wiz 1635: </p>
1.75 rillig 1636: <pre class="programlisting">
1.100 rillig 1637: PKGSRC_COMPILER= mipspro
1.87 wiz 1638: </pre>
1.75 rillig 1639: <p>
1.1 grant 1640:
1.104 ! rillig 1641: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1642: are using gcc and may end up passing invalid flags to the compiler. Note that
1643: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1644: default.</p>
1.75 rillig 1645: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1646: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1647: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1648: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1649: '--preserve-path' flag.</p>
1.75 rillig 1650: </div>
1651: <div class="sect2" lang="en">
1652: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1653: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1654: <p>Some versions of Linux (for example Debian GNU/Linux) need
1655: either libtermcap or libcurses (libncurses). Installing the
1656: distributions libncurses-dev package (or equivalent) should fix
1657: the problem.</p>
1658: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1659: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1660: i386 have been tested.</p>
1.75 rillig 1661: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1662: directory:</p>
1.75 rillig 1663: <pre class="programlisting">
1.100 rillig 1664: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1665: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1666: </pre>
1.75 rillig 1667: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1668: <h3 class="title">Note</h3>
1669: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1670: </div>
1671: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1672: function, which icc does not support. #undef'ing __attribute__ has the
1673: unfortunate side-effect of breaking many of the Linux header files, which
1674: cannot be compiled properly without __attribute__. The test must be
1675: overridden so that __attribute__ is assumed supported by the
1676: compiler.</p>
1.75 rillig 1677: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.104 ! rillig 1678: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1679: <pre class="programlisting">
1.100 rillig 1680: PKGSRC_COMPILER= icc
1.87 wiz 1681: </pre>
1.75 rillig 1682: <p>The default installation directory for icc is
1.87 wiz 1683: <code class="filename">/opt/intel_cc_80</code>, which
1684: is also the pkgsrc default. If you have installed it into a different
1685: directory, set <code class="varname">ICCBASE</code> in
1.104 ! rillig 1686: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1687: <pre class="programlisting">
1.100 rillig 1688: ICCBASE= /opt/icc
1.87 wiz 1689: </pre>
1.75 rillig 1690: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1691: provided by icc, so binaries can be run on other systems which do not
1692: have the shared libraries installed.</p>
1693: <p>Libtool, however, extracts a list of libraries from the
1694: <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
1695: records it, throwing away the -Bstatic and -Bdynamic options
1696: interspersed between the libraries. This means that
1697: libtool-linked C++ shared libraries will have a runtime
1698: dependency on the icc libraries until this is fixed in
1699: libtool.</p>
1.75 rillig 1700: </div>
1701: <div class="sect2" lang="en">
1702: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1703: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1704: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1705: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1706: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1707: <div class="orderedlist"><ol type="1">
1708: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1709: <code class="filename">/var/db/pkg</code>. It is therefore
1710: recommended that you choose a different location (e.g.
1711: <code class="filename">/usr/pkgdb</code>) by
1712: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1713: <li>
1714: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1715: good idea to move them out of the way to avoid confusion, e.g.</p>
1716: <pre class="screen">
1717: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1718: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1719: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1720: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1721: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1722: </pre>
1.75 rillig 1723: </li>
1724: <li>
1.104 ! rillig 1725: <p>An example <a href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1726: <code class="filename">/etc/mk.conf.example</code> file
1727: when you use the bootstrap script. OpenBSD's make program uses
1.104 ! rillig 1728: <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1729: as well. You can work around this by enclosing all the pkgsrc-specific parts
1730: of the file with:</p>
1731: <pre class="programlisting">
1.100 rillig 1732: .ifdef BSD_PKG_MK
1733: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1734: .else
1735: # OpenBSD stuff
1736: .endif
1.87 wiz 1737: </pre>
1.75 rillig 1738: </li>
1739: </ol></div>
1740: </div>
1741: <div class="sect2" lang="en">
1742: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1743: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1744: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1745: You will need a working C compiler. Both gcc 2.95.3 and
1746: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1747: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1748: process and to build packages.</p>
1.75 rillig 1749: <div class="itemizedlist"><ul type="disc">
1750: <li><p>SUNWsprot</p></li>
1751: <li><p>SUNWarc</p></li>
1752: <li><p>SUNWbtool</p></li>
1753: <li><p>SUNWtoo</p></li>
1754: <li><p>SUNWlibm</p></li>
1755: </ul></div>
1.78 rillig 1756: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1757: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1758: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1759: your $prefix are in your <code class="varname">PATH</code>. This includes
1760: <code class="filename">/usr/ccs/{bin,lib}</code>
1761: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1762: <div class="sect3" lang="en">
1763: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1764: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1765: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1766: for building all packages.</p>
1.75 rillig 1767: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1768: then either build gcc from
1.91 rillig 1769: <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 1770: package, then remove gcc used during bootstrapping.</p>
1.93 rillig 1771: <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 1772: </div>
1773: <div class="sect3" lang="en">
1774: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1775: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1776: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1777: 5.0)</p>
1.75 rillig 1778: <div class="itemizedlist"><ul type="disc">
1779: <li><p>SPROcc
1.87 wiz 1780: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1781: <li><p>SPROcpl
1.87 wiz 1782: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1783: <li><p>SPROild
1.87 wiz 1784: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1785: <li><p>SPROlang
1.87 wiz 1786: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1787: </ul></div>
1.96 rillig 1788: <p>You should set the following variables in your
1.104 ! rillig 1789: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1790: <pre class="programlisting">
1.100 rillig 1791: CC= cc
1792: CXX= CC
1793: CPP= cc -E
1794: CXXCPP= CC -E
1.96 rillig 1795: </pre>
1796: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1797: <h3 class="title">Note</h3>
1798: <p>The <code class="varname">CPP</code> setting might break some
1799: packages that use the C preprocessor for processing things other
1800: than C source code.</p>
1801: </div>
1.75 rillig 1802: </div>
1803: <div class="sect3" lang="en">
1804: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1805: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1806: <p>To build 64-bit packages, you just need to have the
1.104 ! rillig 1807: following lines in your <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1808: <pre class="programlisting">
1.100 rillig 1809: PKGSRC_COMPILER= sunpro
1810: ABI= 64
1.96 rillig 1811: </pre>
1812: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1813: <h3 class="title">Note</h3>
1814: <p>This setting has been tested for the SPARC
1815: architecture. Intel and AMD machines need some more
1816: work.</p>
1817: </div>
1.75 rillig 1818: </div>
1819: <div class="sect3" lang="en">
1820: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1821: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.75 rillig 1822: <p>Sometimes, when using <span><strong class="command">libtool</strong></span>,
1.87 wiz 1823: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1824: The workaround is to use another shell for the configure
1.91 rillig 1825: 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 1826: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1827: <pre class="programlisting">
1.100 rillig 1828: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1829: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1830: </pre>
1.91 rillig 1831: <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 1832: </div>
1833: </div>
1834: </div>
1835: </div>
1836: <div class="chapter" lang="en">
1837: <div class="titlepage"><div><div><h2 class="title">
1838: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1839: <div class="toc">
1840: <p><b>Table of Contents</b></p>
1841: <dl>
1842: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1843: <dd><dl>
1844: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1845: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1846: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1847: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1848: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1849: <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>
1850: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1851: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1852: </dl></dd>
1853: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1854: <dd><dl>
1855: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1856: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1857: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1858: </dl></dd>
1859: </dl>
1860: </div>
1861: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1862: is to only install the package tools and to use binary packages
1863: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1864: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1865: of pkgsrc, too. Then you are able to build your own packages,
1866: and you can still use binary packages from someone else.</p>
1.75 rillig 1867: <div class="sect1" lang="en">
1868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1869: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1870: <p>To use binary packages, you need some tools to manage
1.88 wiz 1871: them. On NetBSD, these tools are already installed. On all other
1872: operating systems, you need to install them first. For the
1873: following platforms, prebuilt versions of the package tools
1874: are available and can simply be downloaded and unpacked in the
1875: <code class="filename">/</code> directory:</p>
1.75 rillig 1876: <div class="informaltable">
1877: <a name="binary-bootstrap-kits"></a><table border="1">
1878: <colgroup>
1879: <col>
1880: <col>
1881: </colgroup>
1882: <thead><tr>
1883: <th>Platform</th>
1884: <th>URL</th>
1885: </tr></thead>
1886: <tbody>
1887: <tr>
1888: <td>Solaris 9</td>
1.76 rillig 1889: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1890: </tr>
1891: <tr>
1892: <td>Solaris 10</td>
1.76 rillig 1893: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/</code></td>
1.75 rillig 1894: </tr>
1895: </tbody>
1896: </table>
1897: </div>
1.82 rillig 1898: <p>These pre-built package tools use
1.88 wiz 1899: <code class="filename">/usr/pkg</code> for the base directory, and
1900: <code class="filename">/var/db/pkg</code> for the database of installed
1901: packages. If you cannot use these directories for whatever
1902: reasons (maybe because you're not root), you have to build the
1903: package tools yourself, which is explained in <a href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.75 rillig 1904: <div class="sect2" lang="en">
1905: <div class="titlepage"><div><div><h3 class="title">
1906: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1907: <p>To install binary packages, you first need to know from
1.88 wiz 1908: where to get them. You can get them on CD-ROMs, DVDs, or via FTP
1909: or HTTP.</p>
1.81 rillig 1910: <p>The binary packages can be found at the following
1.88 wiz 1911: locations.</p>
1.75 rillig 1912: <div class="informaltable">
1913: <a name="binary-packages"></a><table border="1">
1914: <colgroup>
1915: <col>
1916: <col>
1917: </colgroup>
1918: <thead><tr>
1919: <th>Platform</th>
1920: <th>URL</th>
1921: </tr></thead>
1922: <tbody>
1923: <tr>
1.81 rillig 1924: <td>NetBSD</td>
1925: <td><code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/</code></td>
1926: </tr>
1927: <tr>
1.75 rillig 1928: <td>Solaris 9</td>
1.76 rillig 1929: <td><code class="filename">ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/</code></td>
1.75 rillig 1930: </tr>
1931: <tr>
1932: <td>Solaris 10</td>
1.76 rillig 1933: <td><code class="filename">http://public.enst.fr/pkgsrc/packages/</code></td>
1.75 rillig 1934: </tr>
1935: </tbody>
1936: </table>
1937: </div>
1.81 rillig 1938: <p>Most of these directories contain binary packages for
1.88 wiz 1939: multiple platforms. Select the appropriate subdirectories,
1940: according to your machine architecture and operating system,
1941: until you find a directory called <code class="filename">All</code>. This
1942: directory contains all the binary packages. Further, there are
1943: subdirectories for categories that contain symbolic links that
1944: point to the actual binary package in
1945: <code class="filename">../All</code>. This directory layout is used for
1946: all package repositories, no matter if they are accessed via
1947: HTTP, FTP, NFS, CD-ROM, or the local filesystem.</p>
1.75 rillig 1948: </div>
1949: <div class="sect2" lang="en">
1950: <div class="titlepage"><div><div><h3 class="title">
1951: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.87 wiz 1952: <p>If you have the files on a CD-ROM or downloaded them to
1.88 wiz 1953: your hard disk, you can install them with the following command
1954: (be sure to <span><strong class="command">su</strong></span> to root first):</p>
1.75 rillig 1955: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add /path/to/package.tgz</code></strong></pre>
1.87 wiz 1956: <p>If you have FTP access and you don't want to download the
1.88 wiz 1957: packages via FTP prior to installation, you can do this
1958: automatically by giving <span><strong class="command">pkg_add</strong></span> an FTP URL:</p>
1.82 rillig 1959: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All/package</code></strong></pre>
1.75 rillig 1960: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1961: package in question will be installed, too, assuming they are
1962: present where you install from.</p>
1.75 rillig 1963: <p>To save some typing, you can set the
1.88 wiz 1964: <code class="varname">PKG_PATH</code> environment variable to a semicolon-separated
1965: list of paths (including remote URLs); trailing slashes are not allowed.
1966: </p>
1.76 rillig 1967: <p>Additionally to the <code class="filename">All</code> directory
1.88 wiz 1968: there exists a <code class="filename">vulnerable</code> directory to
1969: which binary packages with known vulnerabilities are
1970: moved, since removing them could cause missing dependencies. To
1971: use these packages, add the <code class="filename">vulnerable</code>
1972: directory to your <code class="varname">PKG_PATH</code>. However, you should run
1.91 rillig 1973: <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 1974: especially after installing new packages, and verify that the
1975: vulnerabilities are acceptable for your configuration. An example
1976: <code class="varname">PKG_PATH</code> would be:
1977: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable</code>
1978: Please note that semicolon (';') is a shell meta-character, so
1979: you'll probably have to quote it.</p>
1.75 rillig 1980: <p>After you've installed packages, be sure to have
1.88 wiz 1981: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1982: <code class="varname">PATH</code> so you can actually start the just
1983: installed program.</p>
1.75 rillig 1984: </div>
1985: <div class="sect2" lang="en">
1986: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1987: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1988: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1989: installed from source code or from a binary package. The
1990: <span><strong class="command">pkg_delete</strong></span> command does not know it anyway.
1991: To delete a package, you can just run <span><strong class="command">pkg_delete
1992: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1993: name can be given with or without version number. Wildcards can
1994: also be used to deinstall a set of packages, for example
1995: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1996: so that the shell does not expand them before
1997: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1998: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1999: removes all the packages that require the package in question
2000: and then removes the package itself. For example:
1.82 rillig 2001:
1.88 wiz 2002: </p>
1.82 rillig 2003: <pre class="screen">
1.88 wiz 2004: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
2005: </pre>
1.82 rillig 2006: <p>
2007:
1.88 wiz 2008: will remove jpeg and all the packages that used it; this allows
2009: upgrading the jpeg package.</p>
1.82 rillig 2010: </div>
2011: <div class="sect2" lang="en">
2012: <div class="titlepage"><div><div><h3 class="title">
2013: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
2014: <p>The <span><strong class="command">pkg_info</strong></span> shows information about
1.88 wiz 2015: installed packages or binary package files.</p>
1.82 rillig 2016: </div>
2017: <div class="sect2" lang="en">
2018: <div class="titlepage"><div><div><h3 class="title">
2019: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
2020: <p>
1.88 wiz 2021: The NetBSD Security-Officer and Packages Groups maintain a list of
2022: known security vulnerabilities to packages which are (or have been)
2023: included in pkgsrc. The list is available from the NetBSD
2024: FTP site at <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
2025: </p>
1.82 rillig 2026: <p>
1.93 rillig 2027: 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 2028: this list can be downloaded
2029: automatically, and a security audit of all packages installed on a system
2030: can take place.
2031: </p>
1.82 rillig 2032: <p>
1.93 rillig 2033: There are two components to
1.91 rillig 2034: <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 2035: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
2036: the list of vulnerabilities from the NetBSD FTP site. The second
2037: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
2038: installed packages are vulnerable. If a package is vulnerable, you
2039: will see output similar to the following:
2040: </p>
1.82 rillig 2041: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 2042: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 2043: <p>
1.91 rillig 2044: 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 2045: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
2046: file daily, and include a package audit in the daily security script.
2047: 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 2048: 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 2049: </p>
1.82 rillig 2050: </div>
2051: <div class="sect2" lang="en">
2052: <div class="titlepage"><div><div><h3 class="title">
2053: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
2054: <p>
1.93 rillig 2055: 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 2056: <span><strong class="command">lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
2057: argument to check if your packages are up-to-date, e.g.
2058: </p>
2059: <pre class="screen">
2060: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 2061: ...
1.88 wiz 2062: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
2063: </pre>
1.82 rillig 2064: <p>You can then use <span><strong class="command">make update</strong></span> to update the
1.88 wiz 2065: package on your system and rebuild any dependencies.
2066: </p>
1.82 rillig 2067: </div>
2068: <div class="sect2" lang="en">
2069: <div class="titlepage"><div><div><h3 class="title">
2070: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
2071: <p>The <span><strong class="command">pkg_admin</strong></span> executes various
1.88 wiz 2072: administrative functions on the package system.</p>
1.82 rillig 2073: </div>
2074: <div class="sect2" lang="en">
2075: <div class="titlepage"><div><div><h3 class="title">
2076: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 2077: <p>Please pay very careful attention to the warnings
1.88 wiz 2078: 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
2079: inherent dangers of installing binary packages which you did
2080: not create yourself, and the security holes that can be
2081: introduced onto your system by indiscriminate adding of such
2082: files.</p>
1.75 rillig 2083: <p>The same warning of course applies to every package you
1.88 wiz 2084: install from source when you haven't completely read and
2085: understood the source code of the package, the compiler that
2086: is used to build the package and all the other tools that are
2087: involved.</p>
1.75 rillig 2088: </div>
2089: </div>
2090: <div class="sect1" lang="en">
2091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2092: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 2093: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
2094: directory now contains a set of packages, organized into
2095: categories. You can browse the online index of packages, or run
2096: <span><strong class="command">make readme</strong></span> from the <code class="filename">pkgsrc</code>
2097: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 2098: 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 2099: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
2100: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
2101: should do so by setting <code class="varname">LOCALBASE</code> in
1.104 ! rillig 2102: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 2103: different <code class="varname">LOCALBASE</code> definitions on the same
2104: system (inside a chroot is an exception). </p>
2105: <p>The rest of this chapter assumes that the package is already
2106: 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
2107: instructions how to create your own packages.</p>
1.75 rillig 2108: <div class="sect2" lang="en">
2109: <div class="titlepage"><div><div><h3 class="title">
2110: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 2111: <p>To build packages from source, you need a working C
1.88 wiz 2112: compiler. On NetBSD, you need to install the
2113: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
2114: sets. If you want to build X11-related packages, the
2115: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
2116: sets are required, too.</p>
1.75 rillig 2117: </div>
2118: <div class="sect2" lang="en">
2119: <div class="titlepage"><div><div><h3 class="title">
2120: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
2121: <p>The first step for building a package is downloading the
1.88 wiz 2122: distfiles (i.e. the unmodified source). If they have not yet been
2123: downloaded, pkgsrc will fetch them automatically.</p>
2124: <p>If you have all files that you need in the
2125: <code class="filename">distfiles</code> directory,
2126: you don't need to connect. If the distfiles are on CD-ROM, you can
2127: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
2128: </p>
1.82 rillig 2129: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
2130: <p>
1.104 ! rillig 2131: to your <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 2132: <p>By default a list of distribution sites will be randomly
2133: intermixed to prevent huge load on servers which holding popular
2134: packages (for example, SourceForge.net mirrors). Thus, every
2135: time when you need to fetch yet another distfile all the mirrors
2136: will be tried in new (random) order. You can turn this feature
2137: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
2138: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 2139: <p>You can overwrite some of the major distribution sites to
2140: fit to sites that are close to your own. By setting one or two
2141: variables you can modify the order in which the master sites are
2142: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
2143: delimited list of domain suffixes.
2144: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
2145: contains a whitespace delimited list of regular expressions. It
2146: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
2147: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
2148: some examples. This may save some of your bandwidth and
2149: time.</p>
1.75 rillig 2150: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 2151: if you want to keep the settings, by editing the
1.104 ! rillig 2152: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 2153: and adding the definitions there.</p>
1.82 rillig 2154: <p>
1.88 wiz 2155: If a package depends on many other packages (such as
1.93 rillig 2156: <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 2157: alternate between periods of
2158: downloading source, and compiling. To ensure you have all the source
2159: downloaded initially you can run the command:
2160: </p>
1.82 rillig 2161: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
2162: <p>
1.88 wiz 2163: which will output and run a set of shell commands to fetch the
2164: necessary files into the <code class="filename">distfiles</code> directory. You can
2165: also choose to download the files manually.
2166: </p>
1.75 rillig 2167: </div>
2168: <div class="sect2" lang="en">
2169: <div class="titlepage"><div><div><h3 class="title">
2170: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 2171: <p>
1.88 wiz 2172: Once the software has downloaded, any patches will be applied, then it
2173: will be compiled for you. This may take some time depending on your
2174: computer, and how many other packages the software depends on and their
2175: compile time.
2176: </p>
1.75 rillig 2177: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2178: <h3 class="title">Note</h3>
2179: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.88 wiz 2180: use the pkgsrc <span><strong class="command">bmake</strong></span> command instead of
2181: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 2182: </div>
1.87 wiz 2183: <p>For example, type</p>
1.88 wiz 2184: <pre class="screen">
2185: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2186: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2187: </pre>
1.75 rillig 2188: <p>at the shell prompt to build the various components of the
1.88 wiz 2189: package.</p>
1.82 rillig 2190: <p>The next stage is to actually install the newly compiled
1.88 wiz 2191: program onto your system. Do this by entering:
1.82 rillig 2192:
1.88 wiz 2193: </p>
1.82 rillig 2194: <pre class="screen">
1.88 wiz 2195: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2196: </pre>
1.82 rillig 2197: <p>
2198:
1.88 wiz 2199: while you are still in the directory for whatever package you
2200: are installing.</p>
1.82 rillig 2201: <p>Installing the package on your system may require you to
1.88 wiz 2202: be root. However, pkgsrc has a
2203: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2204: to only become root for the actual installation step.</p>
1.82 rillig 2205: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 2206: You can now enter:
1.82 rillig 2207:
1.88 wiz 2208: </p>
1.82 rillig 2209: <pre class="screen">
1.88 wiz 2210: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2211: </pre>
1.82 rillig 2212: <p>
2213:
1.88 wiz 2214: to remove the compiled files in the work directory, as you shouldn't need
2215: them any more. If other packages were also added to your system
2216: (dependencies) to allow your program to compile, you can tidy these up
2217: also with the command:</p>
1.82 rillig 2218: <pre class="screen">
1.88 wiz 2219: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2220: </pre>
1.75 rillig 2221: <p>Taking the figlet utility as an example, we can install it on our
1.88 wiz 2222: system by building as shown in <a href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
2223: <p>The program is installed under the default root of the
2224: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2225: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2226: variable in your environment, and it will use that value as the
2227: root of your packages tree. So, to use
2228: <code class="filename">/usr/local</code>, set
2229: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2230: Please note that you should use a directory which is dedicated to
2231: packages and not shared with other programs (i.e., do not try and
2232: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2233: to add any of your own files or directories (such as
2234: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2235: <code class="filename">pkgsrc/</code>) below the
2236: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2237: conflicts between programs and other files installed by the
2238: package system and whatever else may have been installed
2239: there.</p>
1.104 ! rillig 2240: <p>Some packages look in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2241: alter some configuration options at build time. Have a look at
2242: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2243: of what will be set there by default. Environment variables such
2244: as <code class="varname">LOCALBASE</code> can be set in
1.104 ! rillig 2245: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2246: set them each time you want to use pkgsrc.</p>
2247: <p>Occasionally, people want to “<span class="quote">look under the
2248: covers</span>” to see what is going on when a package is building
2249: or being installed. This may be for debugging purposes, or out of
2250: simple curiosity. A number of utility values have been added to
2251: help with this.</p>
1.75 rillig 2252: <div class="orderedlist"><ol type="1">
2253: <li>
1.88 wiz 2254: <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
2255: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2256: information will be displayed. For example,</p>
1.75 rillig 2257: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2258: <p>will show all the commands that are invoked, up to and
2259: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2260: </li>
2261: <li>
1.88 wiz 2262: <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>
2263: definition, then the <code class="varname">VARNAME</code> definition
2264: should be used, in conjunction with the show-var
2265: 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>
2266: variable <code class="varname">LOCALBASE</code>:</p>
2267: <pre class="screen">
2268: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2269: /usr/pkg
2270: <code class="prompt">%</code>
1.88 wiz 2271: </pre>
1.75 rillig 2272: </li>
2273: </ol></div>
2274: <p>If you want to install a binary package that you've either
1.88 wiz 2275: created yourself (see next section), that you put into
2276: pkgsrc/packages manually or that is located on a remote FTP
2277: server, you can use the "bin-install" target. This target will
2278: 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>,
2279: else do a <span><strong class="command">make package</strong></span>. The list of remote FTP
2280: sites searched is kept in the variable
2281: <code class="varname">BINPKG_SITES</code>, which defaults to
2282: 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>
2283: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2284: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2285: details.</p>
2286: <p>A final word of warning: If you set up a system that has a
2287: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2288: set that before any packages are installed, as you cannot use
2289: several directories for the same purpose. Doing so will result in
2290: pkgsrc not being able to properly detect your installed packages,
2291: and fail miserably. Note also that precompiled binary packages are
2292: usually built with the default <code class="varname">LOCALBASE</code> of
2293: <code class="filename">/usr/pkg</code>, and that you should
2294: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2295: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2296: </div>
2297: </div>
2298: </div>
2299: <div class="chapter" lang="en">
2300: <div class="titlepage"><div><div><h2 class="title">
2301: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2302: <div class="toc">
2303: <p><b>Table of Contents</b></p>
2304: <dl>
2305: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2306: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.103 wiz 2307: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installion process</a></span></dt>
2308: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2309: <dd><dl>
1.103 wiz 2310: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2311: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2312: <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 2313: </dl></dd>
1.103 wiz 2314: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2315: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2316: </dl>
2317: </div>
1.104 ! rillig 2318: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2319: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2320: that file depends on the installation. On NetBSD, when you use
2321: <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
2322: <code class="filename">/etc/</code>. In all other cases the default location is
2323: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2324: bootstrap program to install the binary packages.</p>
2325: <p>During the bootstrap, an example configuration file is created. To
2326: use that, you have to create the directory
2327: <code class="filename">${PREFIX}/etc</code> and copy the example file
2328: there.</p>
2329: <p>The format of the configuration file is that of the usual
2330: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2331: is done by setting variables in this file. Note that you can define all
2332: kinds of variables, and no special error checking (for example for
2333: spelling mistakes) takes place, so you have to try it out to see if it
2334: works.</p>
1.75 rillig 2335: <div class="sect1" lang="en">
2336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2337: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2338: <p>In this section, you can find some variables that apply to all
1.89 rillig 2339: pkgsrc packages. A complete list of the variables that can be
2340: configured by the user is available in
2341: <code class="filename">mk/defaults/mk.conf</code>, together with some
2342: comments that describe each variable's intent.</p>
1.75 rillig 2343: <div class="itemizedlist"><ul type="disc">
2344: <li><p><code class="varname">LOCALBASE</code>: Where
2345: packages will be installed. The default is
1.76 rillig 2346: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2347: with different <code class="varname">LOCALBASE</code>s!</p></li>
2348: <li><p><code class="varname">CROSSBASE</code>: Where
2349: “<span class="quote">cross</span>” category packages will be
2350: installed. The default is
1.76 rillig 2351: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2352: <li><p><code class="varname">X11BASE</code>: Where
2353: X11 is installed on the system. The default is
1.76 rillig 2354: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2355: <li><p><code class="varname">DISTDIR</code>: Where to store the
2356: downloaded copies of the original source distributions used
2357: for building pkgsrc packages. The default is
1.76 rillig 2358: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2359: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2360: database about installed packages is stored. The default is
2361: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2362: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2363: If set, override the packages'
2364: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2365: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2366: Backup location(s) for distribution files and patch files
2367: if not found locally or in
1.76 rillig 2368: <code class="filename">${MASTER_SITES}</code> or
2369: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2370: The defaults are
1.76 rillig 2371: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2372: and
1.76 rillig 2373: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2374: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2375: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2376: <em class="replaceable"><code>arch</code></em> are replaced with OS
2377: release (“<span class="quote">2.0</span>”, etc.) and architecture
2378: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2379: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2380: List of acceptable licenses. Whenever you try to build a package
2381: whose license is not in this list, you will get an error message
2382: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2383: </ul></div>
2384: </div>
2385: <div class="sect1" lang="en">
2386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2387: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2388: <p>XXX
2389: </p>
2390: <div class="itemizedlist"><ul type="disc">
2391: <li><p><code class="varname">PACKAGES</code>: The top level
2392: directory for the binary packages. The default is
1.76 rillig 2393: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2394: <li><p><code class="varname">WRKOBJDIR</code>:
2395: The top level directory where, if defined, the separate
2396: working directories will get created, and symbolically
1.76 rillig 2397: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2398: This is useful for building packages on several
1.76 rillig 2399: architectures, then <code class="filename">${PKGSRCDIR}</code>
2400: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2401: is local to every architecture. (It should be noted that
2402: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.104 ! rillig 2403: — it is an internal definition which refers to the
1.75 rillig 2404: root of the pkgsrc tree. It is possible to have many
2405: pkgsrc tree instances.)</p></li>
2406: <li><p><code class="varname">LOCALPATCHES</code>:
2407: Directory for local patches that aren't part of pkgsrc.
1.90 rillig 2408: See <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a> for more
1.93 rillig 2409: information.</p></li>
1.75 rillig 2410: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.104 ! rillig 2411: the <a href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2412: BSD-style Makefile. If this is not set,
2413: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2414: <code class="filename">/dev/null</code> to avoid picking up
2415: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2416: <li><p><code class="varname">DEPENDS_TARGET</code>:
2417: By default, dependencies are only installed, and no binary
2418: package is created for them. You can set this variable to
2419: <code class="literal">package</code> to automatically create binary
2420: packages after installing dependencies.</p></li>
1.75 rillig 2421: </ul></div>
2422: </div>
2423: <div class="sect1" lang="en">
2424: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2425: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installion process</h2></div></div></div>
2426: <p>A growing number of packages support installation into a
2427: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2428: to be built, before the actual filesystem is touched. DESTDIR
2429: support exists in two variations:</p>
2430: <div class="itemizedlist"><ul type="disc">
2431: <li><p>Basic DESTDIR support means that the package
2432: installation and packaging is still run as
2433: root.</p></li>
2434: <li><p>Full DESTDIR support can run the complete build,
2435: installation and packaging as normal user. Root privileges are
2436: only needed to add packages.</p></li>
2437: </ul></div>
2438: <p>To use the DESTDIR support, set either
2439: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2440: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2441: get the full support with fallback to basic
2442: 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
2443: newer). It might become the default DESTDIR support later.</p>
2444: <p>DESTDIR support changes the behaviour of various targets
2445: slightly. To install a package after building it, use
2446: <code class="literal">package-install</code>. <code class="literal">package</code> and
2447: <code class="literal">install</code> don't do that any
2448: longer. <code class="literal">package-install</code> can be used as
2449: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2450: will ask for the root password to install the package and fail,
2451: <code class="literal">package-install</code> will ask again.</p>
2452: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2453: clean</code></strong> needs to be run as root.</p>
2454: </div>
2455: <div class="sect1" lang="en">
2456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2457: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78 rillig 2458: <div class="sect2" lang="en">
2459: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2460: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2461: <p>By default, pkgsrc will use GCC to build packages. This may be
2462: overridden by setting the following variables in /etc/mk.conf:</p>
2463: <div class="variablelist"><dl>
2464: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2465: <dd>
2466: <p>This is a list of values specifying the chain of
2467: compilers to invoke when building packages. Valid values
2468: are:</p>
2469: <div class="itemizedlist"><ul type="disc">
2470: <li><p><code class="varname">distcc</code>:
2471: distributed C/C++ (chainable)</p></li>
2472: <li><p><code class="varname">ccache</code>:
2473: compiler cache (chainable)</p></li>
2474: <li><p><code class="varname">gcc</code>:
2475: GNU C/C++ Compiler</p></li>
2476: <li><p><code class="varname">mipspro</code>:
2477: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2478: <li><p><code class="varname">mipspro</code>:
2479: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2480: <li><p><code class="varname">sunpro</code>:
2481: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2482: </ul></div>
2483: <p>The default is
2484: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2485: <code class="varname">ccache</code> and/or
2486: <code class="varname">distcc</code> with an appropriate
2487: <code class="varname">PKGSRC_COMPILER</code> setting,
2488: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2489: variable should always be terminated with a value for
2490: a real compiler. Note that only one real compiler
2491: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2492: is not allowed).</p>
1.89 rillig 2493: </dd>
2494: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2495: <dd><p>This specifies the minimum version of GCC to use
2496: when building packages. If the system GCC doesn't
2497: satisfy this requirement, then pkgsrc will build and
2498: install one of the GCC packages to use instead.</p></dd>
2499: </dl></div>
2500: </div>
2501: <div class="sect2" lang="en">
2502: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2503: <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 2504: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2505: please make sure to use the <code class="literal">+=</code> operator
2506: instead of the <code class="literal">=</code> operator:</p>
2507: <pre class="programlisting">
1.100 rillig 2508: CFLAGS+= -your -flags
1.78 rillig 2509: </pre>
2510: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2511: “<span class="quote">+</span>”) may lead to problems with packages that need
2512: to add their own flags. Also, you may want to take a look at
1.91 rillig 2513: 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 2514: you're interested in optimization for the current CPU.</p>
2515: </div>
1.88 wiz 2516: <div class="sect2" lang="en">
2517: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2518: <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 2519: <p>If you want to pass flags to the linker, both in the configure
2520: step and the build step, you can do this in two ways. Either set
2521: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2522: between the two is that <code class="varname">LIBS</code> will be appended to
2523: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2524: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2525: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2526: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2527: <code class="varname">CFLAGS</code>, if you do not wish to override these
2528: settings, use the <code class="literal">+=</code> operator:</p>
2529: <pre class="programlisting">
1.100 rillig 2530: LDFLAGS+= -your -linkerflags
1.88 wiz 2531: </pre>
2532: </div>
1.78 rillig 2533: </div>
2534: <div class="sect1" lang="en">
2535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2536: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2537: <p>XXX
2538: </p>
2539: <div class="itemizedlist"><ul type="disc">
2540: <li>
2541: <p><code class="varname">PKG_DEVELOPER</code>:
2542: Run some sanity checks that package developers want:
2543: </p>
2544: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2545: <li><p>make sure patches apply with zero
2546: fuzz</p></li>
2547: <li><p>run check-shlibs to see that all
2548: binaries will find their shared libs.</p></li>
1.75 rillig 2549: </ul></div>
2550: <p>
1.87 wiz 2551: </p>
1.75 rillig 2552: </li>
1.88 wiz 2553: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2554: of debugging output which is displayed whilst making and
2555: installing the package. The default value for this is 0,
2556: which will not display the commands as they are executed
2557: (normal, default, quiet operation); the value 1 will display
2558: all shell commands before their invocation, and the value 2
2559: will display both the shell commands before their invocation,
2560: and their actual execution progress with <span><strong class="command">set
2561: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2562: </ul></div>
2563: <p>
2564: </p>
2565: </div>
2566: <div class="sect1" lang="en">
2567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2568: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2569: <p>Some packages have build time options, usually to select
2570: between different dependencies, enable optional support for big
2571: dependencies or enable experimental features.</p>
1.75 rillig 2572: <p>To see which options, if any, a package supports, and which
1.88 wiz 2573: options are mutually exclusive, run <span><strong class="command">make
2574: show-options</strong></span>, for example:</p>
1.75 rillig 2575: <pre class="programlisting">
2576: The following options are supported by this package:
2577: ssl Enable SSL support.
2578: Exactly one of the following gecko options is required:
2579: firefox Use firefox as gecko rendering engine.
2580: mozilla Use mozilla as gecko rendering engine.
2581: At most one of the following database options may be selected:
2582: mysql Enable support for MySQL database.
2583: pgsql Enable support for PostgreSQL database.
1.1 grant 2584:
1.75 rillig 2585: These options are enabled by default: firefox
2586: These options are currently enabled: mozilla ssl
1.1 grant 2587: </pre>
1.75 rillig 2588: <p>The following variables can be defined in
1.104 ! rillig 2589: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2590: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2591: which can be used to select or disable options for all packages
2592: that support them, and
2593: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2594: which can be used to select or disable options specifically for
2595: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2596: these variables are selected, options preceded by “<span class="quote">-</span>”
2597: are disabled. A few examples:</p>
1.75 rillig 2598: <pre class="screen">
1.104 ! rillig 2599: <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 2600: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2601: PKG_OPTIONS.kdebase= debug -sasl
2602: PKG_OPTIONS.apache= suexec </pre>
1.88 wiz 2603: <p>The following settings are consulted in the order given, and
2604: the last setting that selects or disables an option is
2605: used:</p>
1.75 rillig 2606: <div class="orderedlist"><ol type="1">
2607: <li><p>the default options as suggested by the package
1.88 wiz 2608: maintainer</p></li>
1.75 rillig 2609: <li><p>the options implied by the settings of legacy
1.88 wiz 2610: variables (see below)</p></li>
1.75 rillig 2611: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2612: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2613: </ol></div>
2614: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2615: selected is used, all others are automatically disabled. If an
2616: option of the group is explicitly disabled, the previously
2617: selected option, if any, is used. It is an error if no option
2618: from a required group of options is selected, and building the
2619: package will fail.</p>
2620: <p>Before the options framework was introduced, build options
2621: were selected by setting a variable (often named
2622: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.104 ! rillig 2623: <a href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2624: transition to the options framework for the user, these legacy
2625: variables are converted to the appropriate options setting
2626: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2627: automatically. A warning is issued to prompt the user to update
1.104 ! rillig 2628: <a href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2629: directly. Support for the legacy variables will be removed
2630: eventually.</p>
1.75 rillig 2631: </div>
2632: </div>
2633: <div class="chapter" lang="en">
2634: <div class="titlepage"><div><div><h2 class="title">
2635: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2636: <div class="toc">
2637: <p><b>Table of Contents</b></p>
2638: <dl>
2639: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2640: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2641: <dt><span class="sect1"><a href="#bulkbuild">6.3. Doing a bulk build of all packages</a></span></dt>
2642: <dd><dl>
2643: <dt><span class="sect2"><a href="#binary.configuration">6.3.1. Configuration</a></span></dt>
2644: <dt><span class="sect2"><a href="#other-environmental-considerations">6.3.2. Other environmental considerations</a></span></dt>
2645: <dt><span class="sect2"><a href="#operation">6.3.3. Operation</a></span></dt>
2646: <dt><span class="sect2"><a href="#what-it-does">6.3.4. What it does</a></span></dt>
2647: <dt><span class="sect2"><a href="#disk-space-requirements">6.3.5. Disk space requirements</a></span></dt>
2648: <dt><span class="sect2"><a href="#setting-up-a-sandbox">6.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2649: <dt><span class="sect2"><a href="#building-a-partial-set">6.3.7. Building a partial set of packages</a></span></dt>
2650: <dt><span class="sect2"><a href="#bulk-upload">6.3.8. Uploading results of a bulk build</a></span></dt>
2651: </dl></dd>
2652: <dt><span class="sect1"><a href="#creating-cdroms">6.4. Creating a multiple CD-ROM packages collection</a></span></dt>
2653: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">6.4.1. Example of cdpack</a></span></dt></dl></dd>
2654: </dl>
2655: </div>
2656: <div class="sect1" lang="en">
2657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2658: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2659: <p>Once you have built and installed a package, you can create
2660: a <span class="emphasis"><em>binary package</em></span> which can be installed on
2661: 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
2662: the same package on a group of hosts and wasting CPU time. It also
2663: provides a simple means for others to install your package, should
2664: you distribute it.</p>
2665: <p>To create a binary package, change into the appropriate
2666: directory in pkgsrc, and run <span><strong class="command">make
2667: package</strong></span>:</p>
2668: <pre class="screen">
2669: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2670: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2671: </pre>
2672: <p>This will build and install your package (if not already done),
2673: and then build a binary package from what was installed. You can
2674: then use the <span><strong class="command">pkg_*</strong></span> tools to manipulate
2675: it. Binary packages are created by default in
2676: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2677: gzipped tar file. See <a href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2678: 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 2679: <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 2680: such a binary package.</p>
1.75 rillig 2681: </div>
2682: <div class="sect1" lang="en">
2683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2684: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.90 rillig 2685: <p>See <a href="#build.helpful-targets" title="16.17. Other helpful targets">Section 16.17, “Other helpful targets”</a>.</p>
1.75 rillig 2686: </div>
2687: <div class="sect1" lang="en">
2688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2689: <a name="bulkbuild"></a>6.3. Doing a bulk build of all packages</h2></div></div></div>
2690: <p>If you want to get a full set of precompiled binary
1.87 wiz 2691: packages, this section describes how to get them. Beware that
2692: the bulk build will remove all currently installed packages from
2693: your system!</p>
1.75 rillig 2694: <p>Having an FTP server configured either on the
1.87 wiz 2695: machine doing the bulk builds or on a nearby NFS server can help
2696: to make the packages available to other machines that can then
2697: 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
2698: more information. If you use a remote NFS server's storage, be
2699: sure to not actually compile on NFS storage, as this slows
2700: things down a lot.</p>
1.75 rillig 2701: <div class="sect2" lang="en">
2702: <div class="titlepage"><div><div><h3 class="title">
2703: <a name="binary.configuration"></a>6.3.1. Configuration</h3></div></div></div>
2704: <div class="sect3" lang="en">
2705: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2706: <a name="binary.bulk.build.conf"></a>6.3.1.1. <code class="filename">build.conf</code>
2707: </h4></div></div></div>
1.76 rillig 2708: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2709: configuration file for bulk builds. You can configure how your
2710: copy of pkgsrc is kept up to date, how the distfiles are
2711: downloaded, how the packages are built and how the report is
2712: generated. You can find an annotated example file in
2713: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2714: it, copy <code class="filename">build.conf-example</code> to
2715: <code class="filename">build.conf</code> and edit it, following the
2716: comments in that file.</p>
1.75 rillig 2717: </div>
2718: <div class="sect3" lang="en">
2719: <div class="titlepage"><div><div><h4 class="title">
1.104 ! rillig 2720: <a name="binary.mk.conf"></a>6.3.1.2. <a href="#mk.conf"><code class="filename">mk.conf</code></a>
! 2721: </h4></div></div></div>
! 2722: <p>You may want to set variables in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2723: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2724: details of the default settings. You will want to ensure that
2725: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2726: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104 ! rillig 2727: completely bypasses the license check.</p>
1.87 wiz 2728: <pre class="programlisting">
1.100 rillig 2729: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2730: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2731: BSDSRCDIR= /usr/src
2732: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2733: OBJHOSTNAME?= yes # use work.`hostname`
2734: FAILOVER_FETCH= yes # insist on the correct checksum
2735: PKG_DEVELOPER?= yes
2736: _ACCEPTABLE= yes
2737: </pre>
1.75 rillig 2738: <p>Some options that are especially useful for bulk builds
2739: can be found at the top lines of the file
1.76 rillig 2740: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2741: options of these are briefly described here.</p>
2742: <div class="itemizedlist"><ul type="disc">
2743: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2744: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2745: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2746: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2747: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2748: to the directory where all log files are created. Otherwise the
2749: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2750: <li><p>Another important variable is
1.87 wiz 2751: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2752: should be always available while building other
2753: packages.</p></li>
1.75 rillig 2754: </ul></div>
2755: <p>Some other options are scattered in the pkgsrc
2756: infrastructure:</p>
2757: <div class="itemizedlist"><ul type="disc">
2758: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2759: should be set to <code class="literal">yes</code>. The purpose of the bulk
2760: builds is creating binary packages, no matter if they are
2761: vulnerable or not. When uploading the packages to a public
2762: server, the vulnerable packages will be put into a directory of
2763: their own. Leaving this variable unset would prevent the bulk
2764: build system from even trying to build them, so possible
2765: building errors would not show up.</p></li>
1.75 rillig 2766: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2767: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2768: “<span class="quote">yes</span>” to check that the installed set of files
2769: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2770: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2771: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2772: “<span class="quote">yes</span>” to check that the installed
2773: “<span class="quote">#!</span>”-scripts will find their
2774: interpreter.</p></li>
1.91 rillig 2775: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2776: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2777: package's self-test before installing it. Note that some
2778: packages make heavy use of “<span class="quote">good</span>” random
2779: numbers, so you need to assure that the machine on which you
2780: are doing the bulk builds is not completely idle. Otherwise
2781: some test programs will seem to hang, while they are just
2782: waiting for new random data to be
2783: available.</p></li>
1.75 rillig 2784: </ul></div>
2785: </div>
2786: <div class="sect3" lang="en">
2787: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 2788: <a name="pre-build.local"></a>6.3.1.3. <code class="filename">pre-build.local</code>
2789: </h4></div></div></div>
1.75 rillig 2790: <p>It is possible to configure the bulk build to perform
1.87 wiz 2791: certain site-specific tasks at the end of the pre-build
2792: stage. If the file
2793: <code class="filename">pre-build.local</code> exists in
2794: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2795: (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
2796: stage. An example use of
2797: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2798: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2799: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2800: <p>to prevent the system from trying to build a particular package
1.87 wiz 2801: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2802: </div>
2803: </div>
2804: <div class="sect2" lang="en">
2805: <div class="titlepage"><div><div><h3 class="title">
2806: <a name="other-environmental-considerations"></a>6.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2807: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2808: deleted at the start of bulk builds, make sure your login
2809: shell is placed somewhere else. Either drop it into
2810: <code class="filename">/usr/local/bin</code> (and adjust your login
2811: shell in the passwd file), or (re-)install it via
2812: <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
2813: you can login after a reboot (remember that your current
2814: process won't die if the package is removed, you just can't
2815: start any new instances of the shell any more). Also, if you
2816: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2817: version of ssh for some reason, be sure to install ssh before
2818: starting it from <code class="filename">rc.local</code>:</p>
2819: <pre class="programlisting">
1.100 rillig 2820: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2821: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2822: /usr/pkg/etc/rc.d/sshd
2823: fi
2824: </pre>
1.75 rillig 2825: <p>Not doing so will result in you being not able to log in
1.87 wiz 2826: via ssh after the bulk build is finished or if the machine
2827: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2828: </div>
2829: <div class="sect2" lang="en">
2830: <div class="titlepage"><div><div><h3 class="title">
2831: <a name="operation"></a>6.3.3. Operation</h3></div></div></div>
2832: <p>Make sure you don't need any of the packages still
1.87 wiz 2833: installed.</p>
1.75 rillig 2834: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2835: <h3 class="title">Warning</h3>
1.99 rillig 2836: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2837: configuration files and some more files from
2838: <code class="filename">/var</code>, <code class="filename">/home</code> and
2839: possibly other locations will be removed! So don't run a bulk
2840: build with privileges that might harm your
2841: system.</em></span></p>
1.75 rillig 2842: </div>
2843: <p>Be sure to remove all other things that might
1.87 wiz 2844: interfere with builds, like some libs installed in
2845: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2846: <pre class="screen">
2847: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2848: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2849: </pre>
1.75 rillig 2850: <p>If for some reason your last build didn't complete (power
1.87 wiz 2851: failure, system panic, ...), you can continue it by
2852: running:</p>
1.75 rillig 2853: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2854: <p>At the end of the bulk build, you will get a summary via mail,
2855: and find build logs in the directory specified by
2856: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2857: file.</p>
1.75 rillig 2858: </div>
2859: <div class="sect2" lang="en">
2860: <div class="titlepage"><div><div><h3 class="title">
2861: <a name="what-it-does"></a>6.3.4. What it does</h3></div></div></div>
2862: <p>The bulk builds consist of three steps:</p>
2863: <div class="variablelist"><dl>
2864: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2865: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2866: cleans out any broken distfiles, and removes all
2867: packages installed.</p></dd>
1.75 rillig 2868: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2869: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2870: an optimised order in which packages will be
2871: built. Packages that don't require other packages will
2872: be built first, and packages with many dependencies will
2873: be built later.</p></dd>
1.75 rillig 2874: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2875: <dd><p>Generates a report that's placed in the directory
2876: specified in the <code class="filename">build.conf</code> file
2877: named <code class="filename">broken.html</code>, a short version
2878: of that report will also be mailed to the build's
2879: admin.</p></dd>
1.75 rillig 2880: </dl></div>
1.87 wiz 2881: <p>During the build, a list of broken packages will be compiled
2882: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2883: <code class="filename">.../.broken.${MACHINE}</code> if
2884: <code class="varname">OBJMACHINE</code> is set), individual build logs
2885: of broken builds can be found in the package's
2886: directory. These files are used by the bulk-targets to mark
2887: broken builds to not waste time trying to rebuild them, and
2888: they can be used to debug these broken package builds
2889: later.</p>
1.75 rillig 2890: </div>
2891: <div class="sect2" lang="en">
2892: <div class="titlepage"><div><div><h3 class="title">
2893: <a name="disk-space-requirements"></a>6.3.5. Disk space requirements</h3></div></div></div>
2894: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2895: NetBSD 2.0/i386:</p>
1.75 rillig 2896: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2897: <li><p>10 GB - distfiles (NFS ok)</p></li>
2898: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2899: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2900: </ul></div>
2901: <p>Note that all pkgs will be de-installed as soon as they are
2902: turned into a binary package, and that sources are removed,
2903: so there is no excessively huge demand to disk
2904: space. Afterwards, if the package is needed again, it will
2905: 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
2906: there are no cycles wasted by recompiling.</p>
1.75 rillig 2907: </div>
2908: <div class="sect2" lang="en">
2909: <div class="titlepage"><div><div><h3 class="title">
2910: <a name="setting-up-a-sandbox"></a>6.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2911: <p>If you don't want all the packages nuked from a machine
2912: (rendering it useless for anything but pkg compiling), there
2913: is the possibility of doing the package bulk build inside a
2914: chroot environment.</p>
2915: <p>The first step is to set up a chroot sandbox,
2916: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2917: using null mounts, or manually.</p>
2918: <p>There is a shell script called
2919: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2920: up the sandbox environment using null mounts. It will also
2921: create a script called <code class="filename">sandbox</code> in the
2922: root of the sandbox environment, which will allow the null
2923: mounts to be activated using the <span><strong class="command">sandbox
2924: mount</strong></span> command and deactivated using the
2925: <span><strong class="command">sandbox umount</strong></span> command.</p>
2926: <p>To set up a sandbox environment by hand, after extracting all
2927: the sets from a NetBSD installation or doing a <span><strong class="command">make
2928: distribution DESTDIR=/usr/sandbox</strong></span> in
2929: <code class="filename">/usr/src/etc</code>, be sure the following items
2930: are present and properly configured:</p>
1.75 rillig 2931: <div class="procedure"><ol type="1">
2932: <li>
2933: <p>Kernel</p>
2934: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2935: </li>
2936: <li>
1.76 rillig 2937: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2938: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2939: </li>
2940: <li>
1.91 rillig 2941: <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 2942: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2943: </li>
2944: <li>
2945: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2946: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2947: </li>
2948: <li>
1.91 rillig 2949: <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 2950: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2951: </li>
2952: <li>
1.76 rillig 2953: <p><code class="filename">/usr/src</code> (system sources,
1.104 ! rillig 2954: 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 2955: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2956: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2957: </li>
2958: <li>
1.76 rillig 2959: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2960: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2961: </li>
2962: <li>
1.76 rillig 2963: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2964: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2965: </li>
2966: <li>
2967: <p>Checkout pkgsrc via cvs into
1.87 wiz 2968: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2969: <pre class="screen">
2970: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2971: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2972: </pre>
1.75 rillig 2973: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2974: you do development in, as this will likely cause problems!</p>
1.75 rillig 2975: </li>
2976: <li><p>Make
1.87 wiz 2977: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2978: <code class="filename">.../distfiles</code> point somewhere
2979: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.104 ! rillig 2980: <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 2981: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2982: </ol></div>
2983: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2984: the build with the following steps:</p>
2985: <pre class="screen">
2986: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2987: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2988: </pre>
2989: <p>This will just jump inside the sandbox and start building. At
2990: the end of the build, mail will be sent with the results of
2991: the build. Created binary pkgs will be in
2992: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2993: (wherever that points/mounts to/from).</p>
1.75 rillig 2994: </div>
2995: <div class="sect2" lang="en">
2996: <div class="titlepage"><div><div><h3 class="title">
2997: <a name="building-a-partial-set"></a>6.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2998: <p>In addition to building a complete set of all packages in
2999: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
3000: may be used to build a subset of the packages contained in
3001: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.104 ! rillig 3002: in <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75 rillig 3003: <div class="itemizedlist"><ul type="disc">
3004: <li><p>SITE_SPECIFIC_PKGS</p></li>
3005: <li><p>HOST_SPECIFIC_PKGS</p></li>
3006: <li><p>GROUP_SPECIFIC_PKGS</p></li>
3007: <li><p>USER_SPECIFIC_PKGS</p></li>
3008: </ul></div>
1.87 wiz 3009: <p>will define the set of packages which should be built.
3010: The bulk build code will also include any packages which are
3011: needed as dependencies for the explicitly listed packages.</p>
3012: <p>One use of this is to do a bulk build with
3013: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
3014: periodically to have a complete set of the binary packages
3015: needed for your site available without the overhead of
3016: building extra packages that are not needed.</p>
1.75 rillig 3017: </div>
3018: <div class="sect2" lang="en">
3019: <div class="titlepage"><div><div><h3 class="title">
3020: <a name="bulk-upload"></a>6.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 3021: <p>This section describes how pkgsrc developers can upload binary
3022: pkgs built by bulk builds to ftp.NetBSD.org.</p>
3023: <p>If you would like to automatically create checksum files for the
3024: binary packages you intend to upload, remember to set
3025: <code class="varname">MKSUMS=yes</code> in your
3026: <code class="filename">mk/bulk/build.conf</code>.</p>
3027: <p>If you would like to PGP sign the checksum files (highly
3028: recommended!), remember to set
3029: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
3030: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
3031: your GPG password to sign the files before uploading everything.</p>
3032: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
3033: set properly in your <code class="filename">mk/bulk/build.conf</code>
3034: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 3035: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
3036: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 3037: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
3038: is different from your local login, write your login directly
3039: into the variable, e.g. my local account is "feyrer", but for my
3040: login "hubertf", I use:</p>
1.93 rillig 3041: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 3042: <p>A separate <code class="filename">upload</code> directory is used
3043: here to allow "closing" the directory during upload. To do
3044: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 3045: <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 3046: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
3047: only appropriate for packages for the NetBSD operating
3048: system. Binary packages for other operating systems should go
3049: into <code class="filename">/pub/pkgsrc</code>.</p>
3050: <p>Before uploading the binary pkgs, ssh authentication needs
3051: to be set up. This example shows how to set up temporary keys
3052: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
3053: (assuming that no keys should be present there usually):</p>
3054: <pre class="screen">
3055: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 3056: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
3057: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 3058: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
3059: </pre>
3060: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
3061: append it to your <code class="filename">~/.ssh/authorized_keys</code>
3062: file on ftp.NetBSD.org. You can remove the key after the
3063: upload is done!</p>
3064: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 3065: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 3066: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
3067: <p>Now after all this works, you can exit the sandbox and start
3068: the upload:</p>
3069: <pre class="screen">
3070: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 3071: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 3072: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3073: </pre>
3074: <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
3075: <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
3076: upload. The upload script will take care of not uploading
3077: restricted packages and putting vulnerable packages into the
3078: <code class="filename">vulnerable</code> subdirectory.</p>
3079: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 3080: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 3081: Gdd:x! </pre>
3082: <p>Use whatever is needed to remove the key you've entered
3083: before! Last, move the uploaded packages out of the
3084: <code class="filename">upload</code> directory to have them accessible
3085: to everyone:</p>
3086: <pre class="screen">
1.93 rillig 3087: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 3088: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3089: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 3090: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
3091: </pre>
1.75 rillig 3092: </div>
3093: </div>
3094: <div class="sect1" lang="en">
3095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3096: <a name="creating-cdroms"></a>6.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 3097: <p>After your pkgsrc bulk-build has completed, you may wish to
3098: create a CD-ROM set of the resulting binary packages to assist
3099: in installing packages on other machines. The
1.91 rillig 3100: <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 3101: a simple tool for creating the ISO 9660 images.
3102: <span><strong class="command">cdpack</strong></span> arranges the packages on the CD-ROMs in a
3103: way that keeps all the dependencies for a given package on the same
3104: CD as that package.</p>
1.75 rillig 3105: <div class="sect2" lang="en">
3106: <div class="titlepage"><div><div><h3 class="title">
3107: <a name="cdpack-example"></a>6.4.1. Example of cdpack</h3></div></div></div>
1.87 wiz 3108: <p>Complete documentation for cdpack is found in the cdpack(1)
3109: man page. The following short example assumes that the binary
3110: packages are left in
3111: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3112: sufficient disk space exists in <code class="filename">/u2</code> to
3113: hold the ISO 9660 images.</p>
3114: <pre class="screen">
3115: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 3116: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 3117: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3118: </pre>
3119: <p>If you wish to include a common set of files
3120: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3121: etc.) on each CD in the collection, then you need to create a
3122: directory which contains these files. e.g.</p>
3123: <pre class="screen">
3124: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 3125: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3126: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3127: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3128: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3129: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 3130: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3131: </pre>
1.75 rillig 3132: <p>Now create the images:</p>
3133: <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 3134: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 3135: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3136: in their root directories.</p>
1.75 rillig 3137: </div>
3138: </div>
3139: </div>
3140: <div class="chapter" lang="en">
3141: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3142: <a name="files"></a>Chapter 7. Directory layout of the installed files</h2></div></div></div>
3143: <div class="toc">
3144: <p><b>Table of Contents</b></p>
3145: <dl>
1.91 rillig 3146: <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 3147: <dt><span class="sect1"><a href="#files.varbase">7.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3148: </dl>
3149: </div>
3150: <p>The files that are installed by pkgsrc are organized in a way that
3151: is similar to what you find in the <code class="filename">/usr</code> directory
3152: of the base system. But some details are different. This is because
3153: pkgsrc initially came from FreeBSD and had adopted its file system
3154: hierarchy. Later it was largely influenced by NetBSD. But no matter
3155: which operating system you are using pkgsrc with, you can expect the
3156: same layout for pkgsrc.</p>
1.91 rillig 3157: <p>There are mainly four root directories for pkgsrc, which are all
3158: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3159: When pkgsrc has been installed as root, the default locations
3160: are:</p>
3161: <pre class="programlisting">
1.100 rillig 3162: LOCALBASE= /usr/pkg
3163: PKG_SYSCONFBASE= /usr/pkg/etc
3164: VARBASE= /var
3165: PKG_DBDIR= /var/db/pkg
1.91 rillig 3166: </pre>
3167: <p>In unprivileged mode (when pkgsrc has been installed as any other
3168: user), the default locations are:</p>
3169: <pre class="programlisting">
1.100 rillig 3170: LOCALBASE= ${HOME}/pkg
3171: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3172: VARBASE= ${HOME}/pkg/var
3173: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3174: </pre>
3175: <p>What these four directories are for, and what they look like is
3176: explained below.</p>
1.90 rillig 3177: <div class="itemizedlist"><ul type="disc">
3178: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3179: <code class="filename">/usr</code> directory in the base system. It is the
3180: “<span class="quote">main</span>” directory where the files are installed and contains
3181: the well-known subdirectories like <code class="filename">bin</code>,
3182: <code class="filename">include</code>, <code class="filename">lib</code>,
3183: <code class="filename">share</code> and
3184: <code class="filename">sbin</code>.</p></li>
3185: <li><p><code class="varname">VARBASE</code> corresponds to
3186: <code class="filename">/var</code> in the base system. Some programs (especially
3187: games, network daemons) need write access to it during normal
3188: operation.</p></li>
3189: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3190: <code class="filename">/etc</code> in the base system. It contains configuration
1.104 ! rillig 3191: files of the packages, as well as pkgsrc's <a href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 3192: itself.</p></li>
3193: </ul></div>
3194: <div class="sect1" lang="en">
3195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3196: <a name="files.localbase"></a>7.1. File system layout in <code class="literal">${LOCALBASE}</code>
3197: </h2></div></div></div>
1.90 rillig 3198: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3199: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3200: <div class="variablelist"><dl>
3201: <dt><span class="term"><code class="filename">bin</code></span></dt>
3202: <dd><p>Contains executable programs that are intended to be
3203: directly used by the end user.</p></dd>
3204: <dt><span class="term"><code class="filename">emul</code></span></dt>
3205: <dd><p>Contains files for the emulation layers of various other
3206: operating systems, especially for
3207: NetBSD.</p></dd>
3208: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3209: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3210: <dd><p>Contains
3211: the configuration files.</p></dd>
3212: <dt><span class="term"><code class="filename">include</code></span></dt>
3213: <dd><p>Contains headers for the C and C++ programming
3214: languages.</p></dd>
3215: <dt><span class="term"><code class="filename">info</code></span></dt>
3216: <dd><p>Contains GNU info files of various
3217: packages.</p></dd>
3218: <dt><span class="term"><code class="filename">lib</code></span></dt>
3219: <dd><p>Contains shared and static
3220: libraries.</p></dd>
3221: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3222: <dd><p>Contains data files that don't change after
3223: installation. Other data files belong into
3224: <code class="filename">${VARBASE}</code>.</p></dd>
3225: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3226: <dd><p>Contains programs that are not intended to be used by
3227: end users, such as helper programs or network
3228: daemons.</p></dd>
3229: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3230: <dd><p>Contains programs that are intended to be executed as
3231: CGI scripts by a web server.</p></dd>
3232: <dt><span class="term"><code class="filename">man</code> (the usual value of
3233: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3234: <dd><p>Contains brief
3235: documentation in form of manual pages.</p></dd>
3236: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3237: <dd><p>Contains programs that are intended to be used only by
3238: the super-user.</p></dd>
3239: <dt><span class="term"><code class="filename">share</code></span></dt>
3240: <dd><p>Contains platform-independent data files that don't
3241: change after installation.</p></dd>
3242: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3243: <dd><p>Contains documentation files provided by the
3244: packages.</p></dd>
3245: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3246: <dd><p>Contains example files provided by the packages. Among
3247: others, the original configuration files are saved here and copied to
3248: <code class="filename">${PKG_SYSCONFDIR}</code> during
3249: installation.</p></dd>
3250: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3251: <dd><p>Contains the original files for rc.d
3252: scripts.</p></dd>
3253: <dt><span class="term"><code class="filename">var</code> (the usual location of
3254: <code class="filename">${VARBASE}</code>)</span></dt>
3255: <dd><p>Contains files
3256: that may be modified after
3257: installation.</p></dd>
3258: </dl></div>
3259: </div>
3260: <div class="sect1" lang="en">
3261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 3262: <a name="files.varbase"></a>7.2. File system layout in <code class="literal">${VARBASE}</code>
3263: </h2></div></div></div>
1.90 rillig 3264: <div class="variablelist"><dl>
3265: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3266: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3267: <dd><p>Contains
3268: information about the currently installed
3269: packages.</p></dd>
3270: <dt><span class="term"><code class="filename">games</code></span></dt>
3271: <dd><p>Contains highscore
3272: files.</p></dd>
3273: <dt><span class="term"><code class="filename">log</code></span></dt>
3274: <dd><p>Contains log files.</p></dd>
3275: <dt><span class="term"><code class="filename">run</code></span></dt>
3276: <dd><p>Contains informational files about daemons that are
3277: currently running.</p></dd>
3278: </dl></div>
3279: </div>
3280: </div>
3281: <div class="chapter" lang="en">
3282: <div class="titlepage"><div><div><h2 class="title">
3283: <a name="faq"></a>Chapter 8. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3284: <div class="toc">
3285: <p><b>Table of Contents</b></p>
3286: <dl>
1.90 rillig 3287: <dt><span class="sect1"><a href="#mailing-list-pointers">8.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3288: <dt><span class="sect1"><a href="#pkgviews-docs">8.2. Where's the pkgviews documentation?</a></span></dt>
3289: <dt><span class="sect1"><a href="#faq-pkgtools">8.3. Utilities for package management (pkgtools)</a></span></dt>
3290: <dt><span class="sect1"><a href="#non-root-pkgsrc">8.4. How to use pkgsrc as non-root</a></span></dt>
3291: <dt><span class="sect1"><a href="#resume-transfers">8.5. How to resume transfers when fetching distfiles?</a></span></dt>
1.103 wiz 3292: <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>
3293: <dt><span class="sect1"><a href="#fetch-behind-firewall">8.7. How to fetch files from behind a firewall</a></span></dt>
3294: <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>
3295: <dt><span class="sect1"><a href="#fetching-all-distfiles">8.9. How to fetch all distfiles at once</a></span></dt>
3296: <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 3297: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.103 wiz 3298: <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>
3299: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">8.12. Using 'sudo' with pkgsrc</a></span></dt>
3300: <dt><span class="sect1"><a href="#faq.conf">8.13. How do I change the location of configuration files?</a></span></dt>
3301: <dt><span class="sect1"><a href="#audit-packages">8.14. Automated security checks</a></span></dt>
3302: <dt><span class="sect1"><a href="#ufaq-cflags">8.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3303: <dt><span class="sect1"><a href="#ufaq-fail">8.16. A package does not build. What shall I do?</a></span></dt>
3304: <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 3305: </dl>
3306: </div>
3307: <p>This section contains hints, tips & tricks on special things in
3308: pkgsrc that we didn't find a better place for in the previous chapters, and
3309: it contains items for both pkgsrc users and developers.</p>
3310: <div class="sect1" lang="en">
3311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3312: <a name="mailing-list-pointers"></a>8.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3313: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3314: <div class="itemizedlist"><ul type="disc">
1.103 wiz 3315: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3316: This is a general purpose list for most issues regarding
3317: pkgsrc, regardless of platform, e.g. soliciting user help
3318: for pkgsrc configuration, unexpected build failures, using
3319: particular packages, upgrading pkgsrc installations,
3320: questions regarding the pkgsrc release branches, etc. General announcements or
3321: proposals for changes that impact the pkgsrc user community,
3322: e.g. major infrastructure changes, new features, package
3323: removals, etc., may also be posted.</p></li>
1.103 wiz 3324: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3325: A list where the results of pkgsrc bulk builds are sent and
3326: discussed.</p></li>
1.103 wiz 3327: <li><p><a href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3328: This list is for those who are interested in getting a
3329: commit message for every change committed to pkgsrc. It is
3330: also available in digest form, meaning one daily message
3331: containing all commit messages for changes to the package
3332: source tree in that 24 hour period.</p></li>
3333: </ul></div>
3334: <p>To subscribe, do:</p>
3335: <pre class="programlisting">
1.100 rillig 3336: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3337: </pre>
3338: <p>Archives for all these mailing lists are available from
3339: <a href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3340: </div>
3341: <div class="sect1" lang="en">
3342: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3343: <a name="pkgviews-docs"></a>8.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3344: <p>Pkgviews is tightly integrated with buildlink. You can find a
3345: pkgviews User's guide in
1.76 rillig 3346: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3347: </div>
3348: <div class="sect1" lang="en">
3349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3350: <a name="faq-pkgtools"></a>8.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3351: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3352: a number of useful utilities for both users and developers of pkgsrc. This
3353: section attempts only to make the reader aware of the utilities and when
3354: they might be useful, and not to duplicate the documentation that comes
3355: with each package.</p>
3356: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3357: <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 3358: Symlinks for use by buildlink.</p></li></ul></div>
3359: <p>OS tool augmentation (automatically installed when needed):</p>
3360: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3361: <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 3362: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3363: <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 3364: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3365: <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 3366: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3367: <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 3368: Up-to-date replacement for
1.76 rillig 3369: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3370: systems where pkg_install is not present.</p></li>
3371: </ul></div>
3372: <p>Utilities used by pkgsrc (not automatically installed):</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_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75 rillig 3375: Create a binary package from an
3376: already-installed package. Used by <span><strong class="command">make replace</strong></span> to
3377: save the old package.</p></li>
1.91 rillig 3378: <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 3379: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3380: from multiple locations. It currently supports the following
3381: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3382: <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 3383: packages someplace else (enabled by default).</p></li>
1.91 rillig 3384: <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 3385: best compiler flags to optimise code for your current CPU and
3386: compiler.</p></li>
3387: </ul></div>
3388: <p>Utilities for keeping track of installed packages, being up to date,
3389: etc:</p>
3390: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3391: <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 3392: packages whose installed versions do not match the latest pkgsrc
3393: entries.</p></li>
1.91 rillig 3394: <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 3395: dependency graphs of packages, to aid in choosing a strategy for
3396: updating.</p></li>
1.91 rillig 3397: <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
3398: 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>
3399: <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 3400: pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
3401: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3402: <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 3403: packages you have installed.</p></li>
3404: </ul></div>
3405: <p>Utilities for people maintaining or creating individual packages:</p>
3406: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3407: <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 3408: making and maintaining patches for a package (includes pkgdiff,
3409: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3410: <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>,
3411: <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 3412: converting to pkgsrc.</p></li>
1.91 rillig 3413: <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 3414: pkgsrc to a Solaris package.</p></li>
3415: </ul></div>
3416: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3417: utilities)</p>
3418: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3419: <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 3420: packages in a chrooted area.</p></li>
1.91 rillig 3421: <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 3422: kernel version for chrooted cross builds.</p></li>
3423: </ul></div>
3424: </div>
3425: <div class="sect1" lang="en">
3426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3427: <a name="non-root-pkgsrc"></a>8.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3428: <p>If you want to use pkgsrc as non-root user, you can set some
3429: variables to make pkgsrc work under these conditions. At the very least,
3430: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3431: will turn on unprivileged mode and set multiple related variables to allow
3432: installation of packages as non-root.</p>
3433: <p>In case the defaults are not enough, you may want to tune some other
3434: variables used. For example, if the automatic user/group detection leads
3435: to incorrect values (or not the ones you would like to use), you can change
3436: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3437: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3438: <p>As regards bootstrapping, please note that the
3439: <span><strong class="command">bootstrap</strong></span> script will ease non-root configuration when
3440: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3441: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3442: installation targets. These directories can be overridden by the
1.75 rillig 3443: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3444: that allow finer tuning of the tree layout.</p>
3445: </div>
3446: <div class="sect1" lang="en">
3447: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 3448: <a name="resume-transfers"></a>8.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3449: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3450: enable this feature by adding the option
3451: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.104 ! rillig 3452: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3453: distfile is found, pkgsrc will try to resume it.</p>
3454: <p>You can also
3455: 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
3456: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3457: <code class="varname">FETCH_RESUME_ARGS</code> and
3458: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3459: values.</p>
3460: <p>For example, if you want to use
1.76 rillig 3461: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3462: like:</p>
3463: <pre class="programlisting">
1.100 rillig 3464: FETCH_CMD= wget
3465: FETCH_BEFORE_ARGS= --passive-ftp
3466: FETCH_RESUME_ARGS= -c
3467: FETCH_OUTPUT_ARGS= -O
1.1 grant 3468: </pre>
1.75 rillig 3469: </div>
3470: <div class="sect1" lang="en">
3471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3472: <a name="x.org-from-pkgsrc"></a>8.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
3473: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3474: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3475: you will have to add the following line into
1.104 ! rillig 3476: <a href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3477: <pre class="programlisting">
1.103 wiz 3478: X11_TYPE=modular
1.1 grant 3479: </pre>
1.75 rillig 3480: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3481: <h3 class="title">Note</h3>
1.103 wiz 3482: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3483: </p>
1.75 rillig 3484: </div>
3485: </div>
3486: <div class="sect1" lang="en">
3487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3488: <a name="fetch-behind-firewall"></a>8.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3489: <p>If you are sitting behind a firewall which does not allow direct
3490: connections to Internet hosts (i.e. non-NAT), you may specify the
3491: relevant proxy hosts. This is done using an environment variable in the
3492: form of a URL, e.g. in Amdahl, the machine
3493: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3494: port 80 as the proxy port number. So the proxy environment variables
3495: are:</p>
3496: <pre class="programlisting">
1.100 rillig 3497: ftp_proxy=ftp://orpheus.amdahl.com:80/
3498: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3499: </pre>
1.75 rillig 3500: </div>
3501: <div class="sect1" lang="en">
3502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3503: <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 3504: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3505: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3506: the first available command from the following list:</p>
3507: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3508: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3509: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3510: </ul></div>
3511: <p>On a default NetBSD installation, this will be
1.76 rillig 3512: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3513: connections first, and falls back to active connections if the server
3514: refuses to do passive. For the other tools, add the following to your
1.104 ! rillig 3515: <a href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3516: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3517: <p>Having that option present will prevent
1.76 rillig 3518: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3519: transfers.</p>
3520: </div>
3521: <div class="sect1" lang="en">
3522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3523: <a name="fetching-all-distfiles"></a>8.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3524: <p>You would like to download all the distfiles in a single batch
3525: from work or university, where you can't run a <span><strong class="command">make
3526: 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 3527: but downloading the entire directory may not be appropriate.</p>
3528: <p>The answer here is to do a <span><strong class="command">make fetch-list</strong></span> in
1.76 rillig 3529: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3530: resulting list to your machine at work/school and use it there. If you
3531: 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
3532: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3533: URL:</p>
3534: <p>At home:</p>
3535: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3536: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3537: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3538: <p>At work:</p>
3539: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3540: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3541: home.</p>
3542: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3543: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3544: machine architecture), you can do so by using the above-mentioned
3545: <span><strong class="command">make fetch-list</strong></span> approach, or fetch the distfiles
3546: directly by running:</p>
1.75 rillig 3547: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3548: <p>If you even decide to ignore
3549: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3550: by running:</p>
3551: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3552: </div>
3553: <div class="sect1" lang="en">
3554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3555: <a name="tmac.andoc-missing"></a>8.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3556: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3557: <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 3558: package, you get the error from make that it doesn't know how to make
1.76 rillig 3559: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3560: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3561: the NetBSD base distribution on your machine. It is recommended to do
3562: that to format man pages.</p>
1.91 rillig 3563: <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 3564: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.104 ! rillig 3565: environment or in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3566: </div>
3567: <div class="sect1" lang="en">
3568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3569: <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 3570: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3571: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3572: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3573: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3574: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3575: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.75 rillig 3576: the one that corresponds to your release (determine via <span><strong class="command">uname
3577: -r</strong></span>).</p>
3578: </div>
3579: <div class="sect1" lang="en">
3580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3581: <a name="using-sudo-with-pkgsrc"></a>8.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3582: <p>When installing packages as non-root user and using the just-in-time
3583: <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
3584: password for each required package installed. To avoid this, the sudo
3585: package can be used, which does password caching over a limited time. To
3586: use it, install sudo (either as binary package or from
1.98 wiz 3587: <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 3588: following into your <a href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3589: <span class="emphasis"><em>after</em></span> the definition of the
3590: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3591: <pre class="programlisting">
1.100 rillig 3592: .if exists(${LOCALBASE}/bin/sudo)
3593: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3594: .endif
1.1 grant 3595: </pre>
1.75 rillig 3596: </div>
3597: <div class="sect1" lang="en">
3598: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3599: <a name="faq.conf"></a>8.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3600: <p>As the system administrator, you can choose where configuration files
3601: are installed. The default settings make all these files go into
1.76 rillig 3602: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3603: be suboptimal depending on your expectations (e.g., a read-only,
3604: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3605: configuration of the provided packages).</p>
3606: <p>In order to change the defaults, you can modify the
3607: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.104 ! rillig 3608: <a href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3609: directory; some common examples include <code class="filename">/etc</code> or
3610: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3611: <p>Furthermore, you can change this value on a per-package basis by
3612: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3613: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3614: package you would like to modify, that is, the contents of
3615: <code class="varname">PKGBASE</code>.</p>
3616: <p>Note that after changing these settings, you must rebuild and
3617: reinstall any affected packages.</p>
3618: </div>
3619: <div class="sect1" lang="en">
3620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3621: <a name="audit-packages"></a>8.14. Automated security checks</h2></div></div></div>
1.75 rillig 3622: <p>Please be aware that there can often be bugs in third-party software,
3623: and some of these bugs can leave a machine vulnerable to exploitation by
3624: attackers. In an effort to lessen the exposure, the NetBSD packages team
3625: maintains a database of known-exploits to packages which have at one time
3626: been included in pkgsrc. The database can be downloaded automatically, and
3627: a security audit of all packages installed on a system can take place. To
1.91 rillig 3628: 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 3629: components:</p>
3630: <div class="orderedlist"><ol type="1">
3631: <li>
3632: <p><span><strong class="command">download-vulnerability-list</strong></span>, an easy way to
3633: download a list of the security vulnerabilities information. This list
3634: is kept up to date by the NetBSD security officer and the NetBSD
3635: packages team, and is distributed from the NetBSD ftp server:</p>
3636: <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>
3637: </li>
3638: <li><p><span><strong class="command">audit-packages</strong></span>, an easy way to audit the
3639: current machine, checking each vulnerability which is known. If a
3640: vulnerable package is installed, it will be shown by output to stdout,
3641: including a description of the type of vulnerability, and a URL
3642: containing more information.</p></li>
3643: </ol></div>
1.91 rillig 3644: <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 3645: package is strongly recommended! After
3646: “<span class="quote">audit-packages</span>” is installed, please read
3647: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3648: audit-packages</code></strong>.</p>
1.87 wiz 3649: <p>If this package is installed, pkgsrc builds will use it to
3650: 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
3651: check.</p>
1.75 rillig 3652: </div>
3653: <div class="sect1" lang="en">
3654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3655: <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 3656: <p>When you add your own preferences to the
3657: <code class="varname">CFLAGS</code> variable in your
1.104 ! rillig 3658: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3659: environment variables to the <code class="filename">./configure</code>
1.75 rillig 3660: 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
3661: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3662: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3663: package.</p>
3664: <p>Currently there is no solution to this problem. If you
3665: really need the package to use your <code class="varname">CFLAGS</code>
3666: you should run <span><strong class="command">make patch</strong></span> in the package
1.76 rillig 3667: directory and then inspect any <code class="filename">Makefile</code> and
3668: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3669: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3670: these lines. But be aware that some “<span class="quote">smart</span>”
3671: programmers write so bad code that it only works for the
3672: specific combination of <code class="varname">CFLAGS</code> they have
3673: chosen.</p>
3674: </div>
1.80 rillig 3675: <div class="sect1" lang="en">
3676: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3677: <a name="ufaq-fail"></a>8.16. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3678: <div class="procedure"><ol type="1">
3679: <li><p>Make sure that your copy of pkgsrc is consistent. A
3680: case that occurs often is that people only update pkgsrc in
3681: parts, because of performance reasons. Since pkgsrc is one large
3682: system, not a collection of many small systems, there are
3683: sometimes changes that only work when the whole pkgsrc tree is
3684: updated.</p></li>
3685: <li><p>Make sure that you don't have any CVS conflicts.
3686: Search for “<span class="quote"><<<<<<</span>” or
3687: “<span class="quote">>>>>>></span>” in all your pkgsrc
3688: files.</p></li>
3689: <li><p>Make sure that you don't have old copies of the packages
3690: extracted. Run <span><strong class="command">make clean clean-depends</strong></span> to
3691: verify this.</p></li>
3692: <li><p>If the problem still exists, write a mail to the
3693: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3694: </ol></div>
3695: </div>
1.88 wiz 3696: <div class="sect1" lang="en">
3697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 3698: <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 3699: <p>You have modified a file from pkgsrc, and someone else has
3700: modified that same file afterwards in the CVS repository. Both changes
3701: are in the same region of the file, so when you updated pkgsrc, the
3702: <code class="literal">cvs</code> command marked the conflicting changes in the
3703: file. Because of these markers, the file is no longer a valid
3704: <code class="filename">Makefile</code>.</p>
3705: <p>Have a look at that file, and if you don't need your local changes
3706: anymore, you can remove that file and run <span><strong class="command">cvs -q update
3707: -dP</strong></span> in that directory to download the current version.</p>
3708: </div>
1.75 rillig 3709: </div>
3710: </div>
3711: <div class="part" lang="en">
3712: <div class="titlepage"><div><div><h1 class="title">
3713: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3714: <div class="partintro" lang="en">
3715: <div></div>
3716: <p>This part of the book deals with creating and
3717: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3718: guide on creating a new package. The remaining chapters are more
3719: like a reference manual for pkgsrc.</p>
1.75 rillig 3720: <div class="toc">
3721: <p><b>Table of Contents</b></p>
3722: <dl>
1.90 rillig 3723: <dt><span class="chapter"><a href="#creating">9. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3724: <dd><dl>
3725: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3726: <dd><dl>
3727: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3728: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3729: </dl></dd>
3730: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3731: <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>
3732: </dl></dd>
1.90 rillig 3733: <dt><span class="chapter"><a href="#components">10. Package components - files, directories and contents</a></span></dt>
1.75 rillig 3734: <dd><dl>
1.90 rillig 3735: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
3736: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
3737: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
3738: <dd><dl>
1.93 rillig 3739: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
3740: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
3741: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
3742: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
3743: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 3744: </dl></dd>
3745: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
3746: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
3747: <dd><dl>
3748: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
3749: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
3750: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
3751: </dl></dd>
3752: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
3753: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
3754: </dl></dd>
3755: <dt><span class="chapter"><a href="#makefile">11. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3756: <dd><dl>
1.97 rillig 3757: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
3758: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
3759: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
3760: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
3761: <dd><dl>
3762: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
3763: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
3764: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
3765: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
3766: <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 3767: </dl></dd>
3768: </dl></dd>
3769: <dt><span class="chapter"><a href="#plist">12. PLIST issues</a></span></dt>
3770: <dd><dl>
3771: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
3772: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3773: <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>
3774: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
3775: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
3776: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3777: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
3778: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
3779: </dl></dd>
3780: <dt><span class="chapter"><a href="#buildlink">13. Buildlink methodology</a></span></dt>
3781: <dd><dl>
3782: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
3783: <dt><span class="sect1"><a href="#creating-buildlink3.mk">13.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3784: <dd><dl>
3785: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3786: <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>
3787: </dl></dd>
3788: <dt><span class="sect1"><a href="#writing-builtin.mk">13.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3789: <dd><dl>
3790: <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>
3791: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">13.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3792: </dl></dd>
3793: </dl></dd>
3794: <dt><span class="chapter"><a href="#pkginstall">14. The pkginstall framework</a></span></dt>
3795: <dd><dl>
3796: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">14.1. Files and directories outside the installation prefix</a></span></dt>
3797: <dd><dl>
3798: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
3799: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
3800: </dl></dd>
3801: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
3802: <dd><dl>
3803: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3804: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
3805: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
3806: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
3807: </dl></dd>
3808: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
3809: <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>
3810: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
3811: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
3812: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
3813: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
3814: <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>
3815: </dl></dd>
3816: <dt><span class="chapter"><a href="#options">15. Options handling</a></span></dt>
3817: <dd><dl>
3818: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
3819: <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>
3820: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
3821: </dl></dd>
3822: <dt><span class="chapter"><a href="#build">16. The build process</a></span></dt>
3823: <dd><dl>
3824: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
3825: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
3826: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
3827: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
3828: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3829: <dd><dl>
3830: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
3831: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
3832: </dl></dd>
3833: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3834: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3835: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3836: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3837: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3838: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3839: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3840: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3841: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3842: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3843: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
3844: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
3845: </dl></dd>
3846: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
3847: <dd><dl>
3848: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
3849: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
3850: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 3851: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.90 rillig 3852: </dl></dd>
3853: <dt><span class="chapter"><a href="#fixes">18. Making your package work</a></span></dt>
3854: <dd><dl>
3855: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
3856: <dd><dl>
3857: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
3858: <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>
3859: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
3860: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
3861: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
3862: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
3863: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
3864: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
3865: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
3866: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
3867: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3868: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3869: </dl></dd>
3870: <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>
3871: <dd><dl>
3872: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3873: <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>
3874: </dl></dd>
3875: <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>
3876: <dd><dl>
3877: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
3878: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3879: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
3880: </dl></dd>
3881: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
3882: <dd><dl>
3883: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
3884: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
3885: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
3886: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
3887: </dl></dd>
3888: <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>
3889: <dd><dl>
3890: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
3891: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
3892: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3893: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
3894: </dl></dd>
3895: <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>
3896: <dd><dl>
3897: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
3898: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 3899: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103 wiz 3900: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
3901: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3902: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
3903: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
3904: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
3905: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
3906: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
3907: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
3908: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
3909: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
3910: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
3911: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
3912: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
3913: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
3914: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87 wiz 3915: emulation</a></span></dt>
1.103 wiz 3916: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
3917: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3918: </dl></dd>
1.90 rillig 3919: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3920: </dl></dd>
1.90 rillig 3921: <dt><span class="chapter"><a href="#debug">19. Debugging</a></span></dt>
3922: <dt><span class="chapter"><a href="#submit">20. Submitting and Committing</a></span></dt>
1.77 rillig 3923: <dd><dl>
1.90 rillig 3924: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
3925: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3926: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
3927: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
3928: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
3929: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
3930: </dl></dd>
3931: <dt><span class="chapter"><a href="#devfaq">21. Frequently Asked Questions</a></span></dt>
3932: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
3933: <dd><dl>
3934: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
3935: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
3936: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
3937: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 3938: </dl></dd>
1.75 rillig 3939: </dl>
3940: </div>
1.77 rillig 3941: </div>
3942: <div class="chapter" lang="en">
3943: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 3944: <a name="creating"></a>Chapter 9. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3945: <div class="toc">
3946: <p><b>Table of Contents</b></p>
3947: <dl>
3948: <dt><span class="sect1"><a href="#creating.common">9.1. Common types of packages</a></span></dt>
3949: <dd><dl>
3950: <dt><span class="sect2"><a href="#creating.perl-module">9.1.1. Perl modules</a></span></dt>
3951: <dt><span class="sect2"><a href="#creating.kde-app">9.1.2. KDE applications</a></span></dt>
3952: </dl></dd>
3953: <dt><span class="sect1"><a href="#creating.examples">9.2. Examples</a></span></dt>
3954: <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>
3955: </dl>
3956: </div>
1.77 rillig 3957: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3958: most likely have a URL from where you can download the source
3959: code. Starting with this URL, creating a package involves only a
3960: few steps.</p>
1.77 rillig 3961: <div class="procedure"><ol type="1">
1.91 rillig 3962: <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 3963: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3964: category in which you want to place your package. You can also create a
3965: directory of your own (maybe called <code class="filename">local</code>). In that
3966: category directory, create another directory for your package and change
3967: into it.</p></li>
3968: <li><p>Run the program <span><strong class="command">url2pkg</strong></span>, which will ask
3969: you for a URL. Enter the URL of the distribution file (in most cases a
3970: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3971: of your package are created automatically. The distribution file is
3972: extracted automatically to fill in some details in the
3973: <code class="filename">Makefile</code> that would otherwise have to be done
3974: manually.</p></li>
3975: <li>
3976: <p>Examine the extracted files to determine the dependencies of
3977: your package. Ideally, this is mentioned in some
3978: <code class="filename">README</code> file, but things may differ. For each of
3979: these dependencies, look where it exists in pkgsrc, and if there is a
3980: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3981: line to your package <code class="filename">Makefile</code> which includes that
3982: file just before the last line. If the
3983: <code class="filename">buildlink3.mk</code> file does not exist, add a
3984: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3985: version of the dependency and where it can be found in pkgsrc. This line
3986: should be placed in the third paragraph. If the dependency is only
3987: needed for building the package, but not when using it, use
3988: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3989: Your package may then look like this:</p>
1.77 rillig 3990: <pre class="programlisting">
1.100 rillig 3991: [...]
1.77 rillig 3992:
1.100 rillig 3993: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3994: DEPENDS+= screen-[0-9]*:../../misc/screen
3995: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3996:
1.100 rillig 3997: [...]
1.77 rillig 3998:
1.100 rillig 3999: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
4000: .include "../../devel/glib2/buildlink3.mk"
4001: .include "../../mk/bsd.pkg.mk"
1.77 rillig 4002: </pre>
4003: </li>
1.91 rillig 4004: <li><p>Run <span><strong class="command">pkglint</strong></span> to see what things still need
4005: to be done to make your package a “<span class="quote">good</span>” one. If you don't
4006: know what pkglint's warnings want to tell you, try <span><strong class="command">pkglint
4007: --explain</strong></span> or <span><strong class="command">pkglint
4008: -e</strong></span>, which outputs additional
4009: explanations.</p></li>
4010: <li><p>In many cases the package is not yet ready to build. You can
4011: 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
4012: over there, you can hopefully continue here.</p></li>
4013: <li><p>Run <span><strong class="command">bmake clean</strong></span> to clean the working
4014: directory from the extracted files. Besides these files, a lot of cache
4015: files and other system information has been saved in the working
4016: directory, which may become wrong after you edited the
4017: <code class="filename">Makefile</code>.</p></li>
4018: <li><p>Now, run <span><strong class="command">bmake</strong></span> to build the package. For
4019: 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>
4020: <li><p>When the package builds fine, the next step is to install
4021: the package. Run <span><strong class="command">bmake install</strong></span> and hope that
4022: everything works.</p></li>
4023: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
4024: contains a list of the files that are installed by the package, is
4025: nearly empty. Run <span><strong class="command">bmake print-PLIST
4026: >PLIST</strong></span> to generate a probably correct list. Check
4027: the file using your preferred text editor to see if the list of
4028: files looks plausible.</p></li>
4029: <li><p>Run <span><strong class="command">pkglint</strong></span> again to see if the generated
4030: <code class="filename">PLIST</code> contains garbage or not.</p></li>
4031: <li><p>When you ran <span><strong class="command">bmake install</strong></span>, the package
4032: has been registered in the database of installed files, but with an
4033: empty list of files. To fix this, run <span><strong class="command">bmake deinstall</strong></span>
4034: and <span><strong class="command">bmake install</strong></span> again. Now the package is
4035: registered with the list of files from
4036: <code class="filename">PLIST</code>.</p></li>
4037: <li><p>Run <span><strong class="command">bmake package</strong></span> to create a binary
4038: package from the set of installed files.</p></li>
1.77 rillig 4039: </ol></div>
1.91 rillig 4040: <div class="sect1" lang="en">
4041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4042: <a name="creating.common"></a>9.1. Common types of packages</h2></div></div></div>
4043: <div class="sect2" lang="en">
4044: <div class="titlepage"><div><div><h3 class="title">
4045: <a name="creating.perl-module"></a>9.1.1. Perl modules</h3></div></div></div>
4046: <p>Simple Perl modules are handled automatically by
4047: <span><strong class="command">url2pkg</strong></span>, including dependencies.</p>
4048: </div>
4049: <div class="sect2" lang="en">
4050: <div class="titlepage"><div><div><h3 class="title">
4051: <a name="creating.kde-app"></a>9.1.2. KDE applications</h3></div></div></div>
4052: <p>KDE applications should always include
4053: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4054: settings that are typical of KDE packages.</p>
4055: </div>
4056: </div>
4057: <div class="sect1" lang="en">
4058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4059: <a name="creating.examples"></a>9.2. Examples</h2></div></div></div>
4060: <div class="sect2" lang="en">
4061: <div class="titlepage"><div><div><h3 class="title">
4062: <a name="creating.nvu"></a>9.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
4063: <div class="sect3" lang="en">
4064: <div class="titlepage"><div><div><h4 class="title">
4065: <a name="creating.nvu.init"></a>9.2.1.1. The initial package</h4></div></div></div>
4066: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4067: that the “<span class="quote">nvu</span>” package has not yet been imported into
4068: pkgsrc. As the description says it has to do with the web, the obvious
4069: choice for the category is “<span class="quote">www</span>”.</p>
4070: <pre class="programlisting">
1.100 rillig 4071: <code class="prompt">$</code> mkdir www/nvu
4072: <code class="prompt">$</code> cd www/nvu
1.91 rillig 4073: </pre>
4074: <p>The web site says that the sources are available as a tar file, so
4075: I fed that URL to the <span><strong class="command">url2pkg</strong></span> program:</p>
4076: <pre class="programlisting">
1.100 rillig 4077: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 4078: </pre>
4079: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4080: below the <code class="varname">DISTNAME</code> line, as the package name should
4081: not have the word “<span class="quote">sources</span>” in it. I also filled in the
4082: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4083: <code class="varname">COMMENT</code> fields. Then the package
4084: <code class="filename">Makefile</code> looked like that:</p>
4085: <pre class="programlisting">
1.100 rillig 4086: # $NetBSD$
4087: #
1.91 rillig 4088:
1.100 rillig 4089: DISTNAME= nvu-1.0-sources
4090: PKGNAME= nvu-1.0
4091: CATEGORIES= www
4092: MASTER_SITES= http://cvs.nvu.com/download/
4093: EXTRACT_SUFX= .tar.bz2
4094:
4095: MAINTAINER= rillig@NetBSD.org
4096: HOMEPAGE= http://cvs.nvu.com/
4097: COMMENT= Web Authoring System
1.91 rillig 4098:
1.100 rillig 4099: # url2pkg-marker (please do not remove this line.)
4100: .include "../../mk/bsd.pkg.mk"
1.91 rillig 4101: </pre>
4102: <p>Then, I quit the editor and watched pkgsrc downloading a large
4103: source archive:</p>
4104: <pre class="programlisting">
1.100 rillig 4105: url2pkg> Running "make makesum" ...
4106: => Required installed package digest>=20010302: digest-20060826 found
4107: => Fetching nvu-1.0-sources.tar.bz2
4108: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4109: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4110: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4111: url2pkg> Running "make extract" ...
4112: => Required installed package digest>=20010302: digest-20060826 found
4113: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4114: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4115: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4116: ===> Installing dependencies for nvu-1.0
4117: ===> Overriding tools for nvu-1.0
4118: ===> Extracting for nvu-1.0
4119: url2pkg> Adjusting the Makefile.
1.91 rillig 4120:
1.100 rillig 4121: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 4122:
1.100 rillig 4123: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 4124: </pre>
4125: </div>
4126: <div class="sect3" lang="en">
4127: <div class="titlepage"><div><div><h4 class="title">
4128: <a name="creating.nvu.problems"></a>9.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4129: <p>Now that the package has been extracted, let's see what's inside
4130: it. The package has a <code class="filename">README.txt</code>, but that only
4131: says something about mozilla, so it's probably useless for seeing what
4132: dependencies this package has. But since there is a GNU configure script
4133: in the package, let's hope that it will complain about everything it
4134: needs.</p>
4135: <pre class="programlisting">
1.100 rillig 4136: <code class="prompt">$</code> bmake
4137: => Required installed package digest>=20010302: digest-20060826 found
4138: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4139: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4140: ===> Patching for nvu-1.0
4141: ===> Creating toolchain wrappers for nvu-1.0
4142: ===> Configuring for nvu-1.0
4143: [...]
4144: configure: error: Perl 5.004 or higher is required.
4145: [...]
4146: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4147: [...]
1.91 rillig 4148: </pre>
4149: <p>That worked quite well. So I opened the package Makefile in my
4150: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4151: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4152: package have changed now, and since a perl wrapper is automatically
4153: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4154: from scratch.</p>
4155: <pre class="programlisting">
1.100 rillig 4156: <code class="prompt">$</code> bmake clean
4157: ===> Cleaning for nvu-1.0
4158: <code class="prompt">$</code> bmake
4159: [...]
4160: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4161: GNU Make. You will not be able to build Mozilla without GNU Make.
4162: [...]
1.91 rillig 4163: </pre>
4164: <p>So I added “<span class="quote">gmake</span>” to the
4165: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4166: <pre class="programlisting">
1.100 rillig 4167: [...]
4168: checking for GTK - version >= 1.2.0... no
4169: *** Could not run GTK test program, checking why...
4170: [...]
1.91 rillig 4171: </pre>
4172: <p>Now to the other dependencies. The first question is: Where is the
4173: GTK package hidden in pkgsrc?</p>
4174: <pre class="programlisting">
1.100 rillig 4175: <code class="prompt">$</code> echo ../../*/gtk*
4176: [many packages ...]
4177: <code class="prompt">$</code> echo ../../*/gtk
4178: ../../x11/gtk
4179: <code class="prompt">$</code> echo ../../*/gtk2
4180: ../../x11/gtk2
4181: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4182: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4183: </pre>
4184: <p>The first try was definitely too broad. The second one had exactly
4185: one result, which is very good. But there is one pitfall with GNOME
4186: packages. Before GNOME 2 had been released, there were already many
4187: GNOME 1 packages in pkgsrc. To be able to continue to use these
4188: packages, the GNOME 2 packages were imported as separate packages, and
4189: their names usually have a “<span class="quote">2</span>” appended. So I checked
4190: whether this was the case here, and indeed it was.</p>
4191: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4192: file, adding the dependency is very easy. I just inserted an
4193: <code class="literal">.include</code> line before the last line of the package
4194: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4195: <pre class="programlisting">
1.100 rillig 4196: [...]
4197: .include "../../x11/gtk2/buildlink3.mk"
4198: .include "../../mk/bsd.pkg.mk
1.91 rillig 4199: </pre>
4200: <p>After another <span><strong class="command">bmake clean && bmake</strong></span>, the answer
4201: was:</p>
4202: <pre class="programlisting">
1.100 rillig 4203: [...]
4204: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4205: checking for GTK - version >= 1.2.0... no
4206: *** Could not run GTK test program, checking why...
4207: *** The test program failed to compile or link. See the file config.log for the
4208: *** exact error that occured. This usually means GTK was incorrectly installed
4209: *** or that you have moved GTK since it was installed. In the latter case, you
4210: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4211: configure: error: Test for GTK failed.
4212: [...]
1.91 rillig 4213: </pre>
4214: <p>In this particular case, the assumption that “<span class="quote">every package
4215: prefers GNOME 2</span>” had been wrong. The first of the lines above
4216: told me that this package really wanted to have the GNOME 1 version of
4217: GTK. If the package had looked for GTK2, it would have looked for
4218: <span><strong class="command">pkg-config</strong></span> instead of <span><strong class="command">gtk-config</strong></span>.
4219: So I changed the <code class="literal">x11/gtk2</code> to
4220: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4221: and tried again.</p>
4222: <pre class="programlisting">
1.100 rillig 4223: [...]
4224: 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
4225: In file included from xpidl.c:42:
4226: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4227: In file included from xpidl.c:42:
4228: xpidl.h:132: error: parse error before "IDL_ns"
4229: [...]
1.91 rillig 4230: </pre>
4231: <p>The package still does not find all of its dependencies. Now the
4232: question is: Which package provides the
4233: <code class="filename">libIDL/IDL.h</code> header file?</p>
4234: <pre class="programlisting">
1.100 rillig 4235: <code class="prompt">$</code> echo ../../*/*idl*
4236: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4237: <code class="prompt">$</code> echo ../../*/*IDL*
4238: ../../net/libIDL
1.91 rillig 4239: </pre>
4240: <p>Let's take the one from the second try. So I included the
4241: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4242: again. But the error didn't change. After digging through some of the
4243: code, I concluded that the build process of the package was broken and
4244: couldn't have ever worked, but since the Mozilla source tree is quite
4245: large, I didn't want to fix it. So I added the following to the package
4246: <code class="filename">Makefile</code> and tried again:</p>
4247: <pre class="programlisting">
1.100 rillig 4248: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4249: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4250: </pre>
4251: <p>The latter line is needed because the package expects the library
4252: <code class="filename">libIDL.so</code>, but only
4253: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4254: wrapper to rewrite that on the fly.</p>
4255: <p>The next problem was related to a recent change of the FreeType
4256: 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>
4257: which patch files were relevant for this issue and copied them to the
4258: <code class="filename">patches</code> directory. Then I retried, fixed the
4259: patches so that they applied cleanly and retried again. This time,
4260: everything worked.</p>
4261: </div>
4262: <div class="sect3" lang="en">
4263: <div class="titlepage"><div><div><h4 class="title">
4264: <a name="creating.nvu.inst"></a>9.2.1.3. Installing the package</h4></div></div></div>
4265: <pre class="programlisting">
1.100 rillig 4266: <code class="prompt">$</code> bmake CHECK_FILES=no install
4267: [...]
4268: <code class="prompt">$</code> bmake print-PLIST >PLIST
4269: <code class="prompt">$</code> bmake deinstall
4270: <code class="prompt">$</code> bmake install
1.91 rillig 4271: </pre>
4272: </div>
4273: </div>
4274: </div>
1.77 rillig 4275: </div>
1.75 rillig 4276: <div class="chapter" lang="en">
4277: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4278: <a name="components"></a>Chapter 10. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4279: <div class="toc">
4280: <p><b>Table of Contents</b></p>
4281: <dl>
1.90 rillig 4282: <dt><span class="sect1"><a href="#components.Makefile">10.1. <code class="filename">Makefile</code></a></span></dt>
4283: <dt><span class="sect1"><a href="#components.distinfo">10.2. <code class="filename">distinfo</code></a></span></dt>
4284: <dt><span class="sect1"><a href="#components.patches">10.3. patches/*</a></span></dt>
4285: <dd><dl>
1.93 rillig 4286: <dt><span class="sect2"><a href="#components.patch.structure">10.3.1. Structure of a single patch file</a></span></dt>
4287: <dt><span class="sect2"><a href="#components.patches.caveats">10.3.2. Creating patch files</a></span></dt>
4288: <dt><span class="sect2"><a href="#components.patches.sources">10.3.3. Sources where the patch files come from</a></span></dt>
4289: <dt><span class="sect2"><a href="#components.patches.guidelines">10.3.4. Patching guidelines</a></span></dt>
4290: <dt><span class="sect2"><a href="#components.patches.feedback">10.3.5. Feedback to the author</a></span></dt>
1.90 rillig 4291: </dl></dd>
4292: <dt><span class="sect1"><a href="#other-mandatory-files">10.4. Other mandatory files</a></span></dt>
4293: <dt><span class="sect1"><a href="#components.optional">10.5. Optional files</a></span></dt>
4294: <dd><dl>
4295: <dt><span class="sect2"><a href="#components.optional.bin">10.5.1. Files affecting the binary package</a></span></dt>
4296: <dt><span class="sect2"><a href="#components.optional.build">10.5.2. Files affecting the build process</a></span></dt>
4297: <dt><span class="sect2"><a href="#components.optional.none">10.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4298: </dl></dd>
1.90 rillig 4299: <dt><span class="sect1"><a href="#work-dir">10.6. <code class="filename">work*</code></a></span></dt>
4300: <dt><span class="sect1"><a href="#files-dir">10.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4301: </dl>
4302: </div>
1.87 wiz 4303: <p>Whenever you're preparing a package, there are a number of
4304: files involved which are described in the following
4305: sections.</p>
1.75 rillig 4306: <div class="sect1" lang="en">
4307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4308: <a name="components.Makefile"></a>10.1. <code class="filename">Makefile</code>
4309: </h2></div></div></div>
1.75 rillig 4310: <p>Building, installation and creation of a binary package are all
1.87 wiz 4311: controlled by the package's <code class="filename">Makefile</code>.
4312: The <code class="filename">Makefile</code> describes various things about
4313: a package, for example from where to get it, how to configure,
4314: build, and install it.</p>
1.76 rillig 4315: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4316: sections that describe the package.</p>
1.75 rillig 4317: <p>In the first section there are the following variables, which
1.87 wiz 4318: should appear exactly in the order given here. The order and
4319: grouping of the variables is mostly historical and has no further
4320: meaning.</p>
1.75 rillig 4321: <div class="itemizedlist"><ul type="disc">
4322: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4323: distribution file to be downloaded from the package's
4324: website.</p></li>
1.75 rillig 4325: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4326: package, as used by pkgsrc. You only need to provide it if
4327: <code class="varname">DISTNAME</code> (which is the default) is not a good
4328: name for the package in pkgsrc. Usually it is the pkgsrc
4329: directory name together with the version number. It must match the
4330: regular expression
4331: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4332: starts with a letter or digit, and contains only letters, digits,
4333: dashes, underscores, dots and plus signs.</p></li>
4334: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4335: the package file to create if the <code class="varname">PKGNAME</code>
4336: isn't unique on a SVR4 system. The default is
4337: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4338: <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 4339: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4340: does not produce an unique package name on a SVR4 system.
4341: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4342: characters.</p></li>
1.75 rillig 4343: <li>
4344: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4345: which the package fits in. You can choose any of the top-level
4346: directories of pkgsrc for it.</p>
1.75 rillig 4347: <p>Currently the following values are available for
1.87 wiz 4348: <code class="varname">CATEGORIES</code>. If more than
4349: one is used, they need to be separated by spaces:</p>
1.75 rillig 4350: <pre class="programlisting">
1.100 rillig 4351: archivers cross geography meta-pkgs security
4352: audio databases graphics misc shells
4353: benchmarks devel ham multimedia sysutils
4354: biology editors inputmethod net textproc
4355: cad emulators lang news time
4356: chat finance mail parallel wm
4357: comms fonts math pkgtools www
4358: converters games mbone print x11
4359: </pre>
1.75 rillig 4360: </li>
1.81 rillig 4361: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4362: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4363: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4364: and <code class="varname">DISTFILES</code> are discussed in detail in
1.90 rillig 4365: <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 4366: </ul></div>
4367: <p>The second section contains information about separately
1.87 wiz 4368: downloaded patches, if any.
4369: </p>
1.75 rillig 4370: <div class="itemizedlist"><ul type="disc">
4371: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4372: Name(s) of additional files that contain distribution patches.
4373: There is no default. pkgsrc will look for them at
4374: <code class="varname">PATCH_SITES</code>.
4375: They will automatically be uncompressed before patching if
4376: the names end with <code class="filename">.gz</code> or
4377: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4378: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4379: Primary location(s) for distribution patch files (see
4380: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4381: </ul></div>
4382: <p>The third section contains the following variables.
1.87 wiz 4383: </p>
1.75 rillig 4384: <div class="itemizedlist"><ul type="disc">
4385: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4386: of the person who feels responsible for this package, and who is
4387: most likely to look at problems or questions regarding this
4388: 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
4389: developers should contact the <code class="varname">MAINTAINER</code> before
4390: making major changes to the package. When packaging a new program,
4391: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4392: maintain the package for future updates, set it to
4393: <code class="email"><<a href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4394: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4395: find more information about the package.</p></li>
1.75 rillig 4396: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4397: description of the package (should not include the package
4398: name).</p></li>
1.75 rillig 4399: </ul></div>
4400: <p>Other variables that affect the build:
1.87 wiz 4401: </p>
1.75 rillig 4402: <div class="itemizedlist"><ul type="disc"><li>
4403: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4404: interesting distribution files of the package are found. The
4405: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4406: works for most packages.</p>
1.75 rillig 4407: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4408: (most GNU software does, for instance), but extracts itself in
4409: the current directory, you should set
4410: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4411: <p>If a package doesn't create a subdirectory with the
4412: name of <code class="varname">DISTNAME</code> but some different name,
4413: set <code class="varname">WRKSRC</code> to point to the proper name in
4414: <code class="filename">${WRKDIR}</code>, for example
4415: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4416: <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 4417: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4418: taken from the <code class="varname">WRKDIR_BASENAME</code>
4419: variable. By default, its value is
4420: <code class="filename">work</code>. If you want to use the same
4421: pkgsrc tree for building different kinds of binary packages,
4422: you can change the variable according to your needs. Two
4423: other variables handle common cases of setting
4424: <code class="varname">WRKDIR_BASENAME</code> individually. If
4425: <code class="varname">OBJHOSTNAME</code> is defined in
1.104 ! rillig 4426: <a href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4427: the host's name is attached to the directory name. If
4428: <code class="varname">OBJMACHINE</code> is defined, the platform name
4429: is attached, which might look like
4430: <code class="filename">work.i386</code> or
4431: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4432: </li></ul></div>
4433: <p>Please pay attention to the following gotchas:</p>
4434: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4435: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4436: installed in compressed form by the package. For packages using
4437: BSD-style makefiles which honor MANZ, there is
4438: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4439: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4440: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4441: below).</p></li>
1.103 wiz 4442: <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 4443: </ul></div>
4444: </div>
4445: <div class="sect1" lang="en">
4446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4447: <a name="components.distinfo"></a>10.2. <code class="filename">distinfo</code>
4448: </h2></div></div></div>
1.76 rillig 4449: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4450: digest, or checksum, of each distfile needed for the package. This
4451: ensures that the distfiles retrieved from the Internet have not been
4452: corrupted during transfer or altered by a malign force to introduce
4453: a security hole. Due to recent rumor about weaknesses of digest
4454: algorithms, all distfiles are protected using both SHA1 and RMD160
4455: message digests, as well as the file size.</p>
1.76 rillig 4456: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4457: checksums for all the patches found in the
1.90 rillig 4458: <code class="filename">patches</code> directory (see <a href="#components.patches" title="10.3. patches/*">Section 10.3, “patches/*”</a>).</p>
1.76 rillig 4459: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.87 wiz 4460: <span><strong class="command">make makedistinfo</strong></span> or <span><strong class="command">make mdi</strong></span>
4461: command.</p>
1.75 rillig 4462: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4463: 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 4464: <code class="filename">distinfo</code> file and care should be taken when
4465: upgrading such a package to ensure distfile information is not
4466: lost.</p>
1.75 rillig 4467: </div>
4468: <div class="sect1" lang="en">
4469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4470: <a name="components.patches"></a>10.3. patches/*</h2></div></div></div>
1.93 rillig 4471: <p>Many packages still don't work out-of-the box on the various
4472: platforms that are supported by pkgsrc. Therefore, a number of custom
4473: patch files are needed to make the package work. These patch files are
4474: found in the <code class="filename">patches/</code> directory.</p>
4475: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4476: applied to the files in <code class="varname">WRKSRC</code> directory after
4477: extracting them, in <a href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4478: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4479: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4480: <div class="sect2" lang="en">
4481: <div class="titlepage"><div><div><h3 class="title">
4482: <a name="components.patch.structure"></a>10.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4483: <p>The <code class="filename">patch-*</code> files should be in
1.87 wiz 4484: <span><strong class="command">diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4485: problems. (To force patches to apply with fuzz you can set
4486: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4487: should contain only changes for a single file, and no file should be
1.93 rillig 4488: patched by more than one patch file. This helps to keep future
4489: modifications simple.</p>
4490: <p>Each patch file is structured as follows: In the first line,
4491: there is the RCS Id of the patch itself. The second line should be
4492: empty for aesthetic reasons. After that, there should be a comment for
4493: each change that the patch does. There are a number of standard
4494: cases:</p>
4495: <div class="itemizedlist"><ul type="disc">
4496: <li><p>Patches that replace the <code class="literal">==</code>
4497: 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
4498: should contain a reference to , to avoid
4499: redundant explanations.</p></li>
4500: <li><p>Patches for commonly known vulnerabilities should
4501: mention the vulnerability ID (CAN, CVE).</p></li>
4502: <li><p>Patches that change source code should mention the
4503: platform and other environment (for example, the compiler) that the
4504: patch is needed for.</p></li>
4505: </ul></div>
4506: <p>In all other cases, the patch should be commented so that any
4507: developer who knows the code of the application can make some use of
4508: the patch. Special care should be taken for the upstream developers,
4509: since we generally want that they accept our patches, so we have less
4510: work in the future.</p>
4511: </div>
4512: <div class="sect2" lang="en">
4513: <div class="titlepage"><div><div><h3 class="title">
4514: <a name="components.patches.caveats"></a>10.3.2. Creating patch files</h3></div></div></div>
4515: <p>One important thing to mention is to pay attention that no RCS
4516: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4517: later checked into the NetBSD CVS tree. Use the
1.93 rillig 4518: <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
4519: problems.</p>
1.87 wiz 4520: <p>For even more automation, we recommend using
4521: <span><strong class="command">mkpatches</strong></span> from the same package to make a
4522: whole set of patches. You just have to backup files before you
4523: edit them to <code class="filename">filename.orig</code>, e.g. with
4524: <span><strong class="command">cp -p filename filename.orig</strong></span> or, easier, by
4525: using <span><strong class="command">pkgvi</strong></span> again from the same package. If
4526: you upgrade a package this way, you can easily compare the new
4527: set of patches with the previously existing one with
4528: <span><strong class="command">patchdiff</strong></span>. Copy the patches you want to use
4529: or update from the <code class="filename">work/.newpatches</code>
4530: directory to <code class="filename">patches/</code>.</p>
4531: <p>When you have finished a package, remember to generate
4532: the checksums for the patch files by using the <span><strong class="command">make
1.90 rillig 4533: 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 4534: <p>When adding a patch that corrects a problem in the
4535: distfile (rather than e.g. enforcing pkgsrc's view of where
4536: man pages should go), send the patch as a bug report to the
4537: maintainer. This benefits non-pkgsrc users of the package,
4538: and usually makes it possible to remove the patch in future
4539: version.</p>
1.101 rillig 4540: <p>The file names of the patch files are usually of the form
4541: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4542: </div>
4543: <div class="sect2" lang="en">
4544: <div class="titlepage"><div><div><h3 class="title">
4545: <a name="components.patches.sources"></a>10.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4546: <p>If you want to share patches between multiple packages
4547: in pkgsrc, e.g. because they use the same distfiles, set
4548: <code class="varname">PATCHDIR</code> to the path where the patch files
4549: can be found, e.g.:</p>
4550: <pre class="programlisting">
1.100 rillig 4551: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4552: </pre>
1.75 rillig 4553: <p>Patch files that are distributed by the author or other
1.87 wiz 4554: maintainers can be listed in
4555: <code class="varname">PATCHFILES</code>.</p>
4556: <p>If it is desired to store any patches that should not be
4557: committed into pkgsrc, they can be kept outside the pkgsrc
4558: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4559: directory tree there is expected to have the same
4560: “<span class="quote">category/package</span>” structure as pkgsrc, and
4561: patches are expected to be stored inside these dirs (also
4562: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4563: example, if you want to keep a private patch for
4564: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4565: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4566: files in the named directory are expected to be patch files,
4567: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4568: applied</em></span>.</p>
1.93 rillig 4569: </div>
1.85 jmmv 4570: <div class="sect2" lang="en">
4571: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4572: <a name="components.patches.guidelines"></a>10.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4573: <p>When fixing a portability issue in the code do not use
4574: preprocessor magic to check for the current operating system nor
4575: platform. Doing so hurts portability to other platforms because
4576: the OS-specific details are not abstracted appropriately.</p>
4577: <p>The general rule to follow is: instead of checking for the
4578: operating system the application is being built on, check for the
4579: specific <span class="emphasis"><em>features</em></span> you need. For example,
4580: instead of assuming that kqueue is available under NetBSD and
4581: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.104 ! rillig 4582: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4583: yes, this generally involves patching the
4584: <span><strong class="command">configure</strong></span> script. There is absolutely nothing
4585: that prevents some OSes from adopting interfaces from other OSes
4586: (e.g. Linux implementing kqueue), something that the above checks
4587: cannot take into account.</p>
4588: <p>Of course, checking for features generally involves more
4589: work on the developer's side, but the resulting changes are
1.87 wiz 4590: cleaner and there are chances they will work on many other
1.85 jmmv 4591: platforms. Not to mention that there are higher chances of being
4592: later integrated into the mainstream sources. Remember:
4593: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4594: <p>Some typical examples:</p>
4595: <div class="table">
1.90 rillig 4596: <a name="patch-examples"></a><p class="title"><b>Table 10.1. Patching examples</b></p>
1.91 rillig 4597: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4598: <colgroup>
4599: <col>
4600: <col>
4601: <col>
4602: </colgroup>
4603: <thead><tr>
4604: <th>Where</th>
4605: <th>Incorrect</th>
4606: <th>Correct</th>
4607: </tr></thead>
4608: <tbody>
4609: <tr>
4610: <td>configure script</td>
4611: <td>
1.100 rillig 4612: <pre class="programlisting">
4613: case ${target_os} in
4614: netbsd*) have_kvm=yes ;;
4615: *) have_kvm=no ;;
4616: esac
4617: </pre>
1.85 jmmv 4618: </td>
4619: <td>
1.100 rillig 4620: <pre class="programlisting">
4621: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4622: </pre>
1.85 jmmv 4623: </td>
4624: </tr>
4625: <tr>
4626: <td>C source file</td>
4627: <td>
1.100 rillig 4628: <pre class="programlisting">
4629: #if defined(__NetBSD__)
4630: # include <sys/event.h>
4631: #endif
4632: </pre>
1.85 jmmv 4633: </td>
4634: <td>
1.100 rillig 4635: <pre class="programlisting">
4636: #if defined(HAVE_SYS_EVENT_H)
4637: # include <sys/event.h>
4638: #endif
4639: </pre>
1.85 jmmv 4640: </td>
4641: </tr>
4642: <tr>
4643: <td>C source file</td>
4644: <td>
1.100 rillig 4645: <pre class="programlisting">
4646: int
4647: monitor_file(...)
4648: {
4649: #if defined(__NetBSD__)
4650: int fd = kqueue();
4651: ...
4652: #else
4653: ...
4654: #endif
4655: }
4656: </pre>
1.85 jmmv 4657: </td>
4658: <td>
1.100 rillig 4659: <pre class="programlisting">
4660: int
4661: monitor_file(...)
4662: {
4663: #if defined(HAVE_KQUEUE)
4664: int fd = kqueue();
4665: ...
4666: #else
4667: ...
4668: #endif
4669: }
4670: </pre>
1.85 jmmv 4671: </td>
4672: </tr>
4673: </tbody>
1.91 rillig 4674: </table></div>
1.85 jmmv 4675: </div>
1.91 rillig 4676: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.85 jmmv 4677: packager-friendly software</em></span> article (<a href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4678: 1</a>, <a href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4679: 2</a>). It summarizes multiple details on how to make
4680: software easier to package; all the suggestions in it were
4681: collected from our experience in pkgsrc work, so they are possibly
4682: helpful when creating patches too.</p>
4683: </div>
4684: <div class="sect2" lang="en">
4685: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 4686: <a name="components.patches.feedback"></a>10.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4687: <p>Always, always, <span class="strong"><strong>always</strong></span>
4688: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4689: improvements you do to a package to the mainstream developers.
4690: This is the only way to get their attention on portability issues
4691: and to ensure that future versions can be built out-of-the box on
4692: NetBSD. Furthermore, any user that gets newer distfiles will get
4693: the fixes straight from the packaged code.</p>
1.93 rillig 4694: <p>This generally involves cleaning up the patches
4695: (because sometimes the patches that are
1.85 jmmv 4696: added to pkgsrc are quick hacks), filling bug reports in the
4697: appropriate trackers for the projects and working with the
4698: mainstream authors to accept your changes. It is
4699: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4700: the packages in pkgsrc are kept simple and thus further changes
4701: can be done without much hassle.</p>
4702: <p>Support the idea of free software!</p>
4703: </div>
1.75 rillig 4704: </div>
4705: <div class="sect1" lang="en">
4706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4707: <a name="other-mandatory-files"></a>10.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4708: <div class="variablelist"><dl>
1.76 rillig 4709: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4710: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4711: any credits where they are due. Please bear in mind that others do not
4712: share your sense of humour (or spelling idiosyncrasies), and that others
4713: will read everything that you write here.</p></dd>
1.76 rillig 4714: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4715: <dd><p>This file governs the files that are installed on your
4716: system: all the binaries, manual pages, etc. There are other
4717: directives which may be entered in this file, to control the
4718: creation and deletion of directories, and the location of
1.90 rillig 4719: inserted files. See <a href="#plist" title="Chapter 12. PLIST issues">Chapter 12, <i>PLIST issues</i></a> for more
1.87 wiz 4720: information.</p></dd>
1.75 rillig 4721: </dl></div>
4722: </div>
4723: <div class="sect1" lang="en">
4724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 4725: <a name="components.optional"></a>10.5. Optional files</h2></div></div></div>
1.78 rillig 4726: <div class="sect2" lang="en">
4727: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4728: <a name="components.optional.bin"></a>10.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4729: <div class="variablelist"><dl>
1.76 rillig 4730: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.75 rillig 4731: <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 4732: First time after package extraction and before files are
4733: moved in place, the second time after the files to install
4734: are moved in place. This can be used to do any custom
4735: procedures not possible with @exec commands in
4736: <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 4737: <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 4738: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4739: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4740: this script's responsibility to clean up any additional messy details
4741: around the package's installation, since all pkg_delete knows is how to
4742: delete the files created in the original distribution.
4743: 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>
4744: 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 4745: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4746: <dd>
4747: <p>This file is displayed after installation of the package.
1.87 wiz 4748: Useful for things like legal notices on almost-free
4749: software and hints for updating config files after
4750: installing modules for apache, PHP etc.
4751: Please note that you can modify variables in it easily by using
4752: <code class="varname">MESSAGE_SUBST</code> in the package's
4753: <code class="filename">Makefile</code>:</p>
1.75 rillig 4754: <pre class="programlisting">
1.100 rillig 4755: MESSAGE_SUBST+= SOMEVAR="somevalue"
4756: </pre>
1.75 rillig 4757: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4758: <code class="filename">MESSAGE</code>. By default, substitution is
4759: performed for <code class="varname">PKGNAME</code>,
4760: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4761: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4762: <code class="varname">X11BASE</code>,
4763: <code class="varname">PKG_SYSCONFDIR</code>,
4764: <code class="varname">ROOT_GROUP</code>, and
4765: <code class="varname">ROOT_GROUP</code>.</p>
4766: <p>You can display a different or additional files by
4767: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4768: default is <code class="filename">MESSAGE</code>, if the file
4769: exists.</p>
1.75 rillig 4770: </dd>
1.78 rillig 4771: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4772: <dd><p>FIXME: There is no documentation on the
4773: alternatives framework.</p></dd>
4774: </dl></div>
4775: </div>
4776: <div class="sect2" lang="en">
4777: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4778: <a name="components.optional.build"></a>10.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4779: <div class="variablelist"><dl>
4780: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4781: <dd><p>This file contains arbitrary things that could
4782: also go into a <code class="filename">Makefile</code>, but its purpose is
4783: to be used by more than one package. This file should only be
4784: used when the packages that will use the file are known in
4785: advance. For other purposes it is often better to write a
4786: <code class="filename">*.mk</code> file and give it a good name that
4787: describes what it does.</p></dd>
4788: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4789: <dd><p>This file contains the dependency information
1.90 rillig 4790: 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 4791: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4792: <dd><p>This file contains workarounds for compiler bugs
4793: and similar things. It is included automatically by the pkgsrc
4794: infrastructure, so you don't need an extra
4795: <code class="literal">.include</code> line for
4796: it.</p></dd>
4797: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4798: <dd><p>This file contains the code for the
1.90 rillig 4799: 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 4800: selected by the user. If a package has only one or two options,
4801: it is equally acceptable to put the code directly into the
4802: <code class="filename">Makefile</code>.</p></dd>
4803: </dl></div>
4804: </div>
4805: <div class="sect2" lang="en">
4806: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 4807: <a name="components.optional.none"></a>10.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4808: <div class="variablelist"><dl>
4809: <dt><span class="term"><code class="filename">README*</code></span></dt>
4810: <dd><p>These files do not take place in the creation of
4811: a package and thus are purely informative to the package
4812: developer.</p></dd>
4813: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4814: <dd><p>This file contains things that need to be done
4815: to make the package even
4816: better.</p></dd>
1.75 rillig 4817: </dl></div>
4818: </div>
1.78 rillig 4819: </div>
1.75 rillig 4820: <div class="sect1" lang="en">
4821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4822: <a name="work-dir"></a>10.6. <code class="filename">work*</code>
4823: </h2></div></div></div>
1.75 rillig 4824: <p>When you type <span><strong class="command">make</strong></span>, the distribution files are
1.87 wiz 4825: unpacked into the directory denoted by
4826: <code class="varname">WRKDIR</code>. It can be removed by running
4827: <span><strong class="command">make clean</strong></span>. Besides the sources, this
4828: directory is also used to keep various timestamp files.
4829: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4830: The default is <code class="filename">${.CURDIR}/work</code>
4831: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4832: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4833: </div>
4834: <div class="sect1" lang="en">
4835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 4836: <a name="files-dir"></a>10.7. <code class="filename">files/*</code>
4837: </h2></div></div></div>
1.75 rillig 4838: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4839: to configuration or building, you could place these files here and use
4840: a <span><strong class="command">${CP}</strong></span> command in the
4841: “<span class="quote">pre-configure</span>” target to achieve
4842: this. Alternatively, you could simply diff the file against
4843: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4844: the creation of this file.</p>
4845: <p>If you want to share files in this way with other
4846: packages, set the <code class="varname">FILESDIR</code> variable to point
4847: to the other package's <code class="filename">files</code> directory,
4848: e.g.:</p>
4849: <pre class="programlisting">
1.100 rillig 4850: FILESDIR=${.CURDIR}/../xemacs/files
4851: </pre>
1.75 rillig 4852: </div>
4853: </div>
4854: <div class="chapter" lang="en">
4855: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 4856: <a name="makefile"></a>Chapter 11. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4857: <div class="toc">
4858: <p><b>Table of Contents</b></p>
4859: <dl>
1.97 rillig 4860: <dt><span class="sect1"><a href="#makefile.style">11.1. Caveats</a></span></dt>
4861: <dt><span class="sect1"><a href="#makefile.variables">11.2. <code class="filename">Makefile</code> variables</a></span></dt>
4862: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">11.2.1. Naming conventions</a></span></dt></dl></dd>
4863: <dt><span class="sect1"><a href="#makefile.code">11.3. Code snippets</a></span></dt>
4864: <dd><dl>
4865: <dt><span class="sect2"><a href="#adding-to-list">11.3.1. Adding things to a list</a></span></dt>
4866: <dt><span class="sect2"><a href="#converting-internal-to-external">11.3.2. Converting an internal list into an external list</a></span></dt>
4867: <dt><span class="sect2"><a href="#passing-variable-to-shell">11.3.3. Passing variables to a shell command</a></span></dt>
4868: <dt><span class="sect2"><a href="#quoting-guideline">11.3.4. Quoting guideline</a></span></dt>
4869: <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 4870: </dl></dd>
4871: </dl>
4872: </div>
1.76 rillig 4873: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4874: each of which forms a well-defined part of the pkgsrc system. Using
4875: 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
4876: like pkgsrc requires some discipline to keep the code correct and
4877: understandable.</p>
1.76 rillig 4878: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4879: programming are variables (which are actually macros) and shell
4880: commands. Among these shell commands may even be more complex ones
4881: 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
4882: as intended it is necessary to quote all variables correctly when they
4883: are used.</p>
4884: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4885: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4886: with them.</p>
4887: <div class="sect1" lang="en">
4888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4889: <a name="makefile.style"></a>11.1. Caveats</h2></div></div></div>
4890: <div class="itemizedlist"><ul type="disc"><li>
4891: <p>When you are creating a file as a
4892: target of a rule, always write the data to a temporary file first
4893: and finally rename that file. Otherwise there might occur an error
4894: in the middle of generating the file, and when the user runs
4895: <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
4896: regenerated properly. Example:</p>
4897: <pre class="programlisting">
1.100 rillig 4898: wrong:
4899: @echo "line 1" > ${.TARGET}
4900: @echo "line 2" >> ${.TARGET}
4901: @false
4902:
4903: correct:
4904: @echo "line 1" > ${.TARGET}.tmp
4905: @echo "line 2" >> ${.TARGET}.tmp
4906: @false
4907: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4908: </pre>
4909: <p>When you run <span><strong class="command">make wrong</strong></span> twice, the file
4910: <code class="filename">wrong</code> will exist, although there was an error
4911: message in the first run. On the other hand, running <span><strong class="command">make
4912: correct</strong></span> gives an error message twice, as expected.</p>
4913: <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
4914: <code class="literal">${.TARGET}</code> in case of error, but this only
4915: happens when it is interrupted, for example by pressing
4916: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4917: 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>
4918: </li></ul></div>
4919: </div>
4920: <div class="sect1" lang="en">
4921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4922: <a name="makefile.variables"></a>11.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4923: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4924: can be processed using the five operators ``='', ``+='', ``?='',
4925: ``:='', 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
4926: page.</p>
4927: <p>When a variable's value is parsed from a
1.76 rillig 4928: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4929: backslash character ``\'' are handled specially. If a backslash is
4930: followed by a newline, any whitespace immediately in front of the
4931: backslash, the backslash, the newline, and any whitespace
4932: immediately behind the newline are replaced with a single space. A
4933: backslash character and an immediately following hash character are
4934: replaced with a single hash character. Otherwise, the backslash is
4935: passed as is. In a variable assignment, any hash character that is
4936: not preceded by a backslash starts a comment that continues upto the
4937: end of the logical line.</p>
4938: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4939: the only way to create a variable consisting of a single backslash
4940: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4941: <p>So far for defining variables. The other thing you can do with
4942: variables is evaluating them. A variable is evaluated when it is
4943: part of the right side of the ``:='' or the ``!='' operator, or
4944: directly before executing a shell command which the variable is part
4945: 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
4946: is, variables are not evaluated until there's no other way. The
4947: ``modifiers'' mentioned in the man page also evaluate the
4948: variable.</p>
4949: <p>Some of the modifiers split the string into words and then
4950: operate on the words, others operate on the string as a whole. When
4951: a string is split into words, it is split as you would expect
4952: 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.104 ! rillig 4953: <p>No rule without exception—the <span><strong class="command">.for</strong></span>
1.75 rillig 4954: loop does not follow the shell quoting rules but splits at sequences
4955: of whitespace.</p>
4956: <p>There are several types of variables that should be handled
4957: differently. Strings and two types of lists.</p>
4958: <div class="itemizedlist"><ul type="disc">
4959: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4960: characters. Nevertheless, you should restrict yourself to only
4961: using printable characters. Examples are
4962: <code class="varname">PREFIX</code> and
4963: <code class="varname">COMMENT</code>.</p></li>
4964: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4965: are never exported to any shell command. Their elements are
4966: separated by whitespace. Therefore, the elements themselves cannot
4967: have embedded whitespace. Any other characters are allowed.
4968: Internal lists can be used in <span><strong class="command">.for</strong></span> loops.
4969: Examples are <code class="varname">DEPENDS</code> and
4970: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4971: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4972: may be exported to a shell command. Their elements can contain any
4973: characters, including whitespace. That's why they cannot be used
4974: in <span><strong class="command">.for</strong></span> loops. Examples are
4975: <code class="varname">DISTFILES</code> and
4976: <code class="varname">MASTER_SITES</code>.</p></li>
4977: </ul></div>
4978: <div class="sect2" lang="en">
4979: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 4980: <a name="makefile.variables.names"></a>11.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4981: <div class="itemizedlist"><ul type="disc">
4982: <li><p>All variable names starting with an underscore
4983: are reserved for use by the pkgsrc infrastructure. They shall
4984: not be used by package
1.76 rillig 4985: <code class="filename">Makefile</code>s.</p></li>
1.75 rillig 4986: <li><p>In <span><strong class="command">.for</strong></span> loops you should use
4987: lowercase variable names for the iteration
4988: variables.</p></li>
4989: <li><p>All list variables should have a ``plural''
4990: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4991: <code class="varname">DISTFILES</code>.</p></li>
4992: </ul></div>
4993: </div>
4994: </div>
4995: <div class="sect1" lang="en">
4996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.97 rillig 4997: <a name="makefile.code"></a>11.3. Code snippets</h2></div></div></div>
1.75 rillig 4998: <p>This section presents you with some code snippets you should
4999: use in your own code. If you don't find anything appropriate here,
5000: you should test your code and add it here.</p>
5001: <div class="sect2" lang="en">
5002: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5003: <a name="adding-to-list"></a>11.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 5004: <pre class="programlisting">
1.100 rillig 5005: STRING= foo * bar `date`
5006: INT_LIST= # empty
5007: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
5008: EXT_LIST= # empty
5009: ANOTHER_EXT_LIST= a=b c=d
5010:
5011: INT_LIST+= ${STRING} # 1
5012: INT_LIST+= ${ANOTHER_INT_LIST} # 2
5013: EXT_LIST+= ${STRING:Q} # 3
5014: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 5015: </pre>
1.75 rillig 5016: <p>When you add a string to an external list (example 3), it
5017: must be quoted. In all other cases, you must not add a quoting
5018: level. You must not merge internal and external lists, unless you
5019: are sure that all entries are correctly interpreted in both
5020: lists.</p>
5021: </div>
5022: <div class="sect2" lang="en">
5023: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5024: <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 5025: <pre class="programlisting">
1.100 rillig 5026: EXT_LIST= # empty
5027: .for i in ${INT_LIST}
5028: EXT_LIST+= ${i:Q}""
5029: .endfor
1.1 grant 5030: </pre>
1.75 rillig 5031: <p>This code converts the internal list
5032: <code class="varname">INT_LIST</code> into the external list
5033: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5034: are unquoted they must be quoted here. The reason for appending
5035: <code class="varname">""</code> is explained below.</p>
5036: </div>
5037: <div class="sect2" lang="en">
5038: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5039: <a name="passing-variable-to-shell"></a>11.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 5040: <p>Sometimes you may want to print an arbitrary string. There
5041: are many ways to get it wrong and only few that can handle every
5042: nastiness.</p>
1.75 rillig 5043: <pre class="programlisting">
1.100 rillig 5044: STRING= foo bar < > * `date` $$HOME ' "
5045: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 5046:
1.100 rillig 5047: all:
5048: echo ${STRING} # 1
5049: echo "${STRING}" # 2
5050: echo "${STRING:Q}" # 3
5051: echo ${STRING:Q} # 4
5052: echo x${STRING:Q} | sed 1s,.,, # 5
5053: printf "%s\\n" ${STRING:Q}"" # 6
5054: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 5055: </pre>
1.75 rillig 5056: <p>Example 1 leads to a syntax error in the shell, as the
5057: characters are just copied.</p>
5058: <p>Example 2 leads to a syntax error too, and if you leave out
5059: the last " character from <code class="varname">${STRING}</code>,
5060: <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
5061: variable would be evaluated, too.</p>
5062: <p>Example 3 outputs each space character preceded by a
5063: backslash (or not), depending on the implementation of the
5064: <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>
5065: <p>Example 4 handles correctly every string that does not start
5066: with a dash. In that case, the result depends on the
5067: 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
5068: guarantee that your input does not start with a dash, this form is
5069: appropriate.</p>
5070: <p>Example 5 handles even the case of a leading dash
5071: correctly.</p>
1.79 rillig 5072: <p>Example 6 also works with every string and is the
5073: light-weight solution, since it does not involve a pipe, which has
5074: its own problems.</p>
1.75 rillig 5075: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5076: because the quoting has already been done when adding elements to
5077: the list.</p>
5078: <p>As internal lists shall not be passed to the shell, there is
5079: no example for it.</p>
5080: </div>
5081: <div class="sect2" lang="en">
5082: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5083: <a name="quoting-guideline"></a>11.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 5084: <p>There are many possible sources of wrongly quoted variables.
5085: This section lists some of the commonly known ones.</p>
5086: <div class="itemizedlist"><ul type="disc">
5087: <li>
5088: <p>Whenever you use the value of a list, think
5089: about what happens to leading or trailing whitespace. If the
5090: list is a well-formed shell expression, you can apply the
5091: <code class="varname">:M*</code> modifier to strip leading and trailing
5092: whitespace from each word. The <code class="varname">:M</code> operator
5093: first splits its argument according to the rules of the shell,
5094: and then creates a new list consisting of all words that match
5095: the shell glob expression <code class="varname">*</code>, that is: all.
5096: One class of situations where this is needed is when adding a
5097: variable like <code class="varname">CPPFLAGS</code> to
5098: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5099: invokes other configure scripts, it strips the leading and
5100: trailing whitespace from the variable and then passes it to the
5101: other configure scripts. But these configure scripts expect the
5102: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5103: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5104: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5105: here is how we do it:</p>
5106: <pre class="programlisting">
1.100 rillig 5107: CPPFLAGS= # empty
5108: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5109: CPPFLAGS+= ${MY_CPPFLAGS}
5110:
5111: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5112:
5113: all:
5114: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5115: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 5116: </pre>
1.75 rillig 5117: </li>
5118: <li><p>The example above contains one bug: The
5119: <code class="varname">${PREFIX}</code> is a properly quoted shell
5120: expression, but there is the C compiler after it, which also
5121: expects a properly quoted string (this time in C syntax). The
5122: version above is therefore only correct if
5123: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5124: or double quotes. If you want to allow these, you have to add
5125: another layer of quoting to each variable that is used as a C
5126: string literal. You cannot use the <code class="varname">:Q</code>
5127: operator for it, as this operator only works for the
5128: shell.</p></li>
5129: <li>
5130: <p>Whenever a variable can be empty, the
5131: <code class="varname">:Q</code> operator can have surprising results. Here
5132: are two completely different cases which can be solved with the
5133: same trick.</p>
5134: <pre class="programlisting">
1.100 rillig 5135: EMPTY= # empty
5136: empty_test:
5137: for i in a ${EMPTY:Q} c; do \
5138: echo "$$i"; \
5139: done
5140:
5141: for_test:
5142: .for i in a:\ a:\test.txt
5143: echo ${i:Q}
5144: echo "foo"
5145: .endfor
1.1 grant 5146: </pre>
1.75 rillig 5147: <p>The first example will only print two of the three lines
5148: we might have expected. This is because
5149: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5150: the shell cannot see. The workaround is to write
5151: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5152: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5153: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5154: <p>The second example will only print three lines instead of
5155: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5156: This is because the backslash of the value
5157: <code class="varname">a:\</code> is interpreted as a line-continuation by
5158: <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
5159: <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
5160: <code class="varname">${i:Q}""</code>.</p>
5161: </li>
5162: </ul></div>
5163: </div>
5164: <div class="sect2" lang="en">
5165: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 5166: <a name="bsd-make-bug-workaround"></a>11.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5167: <p>The pkgsrc bmake program does not handle the following
5168: assignment correctly. In case <code class="varname">_othervar_</code>
5169: contains a ``-'' character, one of the closing braces is included
5170: in <code class="varname">${VAR}</code> after this code executes.</p>
5171: <pre class="programlisting">
1.100 rillig 5172: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5173: </pre>
1.75 rillig 5174: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5175: 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 5176: <code class="varname">bug1</code>.</p>
5177: </div>
5178: </div>
5179: </div>
5180: <div class="chapter" lang="en">
5181: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5182: <a name="plist"></a>Chapter 12. PLIST issues</h2></div></div></div>
1.75 rillig 5183: <div class="toc">
5184: <p><b>Table of Contents</b></p>
5185: <dl>
1.90 rillig 5186: <dt><span class="sect1"><a href="#rcs-id">12.1. RCS ID</a></span></dt>
5187: <dt><span class="sect1"><a href="#automatic-plist-generation">12.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5188: <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>
5189: <dt><span class="sect1"><a href="#plist.misc">12.4. Variable substitution in PLIST</a></span></dt>
5190: <dt><span class="sect1"><a href="#manpage-compression">12.5. Man page compression</a></span></dt>
5191: <dt><span class="sect1"><a href="#using-PLIST_SRC">12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5192: <dt><span class="sect1"><a href="#platform-specific-plist">12.7. Platform-specific and differing PLISTs</a></span></dt>
5193: <dt><span class="sect1"><a href="#faq.common-dirs">12.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5194: </dl>
5195: </div>
1.87 wiz 5196: <p>The <code class="filename">PLIST</code> file contains a package's
5197: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5198: the package (relative to the <code class="filename">${PREFIX}</code>
5199: directory it's been installed in) plus some additional statements
5200: - 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.
5201: This chapter addresses some issues that need attention when
5202: dealing with the <code class="filename">PLIST</code> file (or files, see
5203: below!).</p>
1.75 rillig 5204: <div class="sect1" lang="en">
5205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5206: <a name="rcs-id"></a>12.1. RCS ID</h2></div></div></div>
1.87 wiz 5207: <p>Be sure to add a RCS ID line as the first thing in any
5208: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5209: <pre class="programlisting">
1.100 rillig 5210: @comment $NetBSD$
1.87 wiz 5211: </pre>
1.75 rillig 5212: </div>
5213: <div class="sect1" lang="en">
5214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5215: <a name="automatic-plist-generation"></a>12.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.75 rillig 5216: <p>You can use the <span><strong class="command">make print-PLIST</strong></span> command
1.87 wiz 5217: to output a PLIST that matches any new files since the package
1.90 rillig 5218: 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 5219: more information on this target.</p>
1.75 rillig 5220: </div>
5221: <div class="sect1" lang="en">
5222: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5223: <a name="print-PLIST"></a>12.3. Tweaking output of <span><strong class="command">make print-PLIST</strong></span>
5224: </h2></div></div></div>
1.87 wiz 5225: <p>If you have used any of the *-dirs packages, as explained in
1.90 rillig 5226: <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 5227: <span><strong class="command">make print-PLIST</strong></span> outputs a set of
5228: <code class="varname">@comment</code>s instead of real
5229: <code class="varname">@dirrm</code> lines. You can also do this for
5230: specific directories and files, so that the results of that
5231: command are very close to reality. This helps <span class="emphasis"><em>a
5232: lot</em></span> during the update of packages.</p>
5233: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5234: of AWK patterns and actions that are used to filter the output of
5235: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5236: scripting you like to it, but be careful with quoting.</p>
5237: <p>For example, to get all files inside the
5238: <code class="filename">libdata/foo</code> directory removed from the
5239: resulting PLIST:</p>
5240: <pre class="programlisting">
1.100 rillig 5241: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5242: </pre>
5243: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5244: to a specific (shared) directory converted to
5245: <code class="varname">@comment</code>s:</p>
1.75 rillig 5246: <pre class="programlisting">
1.100 rillig 5247: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5248: </pre>
1.75 rillig 5249: </div>
5250: <div class="sect1" lang="en">
5251: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5252: <a name="plist.misc"></a>12.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5253: <p>A number of variables are substituted automatically in
5254: PLISTs when a package is installed on a system. This includes the
5255: following variables:</p>
1.75 rillig 5256: <div class="variablelist"><dl>
5257: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5258: <dd>
5259: <p>Some packages like emacs and perl embed information
1.87 wiz 5260: about which architecture they were built on into the
5261: pathnames where they install their files. To handle this
5262: case, PLIST will be preprocessed before actually used, and
5263: the symbol
5264: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
5265: replaced by what <span><strong class="command">uname -p</strong></span> gives. The
5266: same is done if the string
5267: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5268: PLIST somewhere - use this on packages that have GNU
5269: autoconf-created configure scripts.</p>
1.75 rillig 5270: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5271: <h3 class="title">Legacy note</h3>
5272: <p>There used to be a symbol
1.87 wiz 5273: “<span class="quote"><code class="varname">$ARCH</code></span>” that
5274: was replaced by the output of <span><strong class="command">uname
5275: -m</strong></span>, but that's no longer supported and has
5276: been removed.</p>
1.75 rillig 5277: </div>
5278: </dd>
5279: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5280: <dd>
5281: <p>Some packages want to embed the OS name and version
1.87 wiz 5282: into some paths. To do this, use these variables in the
5283: <code class="filename">PLIST</code>:
5284: </p>
1.75 rillig 5285: <div class="itemizedlist"><ul type="disc">
5286: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span><strong class="command">uname -s</strong></span></span>”</p></li>
5287: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
5288: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span><strong class="command">uname -r</strong></span></span>”</p></li>
5289: </ul></div>
5290: </dd>
5291: </dl></div>
1.87 wiz 5292: <p>For a complete list of values which are replaced by
5293: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5294: search for <code class="varname">PLIST_SUBST</code>).</p>
5295: <p>If you want to change other variables not listed above, you
5296: can add variables and their expansions to this variable in the
1.90 rillig 5297: 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 5298: <pre class="programlisting">
1.100 rillig 5299: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5300: </pre>
1.75 rillig 5301: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5302: in the <code class="filename">PLIST</code> with
5303: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5304: </div>
5305: <div class="sect1" lang="en">
5306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5307: <a name="manpage-compression"></a>12.5. Man page compression</h2></div></div></div>
1.75 rillig 5308: <p>Man pages should be installed in compressed form if
1.87 wiz 5309: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5310: and uncompressed otherwise. To handle this in the
5311: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5312: appended/removed automatically for man pages according to
5313: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5314: or not, see above for details. This modification of the
5315: <code class="filename">PLIST</code> file is done on a copy of it, not
5316: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5317: </div>
5318: <div class="sect1" lang="en">
5319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 5320: <a name="using-PLIST_SRC"></a>12.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5321: </h2></div></div></div>
1.76 rillig 5322: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5323: in generating the binary package, set the variable
5324: <code class="varname">PLIST_SRC</code> to the names of that file(s).
5325: 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
5326: important. The default for <code class="varname">PLIST_SRC</code> is
5327: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5328: </div>
5329: <div class="sect1" lang="en">
5330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5331: <a name="platform-specific-plist"></a>12.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5332: <p>Some packages decide to install a different set of files based on
1.87 wiz 5333: the operating system being used. These differences can be
5334: automatically handled by using the following files:</p>
1.75 rillig 5335: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5336: <li><p><code class="filename">PLIST.common</code></p></li>
5337: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5338: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5339: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5340: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5341: </ul></div>
5342: </div>
5343: <div class="sect1" lang="en">
5344: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5345: <a name="faq.common-dirs"></a>12.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5346: <p>A “<span class="quote">shared directory</span>” is a directory where
5347: multiple (and unrelated) packages install files. These
5348: directories are problematic because you have to add special tricks
5349: in the PLIST to conditionally remove them, or have some
5350: centralized package handle them.</p>
5351: <p>Within pkgsrc, you'll find both approaches. If a directory
5352: is shared by a few unrelated packages, it's often not worth to add
5353: an extra package to remove it. Therefore, one simply does:</p>
5354: <pre class="programlisting">
1.100 rillig 5355: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
1.87 wiz 5356: </pre>
5357: <p>in the PLISTs of all affected packages, instead of the
5358: regular "@dirrm" line.</p>
5359: <p>However, if the directory is shared across many packages, two
5360: different solutions are available:</p>
1.75 rillig 5361: <div class="orderedlist"><ol type="1">
1.87 wiz 5362: <li><p>If the packages have a common dependency, the directory
5363: can be removed in that. For example, see
1.91 rillig 5364: <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 5365: removes the shared directory
5366: <code class="filename">share/omf</code>.</p></li>
5367: <li><p>If the packages using the directory are not related at
5368: all (they have no common dependencies), a *-dirs package is
5369: used.</p></li>
1.75 rillig 5370: </ol></div>
1.87 wiz 5371: <p>From now on, we'll discuss the second solution. To get an
5372: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5373: <pre class="programlisting">
1.100 rillig 5374: <code class="prompt">%</code> cd .../pkgsrc
5375: <code class="prompt">%</code> ls -d */*-dirs
1.87 wiz 5376: </pre>
5377: <p>Their use from other packages is very simple. The
5378: <code class="varname">USE_DIRS</code> variable takes a list of package names
5379: (without the “<span class="quote">-dirs</span>” part) together with the required
5380: version number (always pick the latest one when writing new
5381: packages).</p>
5382: <p>For example, if a package installs files under
5383: <code class="filename">share/applications</code>, it should have the
5384: following line in it:</p>
5385: <pre class="programlisting">
1.100 rillig 5386: USE_DIRS+= xdg-1.1
1.87 wiz 5387: </pre>
5388: <p>After regenerating the PLIST using <span><strong class="command">make
5389: print-PLIST</strong></span>, you should get the right (commented out)
5390: lines.</p>
5391: <p>Note that even if your package is using
5392: <code class="filename">$X11BASE</code>, it must not depend on the
5393: *-x11-dirs packages. Just specify the name without that part and
5394: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5395: care of it.</p>
1.75 rillig 5396: </div>
5397: </div>
5398: <div class="chapter" lang="en">
5399: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5400: <a name="buildlink"></a>Chapter 13. Buildlink methodology</h2></div></div></div>
1.75 rillig 5401: <div class="toc">
5402: <p><b>Table of Contents</b></p>
5403: <dl>
1.90 rillig 5404: <dt><span class="sect1"><a href="#converting-to-buildlink3">13.1. Converting packages to use buildlink3</a></span></dt>
5405: <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 5406: <dd><dl>
1.90 rillig 5407: <dt><span class="sect2"><a href="#anatomy-of-bl3">13.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5408: <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 5409: </dl></dd>
1.90 rillig 5410: <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 5411: <dd><dl>
1.90 rillig 5412: <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>
5413: <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 5414: </dl></dd>
5415: </dl>
5416: </div>
5417: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5418: are seen by a package's configure and build processes. This is implemented
5419: in a two step process:</p>
1.75 rillig 5420: <div class="orderedlist"><ol type="1">
5421: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5422: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5423: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5424: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5425: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5426: <code class="option">-L${LOCALBASE}/lib</code> into references to
5427: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5428: native compiler on some operating systems look like GCC, so that
5429: packages that expect GCC won't require modifications to build with
5430: those native compilers.</p></li>
1.75 rillig 5431: </ol></div>
5432: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5433: package may be built consistently despite what other software may be
5434: installed. Please note that the normal system header and library paths,
5435: e.g. <code class="filename">/usr/include</code>,
5436: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5437: designed to insulate the package build from non-system-supplied
5438: software.</p>
1.75 rillig 5439: <div class="sect1" lang="en">
5440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5441: <a name="converting-to-buildlink3"></a>13.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5442: <p>The process of converting packages to use the buildlink3
1.87 wiz 5443: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5444: The things to keep in mind are:</p>
1.75 rillig 5445: <div class="orderedlist"><ol type="1">
1.87 wiz 5446: <li><p>Ensure that the build always calls the wrapper scripts
5447: instead of the actual toolchain. Some packages are tricky,
5448: and the only way to know for sure is the check
5449: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5450: wrappers are being invoked.</p></li>
5451: <li><p>Don't override <code class="varname">PREFIX</code> from within
5452: the package Makefile, e.g. Java VMs, standalone shells,
5453: etc., because the code to symlink files into
5454: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5455: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5456: </p></li>
5457: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5458: <code class="filename">buildlink3.mk</code> files that you list in a
5459: package's Makefile are added as dependencies for that package.
5460: </p></li>
1.75 rillig 5461: </ol></div>
1.87 wiz 5462: <p>If a dependency on a particular package is required for its libraries and
5463: headers, then we replace:</p>
1.75 rillig 5464: <pre class="programlisting">
1.100 rillig 5465: DEPENDS+= foo>=1.1.0:../../category/foo
5466: </pre>
1.75 rillig 5467: <p>with</p>
5468: <pre class="programlisting">
1.100 rillig 5469: .include "../../category/foo/buildlink3.mk"
5470: </pre>
1.75 rillig 5471: <p>The buildlink3.mk files usually define the required dependencies.
5472: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5473: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5474: <pre class="programlisting">
1.100 rillig 5475: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5476: .include "../../category/foo/buildlink3.mk"
5477: </pre>
1.76 rillig 5478: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5479: files in <code class="filename">pkgsrc/mk</code>
5480: that handle special package issues:</p>
1.75 rillig 5481: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5482: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5483: the native or a pkgsrc Berkeley DB implementation based on
5484: the values of <code class="varname">BDB_ACCEPTED</code> and
5485: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5486: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5487: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5488: 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 5489: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5490: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5491: adding a dependency on Heimdal or MIT-krb5 for packages that
5492: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5493: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5494: system-provided Motif installation or adds a dependency on
1.91 rillig 5495: <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 5496: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5497: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5498: which Motif version will be used.</p></li>
1.76 rillig 5499: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5500: variables that may be used by packages that use the
5501: Open Sound System (OSS) API.</p></li>
1.76 rillig 5502: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5503: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5504: the file for more information.</p></li>
1.76 rillig 5505: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5506: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5507: 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 5508: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5509: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5510: library.</p></li>
1.75 rillig 5511: </ul></div>
1.76 rillig 5512: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5513: files provide a more complete
5514: description of how to use them properly.</p>
1.75 rillig 5515: </div>
5516: <div class="sect1" lang="en">
5517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5518: <a name="creating-buildlink3.mk"></a>13.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.87 wiz 5519: <p>A package's <code class="filename">buildlink3.mk</code> file is
5520: included by Makefiles to indicate the need to compile and link
5521: against header files and libraries provided by the package. A
5522: <code class="filename">buildlink3.mk</code> file should always provide
5523: enough information to add the correct type of dependency
5524: relationship and include any other
5525: <code class="filename">buildlink3.mk</code> files that it needs to find
5526: headers and libraries that it needs in turn.</p>
5527: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5528: 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 5529: package is highly recommended. For most packages, the following
5530: command will generate a good starting point for
5531: <code class="filename">buildlink3.mk</code> files:</p>
5532: <pre class="screen">
5533: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5534: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5535: </pre>
1.75 rillig 5536: <div class="sect2" lang="en">
5537: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5538: <a name="anatomy-of-bl3"></a>13.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5539: <p>The following real-life example
1.87 wiz 5540: <code class="filename">buildlink3.mk</code> is taken
5541: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5542: <pre class="programlisting">
1.100 rillig 5543: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5544:
1.100 rillig 5545: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5546: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5547:
1.100 rillig 5548: .if ${BUILDLINK_DEPTH} == "+"
5549: BUILDLINK_DEPENDS+= tiff
5550: .endif
1.87 wiz 5551:
1.100 rillig 5552: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5553: BUILDLINK_PACKAGES+= tiff
1.87 wiz 5554:
1.100 rillig 5555: .if ${TIFF_BUILDLINK3_MK} == "+"
5556: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5557: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5558: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5559:
1.100 rillig 5560: .include "../../devel/zlib/buildlink3.mk"
5561: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 5562:
1.100 rillig 5563: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5564: </pre>
1.87 wiz 5565: <p>The header and footer manipulate
5566: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5567: <code class="filename">buildlink3.mk</code> files and is used to track
5568: at what depth we are including
5569: <code class="filename">buildlink3.mk</code> files.</p>
5570: <p>The first section controls if the dependency on
5571: <em class="replaceable"><code>pkg</code></em> is added.
5572: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5573: packages for which dependencies are added by
5574: buildlink3.</p>
5575: <p>The second section advises pkgsrc that the
5576: <code class="filename">buildlink3.mk</code> file for
5577: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5578: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5579: packages for which <code class="filename">buildlink3.mk</code> files
5580: have been included. It must <span class="emphasis"><em>always</em></span> be
5581: appended to within a <code class="filename">buildlink3.mk</code>
5582: file.</p>
5583: <p>The third section is protected from multiple inclusion
5584: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5585: added. Several important variables are set in the section:</p>
5586: <div class="itemizedlist"><ul type="disc">
5587: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5588: is the actual dependency recorded in the installed
5589: package; this should always be set using
5590: <span><strong class="command">+=</strong></span> to ensure that
5591: we're appending to any pre-existing list of values. This
5592: variable should be set to the first version of the
5593: package that had an API change.
5594: </p></li>
5595: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5596: is the location of the <em class="replaceable"><code>pkg</code></em>
5597: pkgsrc directory.</p></li>
5598: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5599: (not shown above) controls whether we use
5600: <code class="varname">BUILD_DEPENDS</code> or
5601: <code class="varname">DEPENDS</code> to add the dependency on
5602: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5603: selected by setting
5604: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5605: to “<span class="quote">build</span>”. By default, the full dependency is
5606: used.</p></li>
5607: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5608: and
5609: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5610: (not shown above) are lists of subdirectories of
1.76 rillig 5611: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5612: to add to the header and library search paths. These
5613: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5614: respectively.</p></li>
5615: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5616: (not shown above) is the list of preprocessor flags to add
5617: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5618: configure and build phases. The “<span class="quote">-I</span>” option
5619: should be avoided and instead be handled using
5620: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5621: above.</p></li>
1.75 rillig 5622: </ul></div>
1.87 wiz 5623: <p>The following variables are all optionally defined within
5624: this second section (protected against multiple inclusion) and
5625: control which package files are symlinked into
5626: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5627: transformed during the symlinking:</p>
1.75 rillig 5628: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5629: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5630: (not shown above) is a shell glob pattern relative to
1.76 rillig 5631: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5632: to be symlinked into
1.76 rillig 5633: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5634: e.g. <code class="filename">include/*.h</code>.</p></li>
5635: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5636: (not shown above) is a shell pipeline that
5637: outputs to stdout a list of files relative to
5638: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5639: The resulting files are to be symlinked
5640: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5641: this takes the <code class="filename">+CONTENTS</code> of a
5642: <em class="replaceable"><code>pkg</code></em> and filters it through
5643: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5644: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5645: (not shown above) is a filter command that filters
1.76 rillig 5646: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5647: relative to
1.76 rillig 5648: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5649: on stdout. By default for overwrite packages,
5650: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5651: outputs the contents of the <code class="filename">include</code>
5652: and <code class="filename">lib</code> directories in the package
5653: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5654: it outputs any libtool archives in
1.87 wiz 5655: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5656: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5657: (not shown above) is a list of sed arguments used to
5658: transform the name of the source filename into a
5659: destination filename, e.g. <span><strong class="command">-e
1.87 wiz 5660: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5661: </ul></div>
1.87 wiz 5662: <p>The last section includes any
5663: <code class="filename">buildlink3.mk</code> needed for
5664: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5665: Including these <code class="filename">buildlink3.mk</code> files
5666: means that the headers and libraries for these
5667: dependencies are also symlinked into
5668: <code class="filename">${BUILDLINK_DIR}</code>
5669: whenever the <em class="replaceable"><code>pkg</code></em>
5670: <code class="filename">buildlink3.mk</code>
5671: file is included.</p>
1.75 rillig 5672: </div>
5673: <div class="sect2" lang="en">
5674: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5675: <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 5676: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5677: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5678: after a package update is when the API or interface to the
1.87 wiz 5679: header files change.</p>
5680: <p>In this case,
5681: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5682: should be adjusted to require at least the new package
5683: version. In some cases, the packages that depend on this new
5684: version may need their <code class="varname">PKGREVISION</code>s
5685: increased and, if they have <code class="filename">buildlink3.mk</code>
5686: files, their
5687: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5688: adjusted, too. This is needed so pkgsrc will require the
5689: correct package dependency and not settle for an older one
5690: when building the source.</p>
5691: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5692: should be increased when the binary interface or sonames
5693: (major number of the library version) of any installed
5694: shared libraries change. This is needed so that binary
5695: packages made using it will require the correct package
5696: dependency and not settle for an older one which will not
1.87 wiz 5697: contain the necessary shared libraries.</p>
1.90 rillig 5698: <p>See <a href="#dependencies" title="18.1.6. Handling dependencies">Section 18.1.6, “Handling dependencies”</a> for
1.75 rillig 5699: more information about dependencies on other packages,
5700: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5701: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5702: <p>Please take careful consideration before adjusting
5703: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5704: or
5705: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5706: as we don't want to cause unneeded package deletions and
5707: rebuilds. In many cases, new versions of packages work just
5708: fine with older dependencies.</p>
5709: <p>Also it is not needed to set
1.75 rillig 5710: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5711: when it is identical to
1.87 wiz 5712: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5713: </div>
5714: </div>
5715: <div class="sect1" lang="en">
5716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5717: <a name="writing-builtin.mk"></a>13.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5718: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5719: coincide with headers and libraries present in the base system.
1.76 rillig 5720: Aside from a <code class="filename">buildlink3.mk</code> file, these
5721: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5722: file that includes the necessary checks to decide whether using
5723: the built-in software or the pkgsrc software is
1.87 wiz 5724: appropriate.</p>
5725: <p>The only requirements of a builtin.mk file for
5726: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5727: <div class="orderedlist"><ol type="1">
1.87 wiz 5728: <li><p>It should set
5729: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5730: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5731: after it is included.</p></li>
5732: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5733: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5734: which is already set before the
5735: <code class="filename">builtin.mk</code> file is included.</p></li>
5736: <li><p>It should be written to allow multiple inclusion. This
5737: is <span class="emphasis"><em>very</em></span> important and takes careful
5738: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5739: </ol></div>
5740: <div class="sect2" lang="en">
5741: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5742: <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 5743: <p>The following is the recommended template for builtin.mk
1.87 wiz 5744: files:</p>
1.75 rillig 5745: <pre class="programlisting">
1.100 rillig 5746: .if !defined(IS_BUILTIN.foo)
5747: #
5748: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5749: # genuinely exists in the system or not.
5750: #
5751: IS_BUILTIN.foo?= no
5752:
5753: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5754: # version can be determined.
5755: #
5756: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5757: BUILTIN_PKG.foo?= foo-1.0
5758: . endif
5759: .endif # IS_BUILTIN.foo
5760:
5761: .if !defined(USE_BUILTIN.foo)
5762: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5763: . if defined(BUILTIN_PKG.foo)
5764: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5765: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5766: USE_BUILTIN.foo!= \
5767: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5768: && ${ECHO} "yes" || ${ECHO} "no"
5769: . endif
5770: . endfor
5771: . endif
5772: .endif # USE_BUILTIN.foo
5773:
5774: CHECK_BUILTIN.foo?= no
5775: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5776: #
5777: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5778: # "yes" or "no".
5779: #
5780: .endif # CHECK_BUILTIN.foo
5781: </pre>
1.87 wiz 5782: <p>The first section sets
5783: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5784: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5785: in the base system. This should not be a base system software
5786: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5787: it should only be “<span class="quote">yes</span>” if the actual package is
5788: included as part of the base system. This variable is only
5789: used internally within the <code class="filename">builtin.mk</code>
5790: file.</p>
5791: <p>The second section sets
5792: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5793: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5794: system if it exists (if
5795: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5796: is “<span class="quote">yes</span>”). This variable is only used internally
5797: within the <code class="filename">builtin.mk</code> file.</p>
5798: <p>The third section sets
5799: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5800: and is <span class="emphasis"><em>required</em></span> in all
5801: <code class="filename">builtin.mk</code> files. The code in this
5802: section must make the determination whether the built-in
5803: software is adequate to satisfy the dependencies listed in
5804: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5805: This is typically done by comparing
5806: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5807: against each of the dependencies in
5808: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5809: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5810: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5811: end of the <code class="filename">builtin.mk</code> file. Note that
5812: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5813: may be “<span class="quote">yes</span>” even if
5814: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5815: is “<span class="quote">no</span>” because we may make the determination
5816: that the built-in version of the software is similar enough to
5817: be used as a replacement.</p>
5818: <p>The last section is guarded by
5819: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5820: and includes code that uses the value of
5821: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5822: set in the previous section. This typically includes, e.g.,
5823: adding additional dependency restrictions and listing additional
5824: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5825: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5826: </div>
5827: <div class="sect2" lang="en">
5828: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5829: <a name="native-or-pkgsrc-preference"></a>13.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5830: <p>When building packages, it's possible to choose whether to set
5831: a global preference for using either the built-in (native)
5832: version or the pkgsrc version of software to satisfy a
5833: dependency. This is controlled by setting
5834: <code class="varname">PREFER_PKGSRC</code> and
5835: <code class="varname">PREFER_NATIVE</code>. These variables take values
5836: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5837: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5838: use the pkgsrc versions of software, while
5839: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5840: built-in versions. Preferences are determined by the most
5841: specific instance of the package in either
5842: <code class="varname">PREFER_PKGSRC</code> or
5843: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5844: in neither or in both variables, then
5845: <code class="varname">PREFER_PKGSRC</code> has precedence over
5846: <code class="varname">PREFER_NATIVE</code>. For example, to require
5847: using pkgsrc versions of software for all but the most basic
5848: bits on a NetBSD system, you can set:</p>
5849: <pre class="programlisting">
1.100 rillig 5850: PREFER_PKGSRC= yes
5851: PREFER_NATIVE= getopt skey tcp_wrappers
5852: </pre>
1.87 wiz 5853: <p>A package <span class="emphasis"><em>must</em></span> have a
5854: <code class="filename">builtin.mk</code>
5855: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5856: otherwise it is simply ignored in that list.</p>
1.75 rillig 5857: </div>
5858: </div>
5859: </div>
5860: <div class="chapter" lang="en">
5861: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 5862: <a name="pkginstall"></a>Chapter 14. The pkginstall framework</h2></div></div></div>
1.75 rillig 5863: <div class="toc">
5864: <p><b>Table of Contents</b></p>
5865: <dl>
1.90 rillig 5866: <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 5867: <dd><dl>
1.90 rillig 5868: <dt><span class="sect2"><a href="#dirs-outside-prefix">14.1.1. Directory manipulation</a></span></dt>
5869: <dt><span class="sect2"><a href="#files-outside-prefix">14.1.2. File manipulation</a></span></dt>
1.75 rillig 5870: </dl></dd>
1.90 rillig 5871: <dt><span class="sect1"><a href="#conf-files">14.2. Configuration files</a></span></dt>
1.75 rillig 5872: <dd><dl>
1.90 rillig 5873: <dt><span class="sect2"><a href="#conf-files-sysconfdir">14.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5874: <dt><span class="sect2"><a href="#conf-files-configure">14.2.2. Telling the software where configuration files are</a></span></dt>
5875: <dt><span class="sect2"><a href="#conf-files-patching">14.2.3. Patching installations</a></span></dt>
5876: <dt><span class="sect2"><a href="#conf-files-disable">14.2.4. Disabling handling of configuration files</a></span></dt>
5877: </dl></dd>
5878: <dt><span class="sect1"><a href="#rcd-scripts">14.3. System startup scripts</a></span></dt>
5879: <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>
5880: <dt><span class="sect1"><a href="#users-and-groups">14.4. System users and groups</a></span></dt>
5881: <dt><span class="sect1"><a href="#shells">14.5. System shells</a></span></dt>
5882: <dd><dl><dt><span class="sect2"><a href="#shells-disable">14.5.1. Disabling shell registration</a></span></dt></dl></dd>
5883: <dt><span class="sect1"><a href="#fonts">14.6. Fonts</a></span></dt>
5884: <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 5885: </dl>
5886: </div>
5887: <p>This chapter describes the framework known as
5888: <code class="literal">pkginstall</code>, whose key features are:</p>
5889: <div class="itemizedlist"><ul type="disc">
5890: <li><p>Generic installation and manipulation of directories and files
5891: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5892: <li><p>Automatic handling of configuration files during installation,
5893: provided that packages are correctly designed.</p></li>
5894: <li><p>Generation and installation of system startup scripts.</p></li>
5895: <li><p>Registration of system users and groups.</p></li>
5896: <li><p>Registration of system shells.</p></li>
5897: <li><p>Automatic updating of fonts databases.</p></li>
5898: </ul></div>
5899: <p>The following sections inspect each of the above points in detail.</p>
5900: <p>You may be thinking that many of the things described here could be
5901: easily done with simple code in the package's post-installation target
5902: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5903: as the code in them is only executed when building from source. Machines
5904: using binary packages could not benefit from it at all (as the code itself
5905: could be unavailable). Therefore, the only way to achieve any of the items
5906: described above is by means of the installation scripts, which are
5907: automatically generated by pkginstall.</p>
5908: <div class="sect1" lang="en">
5909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 5910: <a name="files-and-dirs-outside-prefix"></a>14.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5911: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5912: of files and directories that belong to a package. The names used in it
1.76 rillig 5913: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5914: which means that it cannot register files outside this directory (absolute
5915: path names are not allowed). Despite this restriction, some packages need
5916: to install files outside this location; e.g., under
1.76 rillig 5917: <code class="filename">${VARBASE}</code> or
1.87 wiz 5918: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5919: is to create such files during installation time by using
5920: installation scripts.</p>
5921: <p>The generic installation scripts are shell scripts that can
5922: contain arbitrary code. The list of scripts to execute is taken from
5923: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5924: <code class="filename">INSTALL</code>. A similar variable exists for package
5925: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5926: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5927: commands, so they have the potential to create and manage files
5928: anywhere in the file system.</p>
5929: <p>Using these general installation files is not recommended, but
5930: may be needed in some special cases. One reason for avoiding them is
5931: that the user has to trust the packager that there is no unwanted or
5932: simply erroneous code included in the installation script. Also,
5933: previously there were many similar scripts for the same functionality,
5934: and fixing a common error involved finding and changing all of
5935: them.</p>
5936: <p>The pkginstall framework offers another, standardized way. It
5937: provides generic scripts to abstract the manipulation of such files
5938: and directories based on variables set in the package's
5939: <code class="filename">Makefile</code>. The rest of this section describes
5940: these variables.</p>
1.75 rillig 5941: <div class="sect2" lang="en">
5942: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5943: <a name="dirs-outside-prefix"></a>14.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5944: <p>The following variables can be set to request the creation of
5945: directories anywhere in the file system:</p>
5946: <div class="itemizedlist"><ul type="disc">
5947: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5948: contain a list of directories that should be created and should attempt
5949: to be destroyed by the installation scripts. The difference between
5950: the two is that the latter prompts the administrator to remove any
5951: directories that may be left after deinstallation (because they were
5952: not empty), while the former does not.</p></li>
5953: <li>
5954: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5955: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5956: which directories should be created and should attempt to be destroyed
5957: by the installation scripts. Each tuple holds the following values,
5958: separated by spaces: the directory name, its owner, its group and its
5959: numerical mode. For example:</p>
5960: <pre class="programlisting">
1.100 rillig 5961: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5962: </pre>
1.75 rillig 5963: <p>The difference between the two is exactly the same as their
5964: non-<code class="varname">PERMS</code> counterparts.</p>
5965: </li>
5966: </ul></div>
5967: </div>
5968: <div class="sect2" lang="en">
5969: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 5970: <a name="files-outside-prefix"></a>14.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5971: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5972: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5973: To overcome this problem, the only solution is to extract the file in the
5974: known place (i.e., inside the installation prefix) and copy it to the
5975: appropriate location during installation (done by the installation scripts
5976: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5977: file</em></span> in the following paragraphs, which describe the variables
5978: that can be used to automatically and consistently handle files outside the
5979: installation prefix:</p>
5980: <div class="itemizedlist"><ul type="disc">
5981: <li>
5982: <p><code class="varname">CONF_FILES</code> and
5983: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5984: During installation time, the master file is copied to the target one
5985: if and only if the latter does not exist. Upon deinstallation, the
5986: target file is removed provided that it was not modified by the
5987: installation.</p>
5988: <p>The difference between the two is that the latter prompts the
5989: administrator to remove any files that may be left after
5990: deinstallation (because they were not empty), while the former does
5991: not.</p>
5992: </li>
5993: <li>
5994: <p><code class="varname">CONF_FILES_PERMS</code> and
5995: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5996: files as well as their target locations. For each of them, it also
5997: specifies their owner, their group and their numeric permissions, in
5998: this order. For example:</p>
5999: <pre class="programlisting">
1.100 rillig 6000: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 6001: </pre>
1.75 rillig 6002: <p>The difference between the two is exactly the same as their
6003: non-<code class="varname">PERMS</code> counterparts.</p>
6004: </li>
6005: </ul></div>
6006: </div>
6007: </div>
6008: <div class="sect1" lang="en">
6009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6010: <a name="conf-files"></a>14.2. Configuration files</h2></div></div></div>
1.75 rillig 6011: <p>Configuration files are special in the sense that they are installed
6012: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6013: need special treatment during installation (most of which is automated by
6014: pkginstall). The main concept you must bear in mind is that files marked
6015: as configuration files are automatically copied to the right place (somewhere
6016: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6017: and only if</em></span> they didn't exist before. Similarly, they will not
6018: be removed if they have local modifications. This ensures that
6019: administrators never lose any custom changes they may have made.</p>
6020: <div class="sect2" lang="en">
6021: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6022: <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 6023: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6024: specifies where configuration files shall be installed. Its contents are
6025: set based upon the following variables:</p>
6026: <div class="itemizedlist"><ul type="disc">
6027: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 6028: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 6029: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 6030: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 6031: Packages must not use it directly.</p></li>
6032: <li>
6033: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6034: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6035: for the package being built shall be installed. The definition of this
6036: variable only makes sense in the package's
1.76 rillig 6037: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 6038: <p>As an example, consider the Apache package,
1.91 rillig 6039: <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 6040: configuration files under the
1.76 rillig 6041: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 6042: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6043: Makefile.</p>
6044: </li>
6045: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
6046: variable that holds this package's configuration directory (if
6047: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6048: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6049: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
6050: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
6051: directory where the configuration files for the package identified by
6052: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6053: </ul></div>
6054: <p>Based on the above variables, pkginstall determines the value of
6055: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6056: variable that can be used within a package to refer to its configuration
6057: directory. The algorithm used to set its value is basically the
6058: following:</p>
6059: <div class="orderedlist"><ol type="1">
6060: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
6061: its value is used.</p></li>
6062: <li><p>If the previous variable is not defined but
6063: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 6064: <code class="filename">Makefile</code>, the resulting value is
6065: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 6066: <li><p>Otherwise, it is set to
1.76 rillig 6067: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 6068: </ol></div>
1.76 rillig 6069: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.90 rillig 6070: 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 6071: </div>
6072: <div class="sect2" lang="en">
6073: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6074: <a name="conf-files-configure"></a>14.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 6075: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6076: known place, you need to teach each package where it shall install its
6077: files. In some cases you will have to patch the package Makefiles to
6078: achieve it. If you are lucky, though, it may be as easy as passing an
6079: extra flag to the configuration script; this is the case of GNU Autoconf-
6080: generated files:</p>
6081: <pre class="programlisting">
1.100 rillig 6082: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 6083: </pre>
1.75 rillig 6084: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6085: for</em></span> its configuration files, not where they will be originally
6086: installed (although the difference is never explicit,
6087: unfortunately).</p>
6088: </div>
6089: <div class="sect2" lang="en">
6090: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6091: <a name="conf-files-patching"></a>14.2.3. Patching installations</h3></div></div></div>
1.75 rillig 6092: <p>As said before, pkginstall automatically handles configuration files.
6093: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 6094: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 6095: directly</strong></span>. Bad news is that many software installation scripts
6096: will, out of the box, mess with the contents of that directory. So what is
6097: the correct procedure to fix this issue?</p>
6098: <p>You must teach the package (usually by manually patching it) to
6099: install any configuration files under the examples hierarchy,
1.76 rillig 6100: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6101: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 6102: has the original copies available.</p>
6103: <p>Once the required configuration files are in place (i.e., under the
6104: examples hierarchy), the pkginstall framework can use them as master copies
6105: during the package installation to update what is in
1.76 rillig 6106: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 6107: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.90 rillig 6108: 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 6109: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 6110: <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 6111: <pre class="programlisting">
1.100 rillig 6112: EGDIR= ${PREFIX}/share/doc/mutt/samples
6113: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 6114: </pre>
1.75 rillig 6115: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6116: package and has no meaning outside it.</p>
6117: </div>
6118: <div class="sect2" lang="en">
6119: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6120: <a name="conf-files-disable"></a>14.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 6121: <p>The automatic copying of config files can be toggled by setting the
6122: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6123: installation.</p>
6124: </div>
6125: </div>
6126: <div class="sect1" lang="en">
6127: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6128: <a name="rcd-scripts"></a>14.3. System startup scripts</h2></div></div></div>
1.75 rillig 6129: <p>System startup scripts are special files because they must be
6130: installed in a place known by the underlying OS, usually outside the
1.90 rillig 6131: 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 6132: can be used. However, pkginstall provides a special mechanism to handle
6133: these files.</p>
6134: <p>In order to provide system startup scripts, the package has
6135: to:</p>
6136: <div class="orderedlist"><ol type="1">
1.76 rillig 6137: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 6138: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 6139: <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 6140: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6141: <li>
6142: <p>Tell pkginstall to handle it, appending the name of the script,
6143: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6144: Continuing the previous example:</p>
6145: <pre class="programlisting">
1.100 rillig 6146: RCD_SCRIPTS+= cupsd
1.1 grant 6147: </pre>
1.75 rillig 6148: </li>
6149: </ol></div>
6150: <p>Once this is done, pkginstall will do the following steps for each
6151: script in an automated fashion:</p>
6152: <div class="orderedlist"><ol type="1">
6153: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6154: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6155: variable.</p></li>
6156: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6157: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6158: that this master file must be explicitly registered in the
1.76 rillig 6159: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6160: <li><p>Add code to the installation scripts to copy the startup script
6161: from the examples hierarchy into the system-wide startup scripts
6162: directory.</p></li>
6163: </ol></div>
6164: <div class="sect2" lang="en">
6165: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6166: <a name="rcd-scripts-disable"></a>14.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6167: <p>The automatic copying of config files can be toggled by setting the
6168: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6169: installation. Note that the scripts will be always copied inside the
1.76 rillig 6170: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6171: matter what the value of this variable is.</p>
6172: </div>
6173: </div>
6174: <div class="sect1" lang="en">
6175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6176: <a name="users-and-groups"></a>14.4. System users and groups</h2></div></div></div>
1.75 rillig 6177: <p>If a package needs to create special users and/or groups during
6178: installation, it can do so by using the pkginstall framework.</p>
6179: <p>Users can be created by adding entries to the
6180: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6181: syntax:</p>
6182: <pre class="programlisting">
1.100 rillig 6183: user:group
1.1 grant 6184: </pre>
1.87 wiz 6185: <p>Further specification of user details may be done by setting
6186: per-user variables.
6187: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6188: numeric UID for the user.
6189: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6190: user's description or comment.
6191: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6192: user's home directory, and defaults to
6193: <code class="filename">/nonexistent</code> if not specified.
6194: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6195: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6196: not specified.</p>
1.75 rillig 6197: <p>Similarly, groups can be created by adding entries to the
6198: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6199: <pre class="programlisting">
1.100 rillig 6200: group
1.1 grant 6201: </pre>
1.93 rillig 6202: <p>The numeric GID of the group may be set by defining
1.75 rillig 6203: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6204: <p>If a package needs to create the users and groups at an earlier
6205: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6206: either <code class="literal">configure</code> or <code class="literal">build</code> to
6207: indicate the phase before which the users and groups are created. In
6208: this case, the numeric UIDs and GIDs of the created users and groups
6209: are automatically hardcoded into the final installation scripts.</p>
6210: </div>
6211: <div class="sect1" lang="en">
6212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6213: <a name="shells"></a>14.5. System shells</h2></div></div></div>
1.75 rillig 6214: <p>Packages that install system shells should register them in the shell
1.76 rillig 6215: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6216: administrator. This must be done from the installation scripts to keep
6217: binary packages working on any system. pkginstall provides an easy way to
6218: accomplish this task.</p>
6219: <p>When a package provides a shell interpreter, it has to set the
6220: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6221: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6222: 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 6223: <pre class="programlisting">
1.100 rillig 6224: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6225: </pre>
1.75 rillig 6226: <div class="sect2" lang="en">
6227: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6228: <a name="shells-disable"></a>14.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6229: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6230: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6231: environment variable to <code class="literal">NO</code>.</p>
6232: </div>
6233: </div>
6234: <div class="sect1" lang="en">
6235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6236: <a name="fonts"></a>14.6. Fonts</h2></div></div></div>
1.75 rillig 6237: <p>Packages that install X11 fonts should update the database files
6238: that index the fonts within each fonts directory. This can easily be
6239: accomplished within the pkginstall framework.</p>
6240: <p>When a package installs X11 fonts, it must list the directories in
6241: which fonts are installed in the
6242: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6243: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6244: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6245: installation scripts to run the appropriate commands to update the fonts
6246: database files within each of those directories. For convenience, if the
6247: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6248: 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 6249: <pre class="programlisting">
1.100 rillig 6250: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6251: </pre>
1.75 rillig 6252: <div class="sect2" lang="en">
6253: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6254: <a name="fonts-disable"></a>14.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6255: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6256: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6257: environment variable to <code class="literal">NO</code>.</p>
6258: </div>
6259: </div>
6260: </div>
6261: <div class="chapter" lang="en">
6262: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6263: <a name="options"></a>Chapter 15. Options handling</h2></div></div></div>
1.75 rillig 6264: <div class="toc">
6265: <p><b>Table of Contents</b></p>
6266: <dl>
1.90 rillig 6267: <dt><span class="sect1"><a href="#global-default-options">15.1. Global default options</a></span></dt>
6268: <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>
6269: <dt><span class="sect1"><a href="#option-names">15.3. Option Names</a></span></dt>
1.75 rillig 6270: </dl>
6271: </div>
6272: <p>Many packages have the ability to be built to support different
1.76 rillig 6273: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6274: in pkgsrc that provides generic handling of those options that
6275: determine different ways in which the packages can be built. It's
6276: possible for the user to specify exactly which sets of options will be
6277: built into a package or to allow a set of global default options
6278: apply.</p>
6279: <div class="sect1" lang="en">
6280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6281: <a name="global-default-options"></a>15.1. Global default options</h2></div></div></div>
1.75 rillig 6282: <p>Global default options are listed in
6283: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6284: that should be built into every package if that option is supported.
1.104 ! rillig 6285: This variable should be set in <a href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6286: </div>
6287: <div class="sect1" lang="en">
6288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.93 rillig 6289: <a name="converting-to-options"></a>15.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6290: </h2></div></div></div>
1.75 rillig 6291: <p>The following example shows how
1.76 rillig 6292: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6293: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6294: <code class="filename">Makefile</code>, or in a file,
6295: e.g. <code class="filename">options.mk</code>, that is included by the
6296: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6297: <pre class="programlisting">
1.100 rillig 6298: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6299: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6300: PKG_OPTIONS_OPTIONAL_GROUPS= database
6301: PKG_OPTIONS_GROUP.database= mysql pgsql
6302: PKG_SUGGESTED_OPTIONS= wibble-foo
6303: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6304: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6305:
6306: .include "../../mk/bsd.prefs.mk"
6307:
6308: # this package was previously named wibble2
6309: .if defined(PKG_OPTIONS.wibble2)
6310: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6311: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6312: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6313: .endif
6314:
6315: .include "../../mk/bsd.options.mk"
6316:
6317: # Package-specific option-handling
6318:
6319: ###
6320: ### FOO support
6321: ###
6322: .if !empty(PKG_OPTIONS:Mwibble-foo)
6323: CONFIGURE_ARGS+= --enable-foo
6324: .endif
6325:
6326: ###
6327: ### LDAP support
6328: ###
6329: .if !empty(PKG_OPTIONS:Mldap)
6330: . include "../../databases/openldap-client/buildlink3.mk"
6331: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6332: .endif
6333:
6334: ###
6335: ### database support
6336: ###
6337: .if !empty(PKG_OPTIONS:Mmysql)
6338: . include "../../mk/mysql.buildlink3.mk"
6339: .endif
6340: .if !empty(PKG_OPTIONS:Mpgsql)
6341: . include "../../mk/pgsql.buildlink3.mk"
6342: .endif
1.75 rillig 6343: </pre>
6344: <p>The first section contains the information about which build
6345: options are supported by the package, and any default options settings
6346: if needed.</p>
6347: <div class="orderedlist"><ol type="1">
6348: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6349: <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
6350: options. It should be set to
1.78 rillig 6351: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6352: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6353: at the point where the options are processed.</p></li>
1.75 rillig 6354: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6355: build options supported by the package.</p></li>
6356: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6357: list of names of groups of mutually exclusive options. The options in
6358: each group are listed in
6359: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6360: The most specific setting of any option from the group takes
6361: precedence over all other options in the group. Options from the
6362: groups will be automatically added to
6363: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6364: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6365: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6366: packages will fail if no option from the group is
6367: selected.</p></li>
6368: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6369: of names of sets of options. At least one option from each set must
6370: be selected. The options in each set are listed in
6371: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6372: Options from the sets will be automatically added to
6373: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6374: fail if no option from the set is selected.</p></li>
6375: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6376: build options which are enabled by default.</p></li>
6377: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6378: of
6379: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.104 ! rillig 6380: pairs that map legacy <a href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6381: their option counterparts. Pairs should be added with
6382: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6383: warning will be issued if the user uses a legacy
6384: variable.</p></li>
6385: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6386: of
6387: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6388: pairs that map options that have been renamed to their new
6389: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6390: the listing of global legacy options. A warning will be issued if
6391: the user uses a legacy option.</p></li>
6392: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6393: options implied by deprecated variables used. This can be used for
6394: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6395: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6396: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6397: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6398: a list of warnings about deprecated variables or options used, and
6399: what to use instead.</p></li>
6400: </ol></div>
6401: <p>A package should never modify
6402: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6403: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6404: To suggest a default set of options, use
6405: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6406: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6407: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6408: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6409: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6410: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6411: happen with platform-specific options if none of them is supported on
6412: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6413: empty list and the package is otherwise treated as not using the
6414: options framework.</p>
1.76 rillig 6415: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6416: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6417: build options, properly filtered to remove unsupported and duplicate
6418: options.</p>
6419: <p>The remaining sections contain the logic that is specific to
6420: each option. The correct way to check for an option is to check
6421: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6422: <pre class="programlisting">
1.100 rillig 6423: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6424: </pre>
6425: </div>
6426: <div class="sect1" lang="en">
6427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6428: <a name="option-names"></a>15.3. Option Names</h2></div></div></div>
1.75 rillig 6429: <p>Options that enable similar features in different packages (like
6430: optional support for a library) should use a common name in all
6431: packages that support it (like the name of the library). If another
6432: package already has an option with the same meaning, use the same
6433: name.</p>
6434: <p>Options that enable features specific to one package, where it's
6435: unlikely that another (unrelated) package has the same (or a similar)
6436: optional feature, should use a name prefixed with
6437: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6438: <p>If a group of related packages share an optional feature
6439: specific to that group, prefix it with the name of the
6440: “<span class="quote">main</span>” package
6441: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6442: <p>For new options, add a line to
1.76 rillig 6443: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6444: fields, separated by tab. The first field is the option name, the
6445: second its description. The description should be a whole sentence
6446: (starting with an uppercase letter and ending with a period) that
6447: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6448: support.</span>” The file is sorted by option names.</p>
6449: </div>
6450: </div>
6451: <div class="chapter" lang="en">
6452: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 6453: <a name="build"></a>Chapter 16. The build process</h2></div></div></div>
1.75 rillig 6454: <div class="toc">
6455: <p><b>Table of Contents</b></p>
6456: <dl>
1.90 rillig 6457: <dt><span class="sect1"><a href="#build.intro">16.1. Introduction</a></span></dt>
6458: <dt><span class="sect1"><a href="#build.prefix">16.2. Program location</a></span></dt>
6459: <dt><span class="sect1"><a href="#build.builddirs">16.3. Directories used during the build process</a></span></dt>
6460: <dt><span class="sect1"><a href="#build.running">16.4. Running a phase</a></span></dt>
6461: <dt><span class="sect1"><a href="#build.fetch">16.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6462: <dd><dl>
6463: <dt><span class="sect2"><a href="#build.fetch.what">16.5.1. What to fetch and where to get it from</a></span></dt>
6464: <dt><span class="sect2"><a href="#build.fetch.how">16.5.2. How are the files fetched?</a></span></dt>
6465: </dl></dd>
6466: <dt><span class="sect1"><a href="#build.checksum">16.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6467: <dt><span class="sect1"><a href="#build.extract">16.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6468: <dt><span class="sect1"><a href="#build.patch">16.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6469: <dt><span class="sect1"><a href="#build.tools">16.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6470: <dt><span class="sect1"><a href="#build.wrapper">16.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6471: <dt><span class="sect1"><a href="#build.configure">16.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6472: <dt><span class="sect1"><a href="#build.build">16.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6473: <dt><span class="sect1"><a href="#build.test">16.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6474: <dt><span class="sect1"><a href="#build.install">16.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6475: <dt><span class="sect1"><a href="#build.package">16.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6476: <dt><span class="sect1"><a href="#build.clean">16.16. Cleaning up</a></span></dt>
6477: <dt><span class="sect1"><a href="#build.helpful-targets">16.17. Other helpful targets</a></span></dt>
1.75 rillig 6478: </dl>
6479: </div>
6480: <div class="sect1" lang="en">
6481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6482: <a name="build.intro"></a>16.1. Introduction</h2></div></div></div>
1.75 rillig 6483: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6484: built. Building a package is separated into different
6485: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6486: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6487: described in the following sections. Each phase is splitted into
6488: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6489: containing phase, prefixed by one of <code class="varname">pre-</code>,
6490: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6491: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6492: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6493: <p>Never override the regular targets (like
6494: <code class="varname">fetch</code>), if you have to, override the
6495: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6496: <p>The basic steps for building a program are always the same. First
1.87 wiz 6497: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6498: the local system and then extracted. After any pkgsrc-specific patches
6499: to compile properly are applied, the software can be configured, then
6500: built (usually by compiling), and finally the generated binaries, etc.
6501: can be put into place on the system.</p>
1.97 rillig 6502: <p>To get more details about what is happening at each step,
6503: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6504: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6505: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6506: </div>
6507: <div class="sect1" lang="en">
6508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6509: <a name="build.prefix"></a>16.2. Program location</h2></div></div></div>
1.75 rillig 6510: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6511: the next section, here's a brief discussion on where programs are
6512: installed, and which variables influence this.</p>
1.75 rillig 6513: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6514: where all files of the final program shall be installed. It is
6515: usually set to <code class="varname">LOCALBASE</code>
6516: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6517: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6518: <code class="varname">PREFIX</code> needs to be put
6519: into the various places in the program's source where paths to
1.90 rillig 6520: 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 6521: <p>When choosing which of these variables to use,
1.87 wiz 6522: follow the following rules:</p>
1.75 rillig 6523: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6524: <li><p><code class="varname">PREFIX</code> always points to the location
6525: where the current pkg will be installed. When referring to a
6526: pkg's own installation path, use
6527: “<span class="quote">${PREFIX}</span>”.</p></li>
6528: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6529: are installed. If you need to construct a -I or -L argument
6530: to the compiler to find includes and libraries installed by
6531: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6532: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6533: installed all packages in <code class="filename">/usr/local</code>. As
6534: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6535: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6536: <li><p><code class="varname">X11BASE</code> is where the actual X11
6537: distribution (from xsrc, etc.) is installed. When looking for
6538: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6539: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6540: <li>
6541: <p>X11-based packages are special in that they may be
6542: installed in either <code class="varname">X11BASE</code> or
6543: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6544: <p>Usually, X11 packages should be installed under
1.88 wiz 6545: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6546: will need to include
6547: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6548: request the presence of X11 and to get the right compilation
6549: flags.</p>
1.75 rillig 6550: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6551: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6552: files. These packages are special and they must be placed under
6553: <code class="varname">X11BASE</code>. To accomplish this, set either
6554: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6555: your package.</p>
1.75 rillig 6556: <p>Some notes: If you need
1.87 wiz 6557: to find includes or libraries installed by a pkg that has
6558: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6559: its pkg <code class="filename">Makefile</code>, you need to look in
6560: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6561: <code class="filename">${LOCALBASE}</code>. To force installation of
6562: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6563: <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 6564: is enabled by default.</p>
1.75 rillig 6565: </li>
1.88 wiz 6566: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6567: the installed location of an X11
6568: package. <code class="varname">X11PREFIX</code> will be set to
6569: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6570: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6571: installed.</p></li>
6572: <li>
6573: <p>If xpkgwedge is installed, it is possible to have some
6574: packages installed in <code class="varname">X11BASE</code> and some in
6575: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6576: installed package, the <code class="varname">EVAL_PREFIX</code>
6577: definition can be used. It takes pairs in the format
6578: “<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>
6579: variable <code class="varname">DIRNAME</code> will be set to the prefix
6580: of the installed package <package>, or
6581: “<span class="quote">${X11PREFIX}</span>” if the package is not
6582: installed.</p>
1.75 rillig 6583: <p>This is best illustrated by example.</p>
6584: <p>The following lines are taken from
1.87 wiz 6585: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6586: <pre class="programlisting">
1.100 rillig 6587: EVAL_PREFIX+= GTKDIR=gtk+
6588: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6589: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6590: CONFIGURE_ARGS+= --enable-multibyte
6591: </pre>
1.88 wiz 6592: <p>Specific defaults can be defined for the packages
6593: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6594: definition of the form:</p>
1.75 rillig 6595: <pre class="programlisting">
1.100 rillig 6596: GTKDIR_DEFAULT= ${LOCALBASE}
6597: </pre>
1.75 rillig 6598: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6599: to the first definition in
6600: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6601: </li>
1.76 rillig 6602: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.87 wiz 6603: 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
6604: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6605: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6606: </ul></div>
6607: </div>
6608: <div class="sect1" lang="en">
6609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6610: <a name="build.builddirs"></a>16.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6611: <p>When building a package, a number of directories is used to store
1.87 wiz 6612: source files, temporary files, pkgsrc-internal files, and so on. These
6613: directories are explained here.</p>
1.75 rillig 6614: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6615: are two common base directories for these relative directories:
6616: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6617: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6618: inside the package itself.</p>
1.75 rillig 6619: <div class="variablelist"><dl>
6620: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6621: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6622: root directory. Generally, you don't need
6623: it.</p></dd>
1.97 rillig 6624: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6625: <dd><p>This is an absolute pathname that points to the
6626: current package.</p></dd>
1.75 rillig 6627: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6628: <dd><p>This is a pathname relative to
1.87 wiz 6629: <code class="varname">PKGSRCDIR</code> that points to the current
6630: package.</p></dd>
1.75 rillig 6631: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6632: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6633: where all work takes place. The distfiles are extracted to this
1.87 wiz 6634: directory. It also contains temporary directories and log files used by
6635: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6636: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6637: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6638: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6639: where the distfiles are extracted. It is usually a direct subdirectory
6640: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6641: that isn't hidden. This variable may be changed by a package
6642: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6643: </dl></div>
6644: </div>
6645: <div class="sect1" lang="en">
6646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6647: <a name="build.running"></a>16.4. Running a phase</h2></div></div></div>
1.75 rillig 6648: <p>You can run a particular phase by typing <span><strong class="command">make
1.87 wiz 6649: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6650: phase. This will automatically run all phases that are required for this
6651: phase. The default phase is <code class="varname">build</code>, that is, when you
6652: run <span><strong class="command">make</strong></span> without parameters in a package directory,
6653: the package will be built, but not installed.</p>
1.75 rillig 6654: </div>
6655: <div class="sect1" lang="en">
6656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6657: <a name="build.fetch"></a>16.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6658: <p>The first step in building a package is to fetch the
1.88 wiz 6659: distribution files (distfiles) from the sites that are providing
6660: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6661: phase.</p>
1.81 rillig 6662: <div class="sect2" lang="en">
6663: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6664: <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 6665: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6666: defines all URLs from where the distfile, whose name is
6667: derived from the <code class="varname">DISTNAME</code> variable, is
6668: fetched. The more complicated cases are described
6669: below.</p>
6670: <p>The variable <code class="varname">DISTFILES</code> specifies
6671: the list of distfiles that have to be fetched. Its value
6672: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6673: so that most packages don't need to define it at all.
6674: <code class="varname">EXTRACT_SUFX</code> is
6675: <code class="literal">.tar.gz</code> by default, but can be changed
6676: freely. Note that if your package requires additional
6677: distfiles to the default one, you cannot just append the
6678: additional filenames using the <code class="literal">+=</code>
6679: operator, but you have write for example:</p>
1.81 rillig 6680: <pre class="programlisting">
1.100 rillig 6681: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6682: </pre>
1.88 wiz 6683: <p>Each distfile is fetched from a list of sites, usually
6684: <code class="varname">MASTER_SITES</code>. If the package has multiple
6685: <code class="varname">DISTFILES</code> or multiple
6686: <code class="varname">PATCHFILES</code> from different sites, you can
6687: set
6688: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6689: to the list of URLs where the file
6690: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6691: (including the suffix) can be found.</p>
6692: <pre class="programlisting">
1.100 rillig 6693: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6694: DISTFILES+= foo-file.tar.gz
6695: SITES.foo-file.tar.gz= \
6696: http://www.somewhere.com/somehow/ \
6697: http://www.somewhereelse.com/mirror/somehow/
6698: </pre>
1.81 rillig 6699: <p>When actually fetching the distfiles, each item from
1.88 wiz 6700: <code class="varname">MASTER_SITES</code> or
6701: <code class="varname">SITES.*</code> gets the name of each distfile
6702: appended to it, without an intermediate slash. Therefore,
6703: all site values have to end with a slash or other separator
6704: character. This allows for example to set
6705: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6706: that gets the name of the distfile as a parameter. In this
6707: case, the definition would look like:</p>
1.81 rillig 6708: <pre class="programlisting">
1.100 rillig 6709: MASTER_SITES= http://www.example.com/download.cgi?file=
6710: </pre>
1.81 rillig 6711: <p>There are some predefined values for
1.88 wiz 6712: <code class="varname">MASTER_SITES</code>, which can be used in
6713: packages. The names of the variables should speak for
6714: themselves.</p>
6715: <pre class="programlisting">
1.100 rillig 6716: ${MASTER_SITE_APACHE}
6717: ${MASTER_SITE_BACKUP}
6718: ${MASTER_SITE_CYGWIN}
6719: ${MASTER_SITE_DEBIAN}
6720: ${MASTER_SITE_FREEBSD}
6721: ${MASTER_SITE_FREEBSD_LOCAL}
6722: ${MASTER_SITE_GENTOO}
6723: ${MASTER_SITE_GNOME}
6724: ${MASTER_SITE_GNU}
6725: ${MASTER_SITE_GNUSTEP}
6726: ${MASTER_SITE_IFARCHIVE}
6727: ${MASTER_SITE_KDE}
6728: ${MASTER_SITE_MOZILLA}
6729: ${MASTER_SITE_MYSQL}
6730: ${MASTER_SITE_OPENOFFICE}
6731: ${MASTER_SITE_PERL_CPAN}
6732: ${MASTER_SITE_PGSQL}
6733: ${MASTER_SITE_R_CRAN}
6734: ${MASTER_SITE_SOURCEFORGE}
6735: ${MASTER_SITE_SOURCEFORGE_JP}
6736: ${MASTER_SITE_SUNSITE}
6737: ${MASTER_SITE_SUSE}
6738: ${MASTER_SITE_TEX_CTAN}
6739: ${MASTER_SITE_XCONTRIB}
6740: ${MASTER_SITE_XEMACS}
6741: </pre>
1.88 wiz 6742: <p>Some explanations for the less self-explaining ones:
6743: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.93 rillig 6744: 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
6745: 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 6746: <p>If you choose one of these predefined sites, you may
6747: want to specify a subdirectory of that site. Since these
6748: macros may expand to more than one actual site, you
6749: <span class="emphasis"><em>must</em></span> use the following construct to
6750: specify a subdirectory:</p>
1.81 rillig 6751: <pre class="programlisting">
1.100 rillig 6752: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6753: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6754: </pre>
1.81 rillig 6755: <p>Note the trailing slash after the subdirectory
1.88 wiz 6756: name.</p>
1.81 rillig 6757: </div>
6758: <div class="sect2" lang="en">
6759: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 6760: <a name="build.fetch.how"></a>16.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6761: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6762: all the distfiles exist in a local directory
1.93 rillig 6763: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6764: user). If the files do not exist, they are fetched using
6765: commands of the form</p>
1.75 rillig 6766: <pre class="programlisting">
1.100 rillig 6767: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6768: </pre>
1.88 wiz 6769: <p>where <code class="literal">${site}</code> varies through
6770: several possibilities in turn: first,
6771: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6772: sites specified in either <code class="varname">SITES.file</code> if
6773: defined, else <code class="varname">MASTER_SITES</code> or
6774: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6775: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6776: all except the first and the last can be optionally sorted
6777: by the user, via setting either
6778: <code class="varname">MASTER_SORT_RANDOM</code>, and
6779: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6780: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97 rillig 6781: <p>The distfiles mirror run by the NetBSD Foundation uses the
6782: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6783: distfiles, if they are freely distributable. Packages setting
6784: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6785: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6786: mirrored.</p>
1.81 rillig 6787: </div>
1.75 rillig 6788: </div>
6789: <div class="sect1" lang="en">
6790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6791: <a name="build.checksum"></a>16.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6792: <p>After the distfile(s) are fetched, their checksum is
6793: generated and compared with the checksums stored in the
6794: distinfo file. If the checksums don't match, the build is
6795: aborted. This is to ensure the same distfile is used for
6796: building, and that the distfile wasn't changed, e.g. by some
6797: malign force, deliberately changed distfiles on the master
6798: distribution site or network lossage.</p>
1.75 rillig 6799: </div>
6800: <div class="sect1" lang="en">
6801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6802: <a name="build.extract"></a>16.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6803: <p>When the distfiles are present on the local system, they
1.88 wiz 6804: need to be extracted, as they usually come in the form of some
6805: compressed archive format.</p>
1.75 rillig 6806: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6807: extracted. If you only need some of them, you can set the
6808: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6809: files.</p>
6810: <p>Extracting the files is usually done by a little
1.93 rillig 6811: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6812: already knows how to extract various archive formats, so most
6813: likely you will not need to change anything here. But if you
6814: need, the following variables may help you:</p>
1.75 rillig 6815: <div class="variablelist"><dl>
6816: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6817: <dd><p>Use these variables to override the default
1.88 wiz 6818: options for an extract command, which are defined in
1.93 rillig 6819: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6820: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6821: <dd><p>This variable can be set to
1.93 rillig 6822: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6823: default value), <code class="literal">pax</code>, or an
1.88 wiz 6824: absolute pathname pointing to the command with which tar
6825: archives should be
6826: extracted.</p></dd>
1.75 rillig 6827: </dl></div>
1.88 wiz 6828: <p>If the <code class="filename">extract</code> program doesn't
6829: serve your needs, you can also override the
6830: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6831: command used for extracting the files. This command is
6832: executed in the <code class="filename">${WRKSRC}</code>
6833: directory. During execution of this command, the shell
6834: variable <code class="varname">extract_file</code> holds the absolute
6835: pathname of the file that is going to be extracted.</p>
1.75 rillig 6836: <p>And if that still does not suffice, you can override the
1.88 wiz 6837: <code class="varname">do-extract</code> target in the package
6838: Makefile.</p>
1.75 rillig 6839: </div>
6840: <div class="sect1" lang="en">
6841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6842: <a name="build.patch"></a>16.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6843: <p>After extraction, all the patches named by the
1.88 wiz 6844: <code class="varname">PATCHFILES</code>, those present in the patches
6845: subdirectory of the package as well as in
6846: $LOCALPATCHES/$PKGPATH (e.g.
6847: <code class="filename">/usr/local/patches/graphics/png</code>) are
6848: applied. Patchfiles ending in <code class="filename">.Z</code> or
6849: <code class="filename">.gz</code> are uncompressed before they are
6850: applied, files ending in <code class="filename">.orig</code> or
6851: <code class="filename">.rej</code> are ignored. Any special options to
6852: <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 6853: <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 6854: <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
6855: it fail if the patches apply with some lines of fuzz. Please
6856: fix (regen) the patches so that they apply cleanly. The
6857: rationale behind this is that patches that don't apply cleanly
6858: may end up being applied in the wrong place, and cause severe
6859: harm there.</p>
1.75 rillig 6860: </div>
6861: <div class="sect1" lang="en">
6862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6863: <a name="build.tools"></a>16.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6864: <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 6865: </p>
1.75 rillig 6866: </div>
6867: <div class="sect1" lang="en">
6868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6869: <a name="build.wrapper"></a>16.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6870: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6871: linkers. The following variables can be used to tweak the
6872: wrappers.</p>
1.75 rillig 6873: <div class="variablelist"><dl>
6874: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6875: <dd><p>The command used to print progress
1.88 wiz 6876: messages. Does nothing by default. Set to
6877: <code class="literal">${ECHO}</code> to see the progress
6878: messages.</p></dd>
1.75 rillig 6879: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6880: <dd><p>This variable can be set to
1.88 wiz 6881: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6882: depending on whether you want additional information in the
6883: wrapper log file.</p></dd>
1.75 rillig 6884: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6885: <dd><p>This variable can be set to
1.88 wiz 6886: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6887: on whether the wrapper should use its cache, which will
6888: improve the speed. The default value is
6889: <code class="literal">yes</code>, but is forced to
6890: <code class="literal">no</code> if the platform does not support
6891: it.</p></dd>
1.75 rillig 6892: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6893: <dd><p>A list of reordering commands. A reordering
6894: command has the form
6895: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6896: It ensures that that
6897: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6898: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6899: </p></dd>
1.75 rillig 6900: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6901: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6902: investigate further]</p></dd>
1.75 rillig 6903: </dl></div>
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.configure"></a>16.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6908: <p>Most pieces of software need information on the header
6909: files, system calls, and library routines which are available
6910: on the platform they run on. The process of determining this
6911: information is known as configuration, and is usually
6912: automated. In most cases, a script is supplied with the
6913: distfiles, and its invocation results in generation of header
6914: files, Makefiles, etc.</p>
6915: <p>If the package contains a configure script, this can be
6916: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6917: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6918: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6919: “<span class="quote">yes</span>” instead. What happens in the
6920: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6921: <pre class="programlisting">
1.100 rillig 6922: .for d in ${CONFIGURE_DIRS}
6923: cd ${WRKSRC} \
6924: && cd ${d} \
6925: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6926: .endfor
6927: </pre>
1.88 wiz 6928: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6929: “<span class="quote">.</span>”) is a list of pathnames relative to
6930: <code class="varname">WRKSRC</code>. In each of these directories, the
6931: configure script is run with the environment
6932: <code class="varname">CONFIGURE_ENV</code> and arguments
6933: <code class="varname">CONFIGURE_ARGS</code>. The variables
6934: <code class="varname">CONFIGURE_ENV</code>,
6935: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6936: “<span class="quote">./configure</span>”) and
6937: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6938: package.</p>
6939: <p>If the program uses an <code class="filename">Imakefile</code>
6940: for configuration, the appropriate steps can be invoked by
6941: setting <code class="varname">USE_IMAKE</code> to
6942: “<span class="quote">yes</span>”. (If you only want the package installed in
6943: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6944: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6945: xmkmf's environment by adding them to the
6946: <code class="varname">SCRIPTS_ENV</code> variable.</p>
6947: <p>If there is no configure step at all, set
6948: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6949: </div>
6950: <div class="sect1" lang="en">
6951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6952: <a name="build.build"></a>16.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6953: <p>For building a package, a rough equivalent of the
6954: following code is executed.</p>
1.75 rillig 6955: <pre class="programlisting">
1.100 rillig 6956: .for d in ${BUILD_DIRS}
6957: cd ${WRKSRC} \
6958: && cd ${d} \
6959: && env ${MAKE_ENV} \
6960: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6961: -f ${MAKE_FILE} \
6962: ${BUILD_TARGET}
6963: .endfor
6964: </pre>
1.88 wiz 6965: <p><code class="varname">BUILD_DIRS</code> (default:
6966: “<span class="quote">.</span>”) is a list of pathnames relative to
6967: <code class="varname">WRKSRC</code>. In each of these directories,
6968: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6969: <code class="varname">MAKE_ENV</code> and arguments
6970: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6971: <code class="varname">MAKE_ENV</code>,
6972: <code class="varname">BUILD_MAKE_FLAGS</code>,
6973: <code class="varname">MAKE_FILE</code> and
6974: <code class="varname">BUILD_TARGET</code> may all be changed by the
6975: package.</p>
1.75 rillig 6976: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6977: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6978: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6979: default value of <code class="varname">MAKE_FILE</code> is
6980: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6981: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6982: <p>If there is no build step at all, set
6983: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6984: </div>
6985: <div class="sect1" lang="en">
6986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6987: <a name="build.test"></a>16.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6988: <p>[TODO]</p>
6989: </div>
6990: <div class="sect1" lang="en">
6991: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 6992: <a name="build.install"></a>16.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6993: <p>Once the build stage has completed, the final step is to
1.88 wiz 6994: install the software in public directories, so users can
6995: access the programs and files.</p>
1.75 rillig 6996: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6997: equivalent of the following code is executed. Additionally,
6998: before and after this code, much magic is performed to do
6999: consistency checks, registering the package, and so on.</p>
7000: <pre class="programlisting">
1.100 rillig 7001: .for d in ${INSTALL_DIRS}
7002: cd ${WRKSRC} \
7003: && cd ${d} \
7004: && env ${MAKE_ENV} \
7005: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7006: -f ${MAKE_FILE} \
7007: ${INSTALL_TARGET}
7008: .endfor
7009: </pre>
1.75 rillig 7010: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 7011: <span class="emphasis"><em>build</em></span> phase.
7012: <code class="varname">INSTALL_DIRS</code> defaults to
7013: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7014: is “<span class="quote">install</span>” by default, plus
7015: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
7016: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7017: defined.</p>
1.75 rillig 7018: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 7019: variables are useful. They are all variations of the
7020: <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
7021: permissions preset. <code class="varname">INSTALL</code> is the plain
7022: install command. The specialized variants, together with their
7023: intended use, are:</p>
1.75 rillig 7024: <div class="variablelist"><dl>
7025: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 7026: <dd><p>directories that contain
7027: binaries</p></dd>
1.75 rillig 7028: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 7029: <dd><p>directories that contain
7030: scripts</p></dd>
1.75 rillig 7031: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 7032: <dd><p>directories that contain shared and static
7033: libraries</p></dd>
1.75 rillig 7034: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 7035: <dd><p>directories that contain data
7036: files</p></dd>
1.75 rillig 7037: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 7038: <dd><p>directories that contain man
7039: pages</p></dd>
1.75 rillig 7040: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 7041: <dd><p>binaries that can be stripped from debugging
7042: symbols</p></dd>
1.75 rillig 7043: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 7044: <dd><p>binaries that cannot be
7045: stripped</p></dd>
1.75 rillig 7046: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 7047: <dd><p>game
7048: binaries</p></dd>
1.75 rillig 7049: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 7050: <dd><p>shared and static
7051: libraries</p></dd>
1.75 rillig 7052: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7053: <dd><p>data files</p></dd>
7054: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 7055: <dd><p>data files for
7056: games</p></dd>
1.75 rillig 7057: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7058: <dd><p>man pages</p></dd>
7059: </dl></div>
7060: <p>Some other variables are:</p>
7061: <div class="variablelist"><dl>
7062: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7063: <dd><p>A list of directories relative to
1.88 wiz 7064: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 7065: beginning of the <span class="emphasis"><em>install</em></span> phase.
7066: The package is supposed to create all needed directories itself
7067: before installing files to it and list all other directories here.
7068: </p></dd>
1.75 rillig 7069: </dl></div>
1.97 rillig 7070: <p>In the rare cases that a package shouldn't install anything,
7071: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
7072: mostly relevant for packages in the <code class="filename">regress</code>
7073: category.</p>
1.75 rillig 7074: </div>
7075: <div class="sect1" lang="en">
7076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7077: <a name="build.package"></a>16.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 7078: <p>Once the install stage has completed, a binary package of
7079: the installed files can be built. These binary packages can be
7080: used for quick installation without previous compilation, e.g. by
7081: the <span><strong class="command">make bin-install</strong></span> or by using
7082: <span><strong class="command">pkg_add</strong></span>.</p>
7083: <p>By default, the binary packages are created in
7084: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7085: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7086: one for each category in the <code class="varname">CATEGORIES</code>
7087: variable. <code class="varname">PACKAGES</code> defaults to
7088: <code class="filename">pkgsrc/packages</code>.</p>
1.97 rillig 7089: <p>If there should be no binary package, set
7090: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7091: This should only be used in rare cases, like when a package
7092: definitely is only usable on the machine where it is built and even
7093: then, a binary package can be useful.</p>
1.88 wiz 7094: </div>
7095: <div class="sect1" lang="en">
7096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7097: <a name="build.clean"></a>16.16. Cleaning up</h2></div></div></div>
1.88 wiz 7098: <p>Once you're finished with a package, you can clean the work
7099: directory by running <span><strong class="command">make clean</strong></span>. If you want
7100: to clean the work directories of all dependencies too, use
7101: <span><strong class="command">make clean-depends</strong></span>.</p>
1.75 rillig 7102: </div>
7103: <div class="sect1" lang="en">
7104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7105: <a name="build.helpful-targets"></a>16.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7106: <div class="variablelist"><dl>
7107: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7108: <dd><p>For any of the main targets described in the
7109: previous section, two auxiliary targets exist with
1.87 wiz 7110: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7111: prefix for the main target's name. These targets are
1.88 wiz 7112: invoked before and after the main target is called,
7113: allowing extra configuration or installation steps be
7114: performed from a package's Makefile, for example, which
7115: a program's configure script or install target
7116: omitted.</p></dd>
1.75 rillig 7117: <dt><span class="term">do-*</span></dt>
1.88 wiz 7118: <dd><p>Should one of the main targets do the wrong thing,
7119: and should there be no variable to fix this, you can
7120: redefine it with the do-* target. (Note that redefining
7121: the target itself instead of the do-* target is a bad
7122: idea, as the pre-* and post-* targets won't be called
7123: anymore, etc.) You will not usually need to do
7124: this.</p></dd>
1.75 rillig 7125: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7126: <dd>
7127: <p>If you did a <span><strong class="command">make install</strong></span> and
7128: you noticed some file was not installed properly, you
7129: can repeat the installation with this target, which will
7130: ignore the “<span class="quote">already installed</span>” flag.</p>
7131: <p>This is the default value of
7132: <code class="varname">DEPENDS_TARGET</code> except in the case of
7133: <span><strong class="command">make update</strong></span> and <span><strong class="command">make
7134: package</strong></span>, where the defaults are
7135: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7136: respectively.</p>
7137: </dd>
1.75 rillig 7138: <dt><span class="term">deinstall</span></dt>
7139: <dd>
1.88 wiz 7140: <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
7141: current directory, effectively de-installing the
7142: package. The following variables can be used to tune the
7143: behaviour:</p>
1.75 rillig 7144: <div class="variablelist"><dl>
7145: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7146: <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>
7147: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7148: <dd><p>Remove all packages that require (depend on)
7149: the given package. This can be used to remove any
7150: packages that may have been pulled in by a given
7151: package, e.g. if <span><strong class="command">make deinstall
1.87 wiz 7152: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7153: <code class="filename">pkgsrc/x11/kde</code>, this is
7154: likely to remove whole KDE. Works by adding
7155: “<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>
7156: command line.</p></dd>
1.75 rillig 7157: </dl></div>
7158: </dd>
1.88 wiz 7159: <dt><span class="term">bin-install</span></dt>
7160: <dd><p>Install a binary package from local disk and via FTP
7161: from a list of sites (see the
7162: <code class="varname">BINPKG_SITES</code> variable), and do a
7163: <span><strong class="command">make package</strong></span> if no binary package is
7164: available anywhere. The arguments given to
7165: <span><strong class="command">pkg_add</strong></span> can be set via
7166: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7167: operation, etc.</p></dd>
1.75 rillig 7168: <dt><span class="term">update</span></dt>
7169: <dd>
1.88 wiz 7170: <p>This target causes the current package to be
7171: updated to the latest version. The package and all
7172: depending packages first get de-installed, then current
7173: versions of the corresponding packages get compiled and
7174: installed. This is similar to manually noting which
7175: packages are currently installed, then performing a
7176: series of <span><strong class="command">make deinstall</strong></span> and
7177: <span><strong class="command">make install</strong></span> (or whatever
7178: <code class="varname">UPDATE_TARGET</code> is set to) for these
7179: packages.</p>
7180: <p>You can use the “<span class="quote">update</span>” target to
7181: resume package updating in case a previous <span><strong class="command">make
7182: update</strong></span> was interrupted for some reason.
7183: However, in this case, make sure you don't call
7184: <span><strong class="command">make clean</strong></span> or otherwise remove the
7185: list of dependent packages in <code class="varname">WRKDIR</code>.
7186: Otherwise, you lose the ability to automatically update
7187: the current package along with the dependent packages
7188: you have installed.</p>
7189: <p>Resuming an interrupted <span><strong class="command">make
7190: update</strong></span> will only work as long as the package
7191: tree remains unchanged. If the source code for one of
7192: the packages to be updated has been changed, resuming
7193: <span><strong class="command">make update</strong></span> will most certainly
7194: fail!</p>
7195: <p>The following variables can be used either on the
1.104 ! rillig 7196: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 7197: alter the behaviour of <span><strong class="command">make
7198: update</strong></span>:</p>
1.75 rillig 7199: <div class="variablelist"><dl>
7200: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7201: <dd><p>Install target to recursively use for the
7202: updated package and the dependent packages.
7203: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7204: set, “<span class="quote">install</span>” otherwise for
7205: <span><strong class="command">make update</strong></span>. Other good
7206: targets are “<span class="quote">package</span>” or
7207: “<span class="quote">bin-install</span>”. Do not set this to
7208: “<span class="quote">update</span>” or you will get stuck in an
7209: endless loop!</p></dd>
1.75 rillig 7210: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7211: <dd><p>Don't clean up after updating. Useful if
7212: you want to leave the work sources of the updated
7213: packages around for inspection or other purposes.
7214: Be sure you eventually clean up the source tree
7215: (see the “<span class="quote">clean-update</span>” target below)
7216: or you may run into troubles with old source code
7217: still lying around on your next
7218: <span><strong class="command">make</strong></span> or <span><strong class="command">make
7219: update</strong></span>.</p></dd>
1.75 rillig 7220: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7221: <dd><p>Deinstall each package before installing
7222: (making <code class="varname">DEPENDS_TARGET</code>). This
7223: may be necessary if the
7224: “<span class="quote">clean-update</span>” target (see below) was
7225: called after interrupting a running <span><strong class="command">make
7226: update</strong></span>.</p></dd>
1.75 rillig 7227: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7228: <dd><p>Allows you to disable recursion and hardcode
7229: the target for packages. The default is
7230: “<span class="quote">update</span>” for the update target,
7231: facilitating a recursive update of prerequisite
7232: packages. Only set
7233: <code class="varname">DEPENDS_TARGET</code> if you want to
7234: disable recursive updates. Use
7235: <code class="varname">UPDATE_TARGET</code> instead to just
7236: set a specific target for each package to be
7237: installed during <span><strong class="command">make update</strong></span>
7238: (see above).</p></dd>
1.75 rillig 7239: </dl></div>
7240: </dd>
7241: <dt><span class="term">clean-update</span></dt>
7242: <dd>
1.88 wiz 7243: <p>Clean the source tree for all packages that would
7244: get updated if <span><strong class="command">make update</strong></span> was called
7245: from the current directory. This target should not be
7246: used if the current package (or any of its depending
7247: packages) have already been de-installed (e.g., after
7248: calling <span><strong class="command">make update</strong></span>) or you may lose
7249: some packages you intended to update. As a rule of
7250: thumb: only use this target <span class="emphasis"><em>before</em></span>
7251: the first time you run <span><strong class="command">make update</strong></span>
7252: and only if you have a dirty package tree (e.g., if you
7253: used <code class="varname">NOCLEAN</code>).</p>
7254: <p>If you are unsure about whether your tree is
7255: clean, you can either perform a <span><strong class="command">make
7256: clean</strong></span> at the top of the tree, or use the
7257: following sequence of commands from the directory of the
7258: package you want to update (<span class="emphasis"><em>before</em></span>
7259: running <span><strong class="command">make update</strong></span> for the first
7260: time, otherwise you lose all the packages you wanted to
7261: update!):</p>
1.87 wiz 7262: <pre class="screen">
7263: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7264: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7265: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7266: </pre>
1.88 wiz 7267: <p>The following variables can be used either on the
1.104 ! rillig 7268: command line or in <a href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
! 7269: <span><strong class="command">make clean-update</strong></span>:</p>
1.75 rillig 7270: <div class="variablelist"><dl>
7271: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.88 wiz 7272: <dd><p>After <span><strong class="command">make clean</strong></span>, do not
7273: reconstruct the list of directories to update for
7274: this package. Only use this if <span><strong class="command">make
7275: update</strong></span> successfully installed all
7276: packages you wanted to update. Normally, this is
7277: done automatically on <span><strong class="command">make
7278: update</strong></span>, but may have been suppressed by
7279: the <code class="varname">NOCLEAN</code> variable (see
7280: above).</p></dd>
1.75 rillig 7281: </dl></div>
7282: </dd>
1.88 wiz 7283: <dt><span class="term">replace</span></dt>
7284: <dd>
7285: <p>Update the installation of the current package. This
7286: differs from update in that it does not replace dependent
1.93 rillig 7287: 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 7288: target to work.</p>
7289: <p><span class="emphasis"><em>Be careful when using this
7290: target!</em></span> There are no guarantees that dependent
7291: packages will still work, in particular they will most
7292: certainly break if you <span><strong class="command">make replace</strong></span> a
7293: library package whose shared library major version changed
7294: between your installed version and the new one. For this
7295: reason, this target is not officially supported and only
7296: recommended for advanced users.</p>
7297: </dd>
1.75 rillig 7298: <dt><span class="term">info</span></dt>
7299: <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 7300: package. You can use this to check which version of a
7301: package is installed.</p></dd>
7302: <dt><span class="term">index</span></dt>
7303: <dd>
7304: <p>This is a top-level command, i.e. it should be used in
7305: the <code class="filename">pkgsrc</code> directory. It creates a
7306: database of all packages in the local pkgsrc tree, including
7307: dependencies, comment, maintainer, and some other useful
7308: information. Individual entries are created by running
7309: <span><strong class="command">make describe</strong></span> in the packages'
7310: directories. This index file is saved as
7311: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
7312: verbose format by running <span><strong class="command">make
7313: print-index</strong></span>. You can search in it with
7314: <span><strong class="command">make search
7315: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7316: extract a list of all packages that depend on a particular
7317: one by running <span><strong class="command">make show-deps
7318: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7319: <p>Running this command takes a very long time, some
7320: hours even on fast machines!</p>
7321: </dd>
1.75 rillig 7322: <dt><span class="term">readme</span></dt>
1.88 wiz 7323: <dd>
7324: <p>This target generates a
7325: <code class="filename">README.html</code> file, which can be
1.91 rillig 7326: 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 7327: contain references to any packages which are in the
7328: <code class="varname">PACKAGES</code> directory on the local
7329: host. The generated files can be made to refer to URLs
7330: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7331: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7332: wanted to generate <code class="filename">README.html</code>
7333: files which pointed to binary packages on the local
7334: machine, in the directory
7335: <code class="filename">/usr/packages</code>, set
7336: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7337: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7338: <code class="varname">${PACKAGES}</code> directory and its
7339: subdirectories will be searched for all the binary
7340: packages.</p>
7341: <p>The target can be run at the toplevel or in category
7342: directories, in which case it descends recursively.</p>
7343: </dd>
1.75 rillig 7344: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7345: <dd><p>This is a top-level command, run it in
7346: <code class="filename">pkgsrc</code>. Use this target to create a
7347: file <code class="filename">README-all.html</code> which contains a
7348: list of all packages currently available in the NetBSD
7349: Packages Collection, together with the category they belong
7350: to and a short description. This file is compiled from the
7351: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7352: to run this <span class="emphasis"><em>after</em></span> a <span><strong class="command">make
7353: readme</strong></span>.</p></dd>
1.75 rillig 7354: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7355: <dd><p>This is very much the same as the
7356: “<span class="quote">readme</span>” target (see above), but is to be
7357: used when generating a pkgsrc tree to be written to a
7358: CD-ROM. This target also produces
7359: <code class="filename">README.html</code> files, and can be made
7360: to refer to URLs based on
7361: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7362: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7363: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7364: <dd><p>This target shows which distfiles and patchfiles
7365: are needed to build the package
7366: (<code class="varname">ALLFILES</code>, which contains all
7367: <code class="varname">DISTFILES</code> and
1.87 wiz 7368: <code class="varname">PATCHFILES</code>, but not
7369: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7370: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7371: <dd><p>This target shows nothing if the package is not
7372: installed. If a version of this package is installed,
7373: but is not the version provided in this version of
7374: pkgsrc, then a warning message is displayed. This target
7375: can be used to show which of your installed packages are
7376: downlevel, and so the old versions can be deleted, and
7377: the current ones added.</p></dd>
1.75 rillig 7378: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7379: <dd><p>This target shows the directory in the pkgsrc
7380: hierarchy from which the package can be built and
7381: installed. This may not be the same directory as the one
7382: from which the package was installed. This target is
7383: intended to be used by people who may wish to upgrade
7384: many packages on a single host, and can be invoked from
7385: the top-level pkgsrc Makefile by using the
1.87 wiz 7386: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7387: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7388: <dd><p>This target shows which installed packages match
7389: the current package's <code class="varname">DEPENDS</code>. Useful
7390: if out of date dependencies are causing build
7391: problems.</p></dd>
1.75 rillig 7392: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7393: <dd><p>After a package is installed, check all its
7394: binaries and (on ELF platforms) shared libraries to see
7395: if they find the shared libs they need. Run by default
1.104 ! rillig 7396: 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 7397: <dt><span class="term">print-PLIST</span></dt>
7398: <dd>
7399: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7400: upgraded pkg, this prints out an attempt to generate a
7401: new <code class="filename">PLIST</code> from a <span><strong class="command">find
7402: -newer work/.extract_done</strong></span>. An attempt is made
7403: to care for shared libs etc., but it is
1.87 wiz 7404: <span class="emphasis"><em>strongly</em></span> recommended to review the
7405: result before putting it into
7406: <code class="filename">PLIST</code>. On upgrades, it's useful to
7407: diff the output of this command against an already
7408: existing <code class="filename">PLIST</code> file.</p>
1.88 wiz 7409: <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
7410: other methods that don't update file access times, be
7411: sure to add these files manually to your
1.87 wiz 7412: <code class="filename">PLIST</code>, as the “<span class="quote">find
7413: -newer</span>” command used by this target won't catch
7414: them!</p>
1.90 rillig 7415: <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 7416: information on this target.</p>
1.75 rillig 7417: </dd>
7418: <dt><span class="term">bulk-package</span></dt>
7419: <dd>
1.88 wiz 7420: <p>Used to do bulk builds. If an appropriate binary
7421: package already exists, no action is taken. If not, this
7422: target will compile, install and package it (and its
7423: depends, if <code class="varname">PKG_DEPENDS</code> is set
7424: properly. See <a href="#binary.configuration" title="6.3.1. Configuration">Section 6.3.1, “Configuration”</a>).
7425: After creating the binary package, the sources, the
7426: just-installed package and its required packages are
7427: removed, preserving free disk space.</p>
7428: <p><span class="emphasis"><em>Beware that this target may deinstall
7429: all packages installed on a system!</em></span></p>
1.75 rillig 7430: </dd>
7431: <dt><span class="term">bulk-install</span></dt>
7432: <dd>
1.88 wiz 7433: <p>Used during bulk-installs to install required
7434: packages. If an up-to-date binary package is available,
7435: 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,
7436: <span><strong class="command">make bulk-package</strong></span> will be executed,
1.87 wiz 7437: but the installed binary won't be removed.</p>
1.88 wiz 7438: <p>A binary package is considered
7439: “<span class="quote">up-to-date</span>” to be installed via
7440: <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>
7441: <div class="itemizedlist"><ul type="disc">
7442: <li><p>None of the package's files
7443: (<code class="filename">Makefile</code>, ...) were modified
7444: since it was built.</p></li>
7445: <li><p>None of the package's required (binary)
7446: packages were modified since it was built.</p></li>
1.75 rillig 7447: </ul></div>
1.88 wiz 7448: <p><span class="emphasis"><em>Beware that this target may deinstall
7449: all packages installed on a system!</em></span></p>
1.75 rillig 7450: </dd>
7451: </dl></div>
7452: </div>
7453: </div>
7454: <div class="chapter" lang="en">
7455: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7456: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7457: <div class="toc">
7458: <p><b>Table of Contents</b></p>
7459: <dl>
1.90 rillig 7460: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
7461: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
7462: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.97 rillig 7463: <dt><span class="sect1"><a href="#tools.questions">17.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7464: </dl>
7465: </div>
1.87 wiz 7466: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7467: by pkgsrc and also for individual packages to define what commands
7468: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7469: or for later run-time of an installed packaged (such as
7470: <code class="varname">DEPENDS</code>).
7471: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7472: package will not be used.</p>
7473: <p>When building a package, the replacement tools are
1.75 rillig 7474: made available in a directory (as symlinks or wrapper scripts)
7475: that is early in the executable search path. Just like the buildlink
1.87 wiz 7476: system, this helps with consistent builds.</p>
7477: <p>A tool may be needed to help build a specific package. For example,
7478: perl, GNU make (gmake) or yacc may be needed.</p>
7479: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7480: tool may be inefficient for building a package with pkgsrc.
7481: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7482: yacc) or a better sed.</p>
7483: <p>The tools used by a package can be listed by running
7484: <span><strong class="command">make show-tools</strong></span>.</p>
1.75 rillig 7485: <div class="sect1" lang="en">
7486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7487: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7488: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7489: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.75 rillig 7490: such as: <span><strong class="command">cat</strong></span>, <span><strong class="command">awk</strong></span>,
7491: <span><strong class="command">chmod</strong></span>, <span><strong class="command">test</strong></span>, and so on.
7492: These can be seen by running:
1.87 wiz 7493: <span><strong class="command">make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7494: <p>If a package needs a specific program to build
1.75 rillig 7495: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7496: to define the tools needed.</p>
1.75 rillig 7497: </div>
7498: <div class="sect1" lang="en">
7499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7500: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7501: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7502: and not the native version for a build dependency.
7503: And the :run means that it is used for a
7504: run-time dependencies also (and becomes a DEPENDS).
7505: The default is a build dependency which can be set with
7506: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7507: and pkg-config:build.)</p>
1.75 rillig 7508: <pre class="programlisting">
7509: USE_TOOLS+= mktemp:pkgsrc
7510: USE_TOOLS+= gmake perl:run pkg-config
7511: </pre>
1.87 wiz 7512: <p>When using the tools framework, a
1.75 rillig 7513: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7514: which contains the full path to the appropriate tool. For example,
7515: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7516: on Linux systems.</p>
7517: <p>If you always need a pkgsrc version of the
1.75 rillig 7518: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7519: </p>
7520: </div>
7521: <div class="sect1" lang="en">
7522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7523: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7524: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7525: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7526: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7527: the name of the common tools. For example:</p>
7528: <pre class="programlisting">
7529: .if exists(/usr/bin/bzcat)
7530: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7531: .elif exists(/usr/bin/bzip2)
7532: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7533: .endif
1.69 rillig 7534:
1.75 rillig 7535: TOOLS_PLATFORM.true?= true # shell builtin
7536: </pre>
7537: </div>
1.97 rillig 7538: <div class="sect1" lang="en">
7539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7540: <a name="tools.questions"></a>17.4. Questions regarding the tools</h2></div></div></div>
7541: <div class="qandaset">
7542: <dl>
7543: <dt>17.4.1. <a href="#tools.new">How do I add a new tool?</a>
7544: </dt>
7545: <dt>17.4.2. <a href="#tools.listall">How do I get a list of all available
7546: tools?</a>
7547: </dt>
7548: <dt>17.4.3. <a href="#tools.used">How can I get a list of all the tools that a
7549: package is using while being built? I want to know whether it
7550: uses sed or not.</a>
7551: </dt>
7552: </dl>
7553: <table border="0" summary="Q and A Set">
7554: <col align="left" width="1%">
7555: <tbody>
7556: <tr class="question">
7557: <td align="left" valign="top">
1.104 ! rillig 7558: <a name="tools.new"></a><a name="id2708318"></a><b>17.4.1.</b>
1.97 rillig 7559: </td>
7560: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7561: </tr>
7562: <tr class="answer">
7563: <td align="left" valign="top"></td>
7564: <td align="left" valign="top"><p>TODO</p></td>
7565: </tr>
7566: <tr class="question">
7567: <td align="left" valign="top">
1.104 ! rillig 7568: <a name="tools.listall"></a><a name="id2708328"></a><b>17.4.2.</b>
1.97 rillig 7569: </td>
7570: <td align="left" valign="top"><p>How do I get a list of all available
7571: tools?</p></td>
7572: </tr>
7573: <tr class="answer">
7574: <td align="left" valign="top"></td>
7575: <td align="left" valign="top"><p>TODO</p></td>
7576: </tr>
7577: <tr class="question">
7578: <td align="left" valign="top">
1.104 ! rillig 7579: <a name="tools.used"></a><a name="id2708339"></a><b>17.4.3.</b>
1.97 rillig 7580: </td>
7581: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7582: package is using while being built? I want to know whether it
7583: uses sed or not.</p></td>
7584: </tr>
7585: <tr class="answer">
7586: <td align="left" valign="top"></td>
7587: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7588: to do it.)</p></td>
7589: </tr>
7590: </tbody>
7591: </table>
7592: </div>
7593: </div>
1.75 rillig 7594: </div>
7595: <div class="chapter" lang="en">
7596: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 7597: <a name="fixes"></a>Chapter 18. Making your package work</h2></div></div></div>
1.75 rillig 7598: <div class="toc">
7599: <p><b>Table of Contents</b></p>
7600: <dl>
1.90 rillig 7601: <dt><span class="sect1"><a href="#general-operation">18.1. General operation</a></span></dt>
1.75 rillig 7602: <dd><dl>
1.90 rillig 7603: <dt><span class="sect2"><a href="#portability-of-packages">18.1.1. Portability of packages</a></span></dt>
7604: <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>
7605: <dt><span class="sect2"><a href="#user-interaction">18.1.3. User interaction</a></span></dt>
7606: <dt><span class="sect2"><a href="#handling-licenses">18.1.4. Handling licenses</a></span></dt>
7607: <dt><span class="sect2"><a href="#restricted-packages">18.1.5. Restricted packages</a></span></dt>
7608: <dt><span class="sect2"><a href="#dependencies">18.1.6. Handling dependencies</a></span></dt>
7609: <dt><span class="sect2"><a href="#conflicts">18.1.7. Handling conflicts with other packages</a></span></dt>
7610: <dt><span class="sect2"><a href="#not-building-packages">18.1.8. Packages that cannot or should not be built</a></span></dt>
7611: <dt><span class="sect2"><a href="#undeletable-packages">18.1.9. Packages which should not be deleted, once installed</a></span></dt>
7612: <dt><span class="sect2"><a href="#security-handling">18.1.10. Handling packages with security problems</a></span></dt>
7613: <dt><span class="sect2"><a href="#bumping-pkgrevision">18.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7614: <dt><span class="sect2"><a href="#fixes.subst">18.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7615: </dl></dd>
7616: <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>
7617: <dd><dl>
7618: <dt><span class="sect2"><a href="#no-plain-download">18.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7619: <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>
7620: </dl></dd>
7621: <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>
7622: <dd><dl>
7623: <dt><span class="sect2"><a href="#fixes.libtool">18.3.1. Shared libraries - libtool</a></span></dt>
7624: <dt><span class="sect2"><a href="#using-libtool">18.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7625: <dt><span class="sect2"><a href="#autoconf-automake">18.3.3. GNU Autoconf/Automake</a></span></dt>
7626: </dl></dd>
7627: <dt><span class="sect1"><a href="#programming-languages">18.4. Programming languages</a></span></dt>
7628: <dd><dl>
7629: <dt><span class="sect2"><a href="#basic-programming-languages">18.4.1. C, C++, and Fortran</a></span></dt>
7630: <dt><span class="sect2"><a href="#java-programming-language">18.4.2. Java</a></span></dt>
7631: <dt><span class="sect2"><a href="#perl-scripts">18.4.3. Packages containing perl scripts</a></span></dt>
7632: <dt><span class="sect2"><a href="#other-programming-languages">18.4.4. Other programming languages</a></span></dt>
7633: </dl></dd>
7634: <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>
7635: <dd><dl>
7636: <dt><span class="sect2"><a href="#fixes.build.cpp">18.5.1. Compiling C and C++ code conditionally</a></span></dt>
7637: <dt><span class="sect2"><a href="#compiler-bugs">18.5.2. How to handle compiler bugs</a></span></dt>
7638: <dt><span class="sect2"><a href="#undefined-reference">18.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7639: <dt><span class="sect2"><a href="#out-of-memory">18.5.4. Running out of memory</a></span></dt>
7640: </dl></dd>
7641: <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>
7642: <dd><dl>
7643: <dt><span class="sect2"><a href="#install-scripts">18.6.1. Creating needed directories</a></span></dt>
7644: <dt><span class="sect2"><a href="#where-to-install-documentation">18.6.2. Where to install documentation</a></span></dt>
1.100 rillig 7645: <dt><span class="sect2"><a href="#installing-score-files">18.6.3. Installing highscore files</a></span></dt>
1.103 wiz 7646: <dt><span class="sect2"><a href="#destdir-support">18.6.4. Adding DESTDIR support to packages</a></span></dt>
7647: <dt><span class="sect2"><a href="#hardcoded-paths">18.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7648: <dt><span class="sect2"><a href="#perl-modules">18.6.6. Packages installing perl modules</a></span></dt>
7649: <dt><span class="sect2"><a href="#faq.info-files">18.6.7. Packages installing info files</a></span></dt>
7650: <dt><span class="sect2"><a href="#manpages">18.6.8. Packages installing man pages</a></span></dt>
7651: <dt><span class="sect2"><a href="#gconf2-data-files">18.6.9. Packages installing GConf2 data files</a></span></dt>
7652: <dt><span class="sect2"><a href="#scrollkeeper-data-files">18.6.10. Packages installing scrollkeeper data files</a></span></dt>
7653: <dt><span class="sect2"><a href="#x11-fonts">18.6.11. Packages installing X11 fonts</a></span></dt>
7654: <dt><span class="sect2"><a href="#gtk2-modules">18.6.12. Packages installing GTK2 modules</a></span></dt>
7655: <dt><span class="sect2"><a href="#sgml-xml-data">18.6.13. Packages installing SGML or XML data</a></span></dt>
7656: <dt><span class="sect2"><a href="#mime-database">18.6.14. Packages installing extensions to the MIME database</a></span></dt>
7657: <dt><span class="sect2"><a href="#intltool">18.6.15. Packages using intltool</a></span></dt>
7658: <dt><span class="sect2"><a href="#startup-scripts">18.6.16. Packages installing startup scripts</a></span></dt>
7659: <dt><span class="sect2"><a href="#tex-packages">18.6.17. Packages installing TeX modules</a></span></dt>
7660: <dt><span class="sect2"><a href="#emulation-packages">18.6.18. Packages supporting running binaries in
1.87 wiz 7661: emulation</a></span></dt>
1.103 wiz 7662: <dt><span class="sect2"><a href="#hicolor-theme">18.6.19. Packages installing hicolor theme icons</a></span></dt>
7663: <dt><span class="sect2"><a href="#desktop-files">18.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7664: </dl></dd>
1.90 rillig 7665: <dt><span class="sect1"><a href="#punting">18.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7666: </dl>
7667: </div>
7668: <div class="sect1" lang="en">
7669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 7670: <a name="general-operation"></a>18.1. General operation</h2></div></div></div>
1.75 rillig 7671: <div class="sect2" lang="en">
7672: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7673: <a name="portability-of-packages"></a>18.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7674: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7675: different platforms. As a result, it is important to ensure,
7676: where possible, that packages in pkgsrc are portable. This
7677: chapter mentions some particular details you should pay
7678: attention to while working on pkgsrc.</p>
1.78 rillig 7679: </div>
7680: <div class="sect2" lang="en">
7681: <div class="titlepage"><div><div><h3 class="title">
1.104 ! rillig 7682: <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 7683: </h3></div></div></div>
1.78 rillig 7684: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7685: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.104 ! rillig 7686: which is <a href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7687: want to use those variables in the preprocessor directives of
7688: <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
7689: <code class="literal">.for</code>), you need to include the file
7690: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7691: loads the user preferences.</p>
1.78 rillig 7692: <p>But note that some variables may not be completely defined
1.87 wiz 7693: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7694: included, as they may contain references to variables that are
7695: not yet defined. In shell commands this is no problem, since
7696: variables are actually macros, which are only expanded when they
7697: are used. But in the preprocessor directives mentioned above and
7698: in dependency lines (of the form <code class="literal">target:
7699: dependencies</code>) the variables are expanded at load
7700: time.</p>
1.78 rillig 7701: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7702: <h3 class="title">Note</h3>
7703: <p>Currently there is no exhaustive list of all
1.87 wiz 7704: variables that tells you whether they can be used at load time
7705: or only at run time, but it is in preparation.</p>
1.78 rillig 7706: </div>
7707: </div>
7708: <div class="sect2" lang="en">
7709: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7710: <a name="user-interaction"></a>18.1.3. User interaction</h3></div></div></div>
1.88 wiz 7711: <p>Occasionally, packages require interaction from the user,
7712: and this can be in a number of ways:</p>
1.78 rillig 7713: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7714: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7715: interaction such as entering username/password or accepting a
7716: license on a web page.</p></li>
1.88 wiz 7717: <li><p>When extracting the distfiles, some packages may ask for
7718: passwords.</p></li>
1.78 rillig 7719: <li><p>help to configure the package before it is built</p></li>
7720: <li><p>help during the build process</p></li>
7721: <li><p>help during the installation of a package</p></li>
7722: </ul></div>
1.88 wiz 7723: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7724: provided to notify the pkgsrc mechanism of an interactive stage
7725: which will be needed, and this should be set in the package's
7726: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7727: <pre class="programlisting">
1.100 rillig 7728: INTERACTIVE_STAGE= build
1.87 wiz 7729: </pre>
1.78 rillig 7730: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7731: <pre class="programlisting">
1.100 rillig 7732: INTERACTIVE_STAGE= configure install
1.87 wiz 7733: </pre>
1.88 wiz 7734: <p>The user can then decide to skip this package by setting the
7735: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7736: </div>
7737: <div class="sect2" lang="en">
7738: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7739: <a name="handling-licenses"></a>18.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7740: <p>Authors of software can choose the licence under which
7741: software can be copied. This is due to copyright law, and reasons
7742: for license choices are outside the scope of pkgsrc. The pkgsrc
7743: system recognizes that there are a number of licenses which some
7744: users may find objectionable or difficult or impossible to comply
7745: with. The Free Software Foundation has declared some licenses
7746: "Free", and the Open Source Initiative has a definition of "Open
7747: Source". The pkgsrc system, as a policy choice, does not label
7748: packages which have licenses that are Free or Open Source.
7749: However, packages without a license meeting either of those tests
7750: are labeled with a license tag denoting the license. Note that a
7751: package with no license to copy trivially does not meet either the
7752: Free or Open Source test.</p>
7753: <p>For packages which are not Free or Open Source, pkgsrc will
7754: not build the package unless the user has indicated to pkgsrc that
7755: packages with that particular license may be built. Note that
7756: this documentation avoids the term "accepted the license". The
7757: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7758: accidentally building a package with a non-free license;
1.98 wiz 7759: judgement and responsibility remain with the user. (Installation
7760: of binary packages are not currently subject to this mechanism;
7761: this is a bug.)</p>
7762: <p>One might want to only install packages with a BSD license,
7763: or the GPL, and not the other. The pkgsrc license tag mechanism
7764: does not provide a way to do this. It might be possible to put in
7765: tags for free licenses, and have a default
7766: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7767: widely viewed as having a very poor ratio of benefit to
7768: work.</p>
1.78 rillig 7769: <p>The license tag mechanism is intended to address
1.87 wiz 7770: copyright-related issues surrounding building, installing and
7771: using a package, and not to address redistribution issues (see
7772: <code class="varname">RESTRICTED</code> and
7773: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7774: definition of licenses for which tags are not needed implies
7775: that packages with redistribution restrictions should have
1.98 wiz 7776: tags, because Free or Open Source programs do not have
7777: redistribution restrictions.</p>
7778: <p>Denoting that a package may be copied according to a
7779: particular license is done by placing the license in
1.87 wiz 7780: <code class="filename">pkgsrc/licenses</code> and setting the
7781: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7782: 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 7783: <pre class="programlisting">
1.100 rillig 7784: LICENSE= xv-license
1.87 wiz 7785: </pre>
7786: <p>When trying to build, the user will get a notice that the
1.98 wiz 7787: package is covered by a license which has not been placed in the
7788: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7789: <pre class="programlisting">
1.100 rillig 7790: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7791: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7792: ===> To view the license, enter "/usr/bin/make show-license".
7793: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7794: ===> ACCEPTABLE_LICENSES+=xv-license
7795: *** Error code 1
1.87 wiz 7796: </pre>
1.78 rillig 7797: <p>The license can be viewed with <span><strong class="command">make
1.98 wiz 7798: show-license</strong></span>, and if the user so chooses, the line
1.104 ! rillig 7799: printed above can be added to <a href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7800: convey to pkgsrc that it should not in the future fail because of
7801: that license:</p>
1.78 rillig 7802: <pre class="programlisting">
1.100 rillig 7803: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7804: </pre>
1.98 wiz 7805: <p>When adding a package with a new license, the license text
7806: should be added to <code class="filename">pkgsrc/licenses</code> for
7807: displaying. A list of known licenses can be seen in this
1.91 rillig 7808: directory.</p>
1.98 wiz 7809: <p>When the license changes (in a way other than formatting),
7810: please make sure that the new license has a different name (e.g.,
7811: append the version number if it exists, or the date). Just
7812: because a user told pkgsrc to build programs under a previous
7813: version of a license does not mean that pkgsrc should build
1.99 rillig 7814: programs under the new licenses. The higher-level point is that
1.98 wiz 7815: pkgsrc does not evaluate licenses for reasonableness; the only
7816: test is a mechanistic test of whether a particular text has been
7817: approved by either of two bodies.</p>
1.78 rillig 7818: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7819: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7820: is deprecated because it does not crisply refer to a particular
7821: license text. Another problem with such usage is that it does not
7822: enable a user to tell pkgsrc to proceed for a single package
7823: without also telling pkgsrc to proceed for all packages with that
7824: tag.</p>
1.75 rillig 7825: </div>
7826: <div class="sect2" lang="en">
7827: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7828: <a name="restricted-packages"></a>18.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7829: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7830: Because a license tag is required unless the package is Free or
7831: Open Source, all packages with restrictions should have license
7832: tags. By declaring the restrictions, package tools can
7833: automatically refrain from e.g. placing binary packages on FTP
7834: sites.</p>
7835: <p>There are four restrictions that may be encoded, which are
7836: the cross product of sources (distfiles) and binaries not being
7837: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7838: language in any license, and because non-Free licenses tend to be
7839: different from each other, pkgsrc adopts a definition of FTP and
7840: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7841: should not be made available over the Internet at no charge.
7842: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7843: made available on some kind of media, together with other source
7844: and binary packages, and which is sold for a distribution charge.
7845: </p>
7846: <p>In order to encode these restrictions, the package system
1.87 wiz 7847: defines five make variables that can be set to note these
7848: restrictions:</p>
1.75 rillig 7849: <div class="itemizedlist"><ul type="disc">
7850: <li>
7851: <p><code class="varname">RESTRICTED</code></p>
7852: <p>This variable should be set whenever a restriction
1.87 wiz 7853: exists (regardless of its kind). Set this variable to a
1.98 wiz 7854: string containing the reason for the restriction. It should
7855: be understood that those wanting to understand the restriction
7856: will have to read the license, and perhaps seek advice of
7857: counsel.</p>
1.75 rillig 7858: </li>
7859: <li>
7860: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7861: <p>Binaries may not be placed on CD-ROM containing other
7862: binary packages, for which a distribution charge may be made.
7863: In this case, set this variable to
7864: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7865: </li>
7866: <li>
7867: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7868: <p>Binaries may not made available on the Internet without
7869: charge. In this case, set this variable to
7870: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7871: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7872: </li>
7873: <li>
7874: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7875: <p>Distfiles may not be placed on CD-ROM, together with
7876: other distfiles, for which a fee may be charged. In this
7877: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7878: </p>
1.75 rillig 7879: </li>
7880: <li>
7881: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7882: <p>Distfiles may not made available via FTP at no charge.
7883: In this case, set this variable to
7884: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7885: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7886: </li>
7887: </ul></div>
7888: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7889: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7890: generic make variables to denote restrictions is deprecated,
7891: because they unconditionally prevent users from generating
7892: binary packages!</p>
1.75 rillig 7893: </div>
7894: <div class="sect2" lang="en">
7895: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 7896: <a name="dependencies"></a>18.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7897: <p>Your package may depend on some other package being present
1.88 wiz 7898: - and there are various ways of expressing this dependency.
7899: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7900: <code class="varname">DEPENDS</code> definitions, the
7901: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7902: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7903: to handle dependencies, and which uses the variables named above.
1.90 rillig 7904: See <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7905: <p>The basic difference between the two variables is as
1.87 wiz 7906: follows: The <code class="varname">DEPENDS</code> definition registers
7907: that pre-requisite in the binary package so it will be pulled in
7908: when the binary package is later installed, whilst the
7909: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7910: dependency that is only needed for building the package.</p>
1.75 rillig 7911: <p>This means that if you only need a package present whilst
1.87 wiz 7912: you are building, it should be noted as a
7913: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7914: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7915: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7916: <pre class="programlisting">
1.100 rillig 7917: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7918: </pre>
1.75 rillig 7919: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7920: may include any of the wildcard version numbers recognized by
7921: <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 7922: <div class="orderedlist"><ol type="1">
7923: <li>
7924: <p>If your package needs another package's binaries or
1.87 wiz 7925: libraries to build or run, and if that package has a
7926: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7927: <pre class="programlisting">
1.100 rillig 7928: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7929: </pre>
1.75 rillig 7930: </li>
7931: <li>
7932: <p>If your package needs to use another package to build
1.87 wiz 7933: itself and there is no <code class="filename">buildlink3.mk</code>
7934: file available, use the <code class="varname">BUILD_DEPENDS</code>
7935: definition:</p>
1.75 rillig 7936: <pre class="programlisting">
1.100 rillig 7937: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7938: </pre>
1.75 rillig 7939: </li>
7940: <li>
7941: <p>If your package needs a library with which to link and
1.76 rillig 7942: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7943: available, this is specified using the
7944: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7945: <pre class="programlisting">
1.100 rillig 7946: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7947: </pre>
1.75 rillig 7948: <p>You can also use wildcards in package dependences:</p>
7949: <pre class="programlisting">
1.100 rillig 7950: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7951: </pre>
1.75 rillig 7952: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7953: creating binary packages. The dependency is checked when
7954: installing the binary package and any package which matches
7955: the pattern will be used. Wildcard dependencies should be
7956: used with care.</p>
1.75 rillig 7957: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7958: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7959: such as “<span class="quote">tk-postgresql</span>” matching a
7960: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7961: <p>Wildcards can also be used to specify that a package
1.87 wiz 7962: will only build against a certain minimum version of a
7963: pre-requisite:</p>
1.75 rillig 7964: <pre class="programlisting">
1.100 rillig 7965: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7966: </pre>
1.75 rillig 7967: <p>This means that the package will build against version
1.87 wiz 7968: 3.5.4 of the tiff library or newer. Such a dependency may
7969: be warranted if, for example, the API of the library has
7970: changed with version 3.5.4 and a package would not compile
7971: against an earlier version of tiff.</p>
1.75 rillig 7972: <p>Please note that such dependencies should only be
1.87 wiz 7973: updated if a package requires a newer pre-requisite, but
1.93 rillig 7974: not to denote recommendations such as
1.87 wiz 7975: ABI changes that do not prevent a package from building
7976: correctly. Such recommendations can be expressed using
7977: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7978: <pre class="programlisting">
1.100 rillig 7979: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7980: </pre>
1.75 rillig 7981: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7982: line, this denotes that while a package will build against
7983: tiff>=3.5.4, at least version 3.6.1 is recommended.
7984: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7985: dependencies unless explicitly ignored (in which case a
7986: warning will be printed).</p>
1.75 rillig 7987: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7988: use the required <code class="varname">DEPENDS</code>, set
7989: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7990: it easier and faster to update packages built using pkgsrc,
7991: since older compatible dependencies can continue to be
7992: used. This is useful for people who watch their rebuilds
7993: very carefully; it is not very good as a general-purpose
7994: hammer. If you use it, you need to be mindful of possible
7995: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7996: <p>Packages that are built with recommendations ignored
1.87 wiz 7997: may not be uploaded to ftp.NetBSD.org by developers and
7998: should not be used across different systems that may have
7999: different versions of binary packages installed.</p>
1.75 rillig 8000: <p>For security fixes, please update the package
1.90 rillig 8001: 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 8002: information.</p>
1.75 rillig 8003: </li>
8004: <li>
8005: <p>If your package needs some executable to be able to run
1.87 wiz 8006: correctly and if there's no
8007: <code class="filename">buildlink3.mk</code> file, this is specified
8008: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 8009: <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 8010: be able to execute the latex binary from the teTeX package
8011: when it runs, and that is specified:</p>
1.75 rillig 8012: <pre class="programlisting">
1.100 rillig 8013: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 8014: </pre>
1.75 rillig 8015: <p>The comment about wildcard dependencies from previous
1.87 wiz 8016: paragraph applies here, too.</p>
1.75 rillig 8017: </li>
8018: </ol></div>
8019: <p>If your package needs files from another package to build,
1.87 wiz 8020: add the relevant distribution files to
8021: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 8022: 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 8023: (It relies on the jpeg sources being present in source form
8024: during the build.)</p>
1.75 rillig 8025: </div>
8026: <div class="sect2" lang="en">
8027: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8028: <a name="conflicts"></a>18.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 8029: <p>Your package may conflict with other packages a user might
1.87 wiz 8030: already have installed on his system, e.g. if your package
1.88 wiz 8031: installs the same set of files as another package in the pkgsrc
8032: tree.</p>
1.75 rillig 8033: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 8034: space-separated list of packages (including version string) your
8035: package conflicts with.</p>
1.91 rillig 8036: <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>
8037: 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 8038: install the same shared library, thus you set in
8039: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8040: <pre class="programlisting">
1.100 rillig 8041: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 8042: </pre>
8043: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 8044: <pre class="programlisting">
1.100 rillig 8045: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 8046: </pre>
1.75 rillig 8047: <p>Packages will automatically conflict with other packages
1.87 wiz 8048: with the name prefix and a different version
8049: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
8050: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 8051: </div>
8052: <div class="sect2" lang="en">
8053: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8054: <a name="not-building-packages"></a>18.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 8055: <p>There are several reasons why a package might be
1.88 wiz 8056: instructed to not build under certain circumstances. If the
1.87 wiz 8057: package builds and runs on most platforms, the exceptions
8058: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8059: the package builds and runs on a small handful of platforms,
8060: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8061: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8062: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8063: (OS-version-platform) that can use glob-style
8064: wildcards.</p>
1.88 wiz 8065: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 8066: 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 8067: backwards compatible with other versions of the OS, and should be
8068: uploaded to a version specific directory on the FTP server. Mark
8069: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8070: “<span class="quote">yes</span>”. This variable is not currently used by any of
8071: the package system internals, but may be used in the
8072: future.</p>
1.75 rillig 8073: <p>If the package should be skipped (for example, because it
1.87 wiz 8074: provides functionality already provided by the system), set
1.88 wiz 8075: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8076: the package should fail because some preconditions are not met,
8077: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 8078: message.</p>
1.75 rillig 8079: </div>
8080: <div class="sect2" lang="en">
8081: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8082: <a name="undeletable-packages"></a>18.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8083: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8084: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8085: be set in the package Makefile. This will be carried into any
8086: binary package that is made from this pkgsrc entry. A
8087: “<span class="quote">preserved</span>” package will
8088: 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
8089: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8090: </div>
8091: <div class="sect2" lang="en">
8092: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8093: <a name="security-handling"></a>18.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8094: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8095: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8096: and after committing that file, use <span><strong class="command">make upload</strong></span>
8097: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8098: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8099: <code class="varname">PKGREVISION</code> should be increased (this
8100: is of course not necessary if the problem is fixed by using
8101: a newer release of the software).</p>
1.75 rillig 8102: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8103: branch, be sure to submit a pullup request!</p>
1.75 rillig 8104: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8105: semi-automatically by a weekly cron job.</p>
1.75 rillig 8106: </div>
8107: <div class="sect2" lang="en">
8108: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8109: <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 8110: <p>When making fixes to an existing package it can be useful
1.87 wiz 8111: to change the version number in <code class="varname">PKGNAME</code>. To
8112: avoid conflicting with future versions by the original author, a
8113: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8114: on package versions by setting <code class="varname">PKGREVISION=1</code>
8115: (2, ...). The “<span class="quote">nb</span>” is treated like a
8116: “<span class="quote">.</span>” by the package tools. e.g.</p>
8117: <pre class="programlisting">
1.100 rillig 8118: DISTNAME= foo-17.42
8119: PKGREVISION= 9
1.87 wiz 8120: </pre>
1.75 rillig 8121: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8122: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8123: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8124: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8125: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8126: <p>When a new release of the package is released, the
1.87 wiz 8127: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8128: minor release of the above package, things should be like:</p>
1.75 rillig 8129: <pre class="programlisting">
1.100 rillig 8130: DISTNAME= foo-17.43
1.87 wiz 8131: </pre>
8132: <p><code class="varname">PKGREVISION</code> should be incremented for any
8133: non-trivial change in the resulting binary package. Without a
8134: <code class="varname">PKGREVISION</code> bump, someone with the previous
8135: version installed has no way of knowing that their package is out
8136: of date. Thus, changes without increasing
8137: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8138: trivial that no reasonable person would want to upgrade", and this
8139: is the rough test for when increasing
8140: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8141: changes that do not merit increasing
8142: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8143: <div class="itemizedlist"><ul type="disc">
8144: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8145: or comments in Makefile.</p></li>
8146: <li><p>
8147: Changing build variables if the resulting binary package is the same.</p></li>
8148: <li><p>
8149: Changing <code class="filename">DESCR</code>.</p></li>
8150: <li><p>
8151: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8152: </ul></div>
1.87 wiz 8153: <p>Examples of changes that do merit an increase to
8154: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8155: <div class="itemizedlist"><ul type="disc">
8156: <li><p>
8157: Security fixes</p></li>
8158: <li><p>
8159: Changes or additions to a patch file</p></li>
8160: <li><p>
8161: Changes to the <code class="filename">PLIST</code></p></li>
8162: </ul></div>
1.78 rillig 8163: <p>PKGREVISION must also be incremented when dependencies have ABI
8164: changes.</p>
1.75 rillig 8165: </div>
1.79 rillig 8166: <div class="sect2" lang="en">
8167: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8168: <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 8169: <p>When you want to replace the same text in multiple files
1.87 wiz 8170: or when the replacement text varies, patches alone cannot help.
8171: This is where the SUBST framework comes in. It provides an
8172: easy-to-use interface for replacing text in files.
8173: Example:</p>
8174: <pre class="programlisting">
1.100 rillig 8175: SUBST_CLASSES+= fix-paths
8176: SUBST_STAGE.fix-paths= pre-configure
8177: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8178: SUBST_FILES.fix-paths= src/*.c
8179: SUBST_FILES.fix-paths+= scripts/*.sh
8180: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8181: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8182: </pre>
1.79 rillig 8183: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8184: that are used to identify the different SUBST blocks that are
8185: defined. The SUBST framework is heavily used by pkgsrc, so it is
8186: important to always use the <code class="literal">+=</code> operator with
8187: this variable. Otherwise some substitutions may be
8188: skipped.</p>
1.79 rillig 8189: <p>The remaining variables of each SUBST block are
1.87 wiz 8190: parameterized with the identifier from the first line
8191: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8192: parameters to a function call.</p>
1.79 rillig 8193: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8194: which the replacement will take place. All combinations of
8195: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8196: <code class="literal">post-</code> together with a phase name are
8197: possible, though only few are actually used. Most commonly used
8198: are <code class="literal">post-patch</code> and
8199: <code class="literal">pre-configure</code>. Of these two,
8200: <code class="literal">pre-configure</code> should be preferred because
8201: then it is possible to run <span><strong class="command">bmake patch</strong></span> and
8202: have the state after applying the patches but before making any
8203: other changes. This is especially useful when you are debugging
8204: a package in order to create new patches for it. Similarly,
8205: <code class="literal">post-build</code> is preferred over
8206: <code class="literal">pre-install</code>, because the install phase should
8207: generally be kept as simple as possible. When you use
8208: <code class="literal">post-build</code>, you have the same files in the
8209: working directory that will be installed later, so you can check
8210: if the substitution has succeeded.</p>
1.79 rillig 8211: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8212: that is printed just before the substitution is done.</p>
1.79 rillig 8213: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8214: globbing patterns that specifies the files in which the
8215: substitution will take place. The patterns are interpreted
8216: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8217: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.87 wiz 8218: <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
8219: command should be prefixed with <code class="literal">-e</code>, so that
8220: all SUBST blocks look uniform.</p>
1.79 rillig 8221: <p>There are some more variables, but they are so seldomly
1.87 wiz 8222: used that they are only documented in the
8223: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8224: </div>
1.75 rillig 8225: </div>
8226: <div class="sect1" lang="en">
8227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8228: <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 8229: <div class="sect2" lang="en">
8230: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8231: <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 8232: <p>If you need to download from a dynamic URL you can set
1.87 wiz 8233: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span><strong class="command">make
8234: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8235: with the name of each file to download as an argument, expecting
8236: it to output the URL of the directory from which to download
1.91 rillig 8237: 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 8238: example of this usage.</p>
1.75 rillig 8239: <p>If the download can't be automated, because the user must
1.87 wiz 8240: submit personal information to apply for a password, or must pay
8241: for the source, or whatever, you can set
8242: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8243: displayed to the user before aborting the build. Example:</p>
8244: <pre class="programlisting">
1.100 rillig 8245: FETCH_MESSAGE= "Please download the files"
8246: FETCH_MESSAGE+= " "${DISTFILES:Q}
8247: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8248: </pre>
1.75 rillig 8249: </div>
8250: <div class="sect2" lang="en">
8251: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8252: <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 8253: <p>Sometimes authors of a software package make some
1.87 wiz 8254: modifications after the software was released, and they put up a
8255: new distfile without changing the package's version number. If a
8256: package is already in pkgsrc at that time, the checksum will
8257: no longer match. The contents of the new distfile should be
8258: compared against the old one before changing anything, to make
8259: sure the distfile was really updated on purpose, and that
8260: no trojan horse or so crept in.
1.97 rillig 8261: Please mention that the distfiles were compared and what was found
8262: in your commit message.
1.87 wiz 8263: Then, the correct way to work around this is to
8264: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8265: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8266: <code class="varname">DISTFILES</code> and
1.93 rillig 8267: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8268: subdirectory of the local distfiles directory.
8269: (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.)
8270: In case this
1.87 wiz 8271: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8272: including the <code class="filename">nbX</code> suffix) or a date stamp
8273: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8274: Do not forget regenerating the <code class="filename">distinfo</code> file
8275: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8276: path in the filenames.
1.97 rillig 8277: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8278: Furthermore, a mail to the package's authors seems appropriate
8279: telling them that changing distfiles after releases without
8280: changing the file names is not good practice.</p>
1.75 rillig 8281: </div>
8282: </div>
8283: <div class="sect1" lang="en">
8284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8285: <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 8286: <div class="sect2" lang="en">
8287: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8288: <a name="fixes.libtool"></a>18.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8289: <p>pkgsrc supports many different machines, with different
1.87 wiz 8290: object formats like a.out and ELF, and varying abilities to do
8291: shared library and dynamic loading at all. To accompany this,
8292: varying commands and options have to be passed to the
8293: compiler, linker, etc. to get the Right Thing, which can be
8294: pretty annoying especially if you don't have all the machines
8295: at your hand to test things. The
1.91 rillig 8296: <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 8297: can help here, as it just “<span class="quote">knows</span>” how to build
8298: both static and dynamic libraries from a set of source files,
8299: thus being platform-independent.</p>
8300: <p>Here's how to use libtool in a package in seven simple
8301: steps:</p>
1.75 rillig 8302: <div class="orderedlist"><ol type="1">
8303: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8304: Makefile.</p></li>
1.75 rillig 8305: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8306: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8307: add it to the definition of <code class="varname">CC</code>, if only
8308: libraries are being built in a given Makefile. This one command
8309: will build both PIC and non-PIC library objects, so you need not
8310: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8311: <li>
8312: <p>For the linking of the library, remove any
1.87 wiz 8313: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8314: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8315: <pre class="programlisting">
1.100 rillig 8316: ${LIBTOOL} --mode=link \
8317: ${CC} -o ${.TARGET:.a=.la} \
8318: ${OBJS:.o=.lo} \
8319: -rpath ${PREFIX}/lib \
8320: -version-info major:minor
1.87 wiz 8321: </pre>
1.75 rillig 8322: <p>Note that the library is changed to have a
1.87 wiz 8323: <code class="filename">.la</code> extension, and the objects are
8324: changed to have a <code class="filename">.lo</code>
8325: extension. Change <code class="varname">OBJS</code> as
8326: necessary. This automatically creates all of the
8327: <code class="filename">.a</code>,
8328: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8329: necessary) in the build directory. Be sure to include
8330: “<span class="quote">-version-info</span>”, especially when major and
8331: minor are zero, as libtool will otherwise strip off the
8332: shared library version.</p>
1.75 rillig 8333: <p>From the libtool manual:</p>
8334: <pre class="programlisting">
1.100 rillig 8335: So, libtool library versions are described by three integers:
1.69 rillig 8336:
1.100 rillig 8337: CURRENT
8338: The most recent interface number that this library implements.
1.69 rillig 8339:
1.100 rillig 8340: REVISION
8341: The implementation number of the CURRENT interface.
1.69 rillig 8342:
1.100 rillig 8343: AGE
8344: The difference between the newest and oldest interfaces that
8345: this library implements. In other words, the library implements
8346: all the interface numbers in the range from number `CURRENT -
8347: AGE' to `CURRENT'.
1.1 grant 8348:
1.100 rillig 8349: If two libraries have identical CURRENT and AGE numbers, then the
8350: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8351: </pre>
1.75 rillig 8352: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8353: different results for a.out and ELF (excluding symlinks)
8354: in only one case. An ELF library of the form
8355: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8356: will have a symlink of
8357: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8358: on an a.out platform. This is handled
8359: automatically.</p>
1.75 rillig 8360: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8361: directory of the library being built.</p>
1.76 rillig 8362: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8363: <code class="filename">.la</code> file, the other files will be
8364: added automatically.</p>
1.75 rillig 8365: </li>
8366: <li>
1.76 rillig 8367: <p>When linking shared object (<code class="filename">.so</code>)
1.87 wiz 8368: 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
8369: shared libraries, use “<span class="quote">-module
8370: -avoid-version</span>” to prevent them getting version
8371: tacked on.</p>
1.76 rillig 8372: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8373: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8374: </li>
8375: <li>
8376: <p>When linking programs that depend on these libraries
1.87 wiz 8377: <span class="emphasis"><em>before</em></span> they are installed, preface
8378: 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}
8379: --mode=link</span>”, and it will find the correct
8380: libraries (static or shared), but please be aware that
8381: libtool will not allow you to specify a relative path in
8382: -L (such as “<span class="quote">-L../somelib</span>”), because it
8383: expects you to change that argument to be the
8384: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8385: <pre class="programlisting">
1.100 rillig 8386: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8387: </pre>
1.75 rillig 8388: <p>should be changed to:</p>
8389: <pre class="programlisting">
1.100 rillig 8390: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8391: </pre>
1.75 rillig 8392: <p>and it will do the right thing with the libraries.</p>
8393: </li>
8394: <li>
8395: <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 8396: 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}
8397: --mode=install</span>”, and change the library name to
8398: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8399: <pre class="programlisting">
1.100 rillig 8400: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8401: </pre>
1.76 rillig 8402: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8403: shared library, any needed symlinks, and run
8404: <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 8405: </li>
1.76 rillig 8406: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8407: the <code class="filename">.la</code>
8408: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8409: </ol></div>
8410: </div>
8411: <div class="sect2" lang="en">
8412: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8413: <a name="using-libtool"></a>18.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8414: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8415: package Makefile. This will override the package's own libtool
8416: in most cases. For older libtool using packages, libtool is
8417: made by ltconfig script during the do-configure step; you can
8418: check the libtool script location by doing <span><strong class="command">make
8419: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8420: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8421: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8422: default, it is set to “<span class="quote">libtool */libtool
8423: */*/libtool</span>”. If this does not match the location of the
8424: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8425: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8426: libraries built and installed, then use
8427: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8428: <p>If your package makes use of the platform-independent library
1.87 wiz 8429: for loading dynamic shared objects, that comes with libtool
8430: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8431: <p>Some packages use libtool incorrectly so that the package
8432: may not work or build in some circumstances. Some of the more
8433: common errors are:</p>
1.75 rillig 8434: <div class="itemizedlist"><ul type="disc">
8435: <li>
8436: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8437: executable or library. This in itself isn't a problem if one of two things
8438: has been done:</p>
1.75 rillig 8439: <div class="orderedlist"><ol type="1">
8440: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8441: <code class="filename">libfoo.la</code>, not
8442: <code class="filename">foo.la</code></p></li>
1.75 rillig 8443: <li><p>The -dlopen option is used when linking an executable.</p></li>
8444: </ol></div>
8445: </li>
8446: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8447: The function lt_dlinit() should be called and the macro
8448: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8449: executables.</p></li>
1.75 rillig 8450: </ul></div>
8451: </div>
8452: <div class="sect2" lang="en">
8453: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8454: <a name="autoconf-automake"></a>18.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8455: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8456: to regenerate the configure script and Makefile.in makefile
8457: templates, then they should be executed in a pre-configure
8458: target.</p>
1.75 rillig 8459: <p>For packages that need only autoconf:</p>
8460: <pre class="programlisting">
1.100 rillig 8461: AUTOCONF_REQD= 2.50 # if default version is not good enough
8462: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8463: ...
1.1 grant 8464:
1.100 rillig 8465: pre-configure:
8466: cd ${WRKSRC} && autoconf
1.1 grant 8467:
1.100 rillig 8468: ...
1.87 wiz 8469: </pre>
1.75 rillig 8470: <p>and for packages that need automake and autoconf:</p>
8471: <pre class="programlisting">
1.100 rillig 8472: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8473: USE_TOOLS+= automake # use "automake14" for automake-1.4
8474: ...
8475:
8476: pre-configure:
8477: set -e; cd ${WRKSRC}; \
8478: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8479:
1.100 rillig 8480: ...
1.87 wiz 8481: </pre>
1.75 rillig 8482: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8483: require GNU Make.</p>
1.75 rillig 8484: <p>There are times when the configure process makes
1.87 wiz 8485: additional changes to the generated files, which then causes
8486: the build process to try to re-execute the automake sequence.
8487: This is prevented by touching various files in the configure
8488: stage. If this causes problems with your package you can set
8489: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8490: Makefile.</p>
1.75 rillig 8491: </div>
8492: </div>
8493: <div class="sect1" lang="en">
8494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8495: <a name="programming-languages"></a>18.4. Programming languages</h2></div></div></div>
1.87 wiz 8496: <div class="sect2" lang="en">
8497: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8498: <a name="basic-programming-languages"></a>18.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8499: <p>Compilers for the C, C++, and Fortran languages comes with
8500: the NetBSD base system. By default, pkgsrc assumes that a package
8501: is written in C and will hide all other compilers (via the wrapper
1.90 rillig 8502: framework, see <a href="#buildlink" title="Chapter 13. Buildlink methodology">Chapter 13, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8503: <p>To declare which language's compiler a package needs, set
8504: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8505: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8506: “<span class="quote">fortran</span>” (and any combination). The default is
8507: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8508: written in C++, usually need a C compiler for the configure
8509: phase.</p>
8510: </div>
8511: <div class="sect2" lang="en">
8512: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8513: <a name="java-programming-language"></a>18.4.2. Java</h3></div></div></div>
1.87 wiz 8514: <p>If a program is written in Java, use the Java framework in
8515: pkgsrc. The package must include
8516: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8517: provides the following variables:</p>
8518: <div class="itemizedlist"><ul type="disc">
8519: <li><p><code class="varname">USE_JAVA</code> defines if a build
8520: dependency on the JDK is added. If
8521: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8522: there is only a runtime dependency on the JDK. The default is
8523: “<span class="quote">yes</span>”, which also adds a build dependency on the
8524: JDK.</p></li>
8525: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8526: a package needs a Java2 implementation. The supported values
8527: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8528: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8529: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8530: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8531: above. This variable is not set by default.</p></li>
8532: </ul></div>
8533: </div>
8534: <div class="sect2" lang="en">
8535: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8536: <a name="perl-scripts"></a>18.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8537: <p>If your package contains interpreted perl scripts, add
8538: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8539: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8540: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8541: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8542: that you want adjusted. Every occurrence of
8543: <code class="filename">*/bin/perl</code> will be replaced with the full
8544: path to the perl executable.</p>
8545: <p>If a particular version of perl is needed, set the
8546: <code class="varname">PERL5_REQD</code> variable to the version number. The
8547: default is “<span class="quote">5.0</span>”.</p>
1.103 wiz 8548: <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 8549: about handling perl modules.</p>
8550: </div>
8551: <div class="sect2" lang="en">
8552: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8553: <a name="other-programming-languages"></a>18.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8554: <p>Currently, there is no special handling for other languages
8555: in pkgsrc. If a compiler package provides a
8556: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8557: just add a (build) dependency on the appropriate compiler
8558: package.</p>
8559: </div>
8560: </div>
8561: <div class="sect1" lang="en">
8562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8563: <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 8564: <p>The most common failures when building a package are that
8565: some platforms do not provide certain header files, functions or
8566: libraries, or they provide the functions in a library that the
8567: original package author didn't know. To work around this, you
8568: can rewrite the source code in most cases so that it does not
8569: use the missing functions or provides a replacement function.</p>
8570: <div class="sect2" lang="en">
8571: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8572: <a name="fixes.build.cpp"></a>18.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8573: <p>If a package already comes with a GNU configure script, the
8574: preferred way to fix the build failure is to change the
8575: configure script, not the code. In the other cases, you can
8576: utilize the C preprocessor, which defines certain macros
8577: depending on the operating system and hardware architecture it
8578: compiles for. These macros can be queried using for example
8579: <code class="varname">#if defined(__i386)</code>. Almost every operating
8580: system, hardware architecture and compiler has its own macro.
8581: For example, if the macros <code class="varname">__GNUC__</code>,
8582: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8583: are all defined, you know that you are using NetBSD on an i386
8584: compatible CPU, and your compiler is GCC.</p>
8585: <p>The list of the following macros for hardware and
8586: operating system depends on the compiler that is used. For
8587: example, if you want to conditionally compile code on Solaris,
8588: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8589: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8590: <div class="sect3" lang="en">
8591: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8592: <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 8593: <p>To distinguish between 4.4 BSD-derived systems and the
8594: rest of the world, you should use the following code.</p>
8595: <pre class="programlisting">
1.100 rillig 8596: #include <sys/param.h>
8597: #if (defined(BSD) && BSD >= 199306)
8598: /* BSD-specific code goes here */
8599: #else
8600: /* non-BSD-specific code goes here */
8601: #endif
1.75 rillig 8602: </pre>
1.77 rillig 8603: <p>If this distinction is not fine enough, you can also test
8604: for the following macros.</p>
1.75 rillig 8605: <pre class="programlisting">
1.100 rillig 8606: FreeBSD __FreeBSD__
8607: DragonFly __DragonFly__
8608: Interix __INTERIX
8609: IRIX __sgi (TODO: get a definite source for this)
8610: Linux linux, __linux, __linux__
8611: NetBSD __NetBSD__
8612: OpenBSD __OpenBSD__
8613: Solaris sun, __sun
1.75 rillig 8614: </pre>
8615: </div>
8616: <div class="sect3" lang="en">
8617: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8618: <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 8619: <pre class="programlisting">
1.100 rillig 8620: i386 i386, __i386, __i386__
8621: MIPS __mips
8622: SPARC sparc, __sparc
1.75 rillig 8623: </pre>
8624: </div>
8625: <div class="sect3" lang="en">
8626: <div class="titlepage"><div><div><h4 class="title">
1.90 rillig 8627: <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 8628: <pre class="programlisting">
1.100 rillig 8629: GCC __GNUC__ (major version), __GNUC_MINOR__
8630: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8631: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8632: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8633: </pre>
8634: </div>
8635: </div>
1.78 rillig 8636: <div class="sect2" lang="en">
8637: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8638: <a name="compiler-bugs"></a>18.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8639: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8640: combinations of compiler version and architecture and almost
8641: always relation to optimisation being enabled. Common symptoms
8642: are gcc internal errors or never finishing compiling a
1.78 rillig 8643: file.</p>
8644: <p>Typically, a workaround involves testing the
8645: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8646: optimisation for that combination of file,
8647: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8648: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8649: number of examples.</p>
8650: </div>
8651: <div class="sect2" lang="en">
8652: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8653: <a name="undefined-reference"></a>18.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8654: <p>This error message often means that a package did not
1.78 rillig 8655: link to a shared library it needs. The following functions are
8656: known to cause this error message over and over.</p>
8657: <div class="informaltable">
8658: <a name="undefined-reference-functions"></a><table border="1">
8659: <colgroup>
8660: <col>
8661: <col>
8662: <col>
8663: </colgroup>
8664: <thead><tr>
8665: <th>Function</th>
8666: <th>Library</th>
8667: <th>Affected platforms</th>
8668: </tr></thead>
8669: <tbody>
8670: <tr>
8671: <td>accept, bind, connect</td>
8672: <td>-lsocket</td>
8673: <td>Solaris</td>
8674: </tr>
8675: <tr>
8676: <td>crypt</td>
8677: <td>-lcrypt</td>
8678: <td>DragonFly, NetBSD</td>
8679: </tr>
8680: <tr>
8681: <td>dlopen, dlsym</td>
8682: <td>-ldl</td>
8683: <td>Linux</td>
8684: </tr>
8685: <tr>
8686: <td>gethost*</td>
8687: <td>-lnsl</td>
8688: <td>Solaris</td>
8689: </tr>
8690: <tr>
8691: <td>inet_aton</td>
8692: <td>-lresolv</td>
8693: <td>Solaris</td>
8694: </tr>
8695: <tr>
8696: <td>nanosleep, sem_*, timer_*</td>
8697: <td>-lrt</td>
8698: <td>Solaris</td>
8699: </tr>
8700: <tr>
8701: <td>openpty</td>
8702: <td>-lutil</td>
8703: <td>Linux</td>
8704: </tr>
8705: </tbody>
8706: </table>
8707: </div>
8708: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8709: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8710: -l<em class="replaceable"><code>foo</code></em></code> to the package
8711: <code class="filename">Makefile</code> and then say <span><strong class="command">bmake clean;
8712: bmake</strong></span>.</p>
1.92 rillig 8713: <div class="sect3" lang="en">
8714: <div class="titlepage"><div><div><h4 class="title">
8715: <a name="undefined-reference-sunpro"></a>18.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8716: <p>When you are using the SunPro compiler, there is another
8717: possibility. That compiler cannot handle the following code:</p>
8718: <pre class="programlisting">
1.100 rillig 8719: extern int extern_func(int);
1.93 rillig 8720:
1.100 rillig 8721: static inline int
8722: inline_func(int x)
8723: {
1.92 rillig 8724: return extern_func(x);
1.100 rillig 8725: }
1.93 rillig 8726:
1.100 rillig 8727: int main(void)
8728: {
1.92 rillig 8729: return 0;
1.100 rillig 8730: }
1.92 rillig 8731: </pre>
8732: <p>It generates the code for <code class="function">inline_func</code> even if
8733: that function is never used. This code then refers to
8734: <code class="function">extern_func</code>, which can usually not be resolved. To
8735: solve this problem you can try to tell the package to disable inlining
8736: of functions.</p>
8737: </div>
1.87 wiz 8738: </div>
8739: <div class="sect2" lang="en">
8740: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8741: <a name="out-of-memory"></a>18.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8742: <p>Sometimes packages fail to build because the compiler runs
8743: into an operating system specific soft limit. With the
8744: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8745: to unlimit the resources. Currently, the allowed values are
8746: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8747: Setting this variable is similar to running the shell builtin
8748: <span><strong class="command">ulimit</strong></span> command to raise the maximum data
8749: segment size or maximum stack size of a process, respectively, to
8750: their hard limits.</p>
1.78 rillig 8751: </div>
1.75 rillig 8752: </div>
8753: <div class="sect1" lang="en">
8754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 8755: <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 8756: <div class="sect2" lang="en">
8757: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8758: <a name="install-scripts"></a>18.6.1. Creating needed directories</h3></div></div></div>
1.78 rillig 8759: <p>The BSD-compatible <span><strong class="command">install</strong></span> supplied
1.87 wiz 8760: with some operating systems cannot create more than one
8761: directory at a time. As such, you should call
8762: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8763: <pre class="programlisting">
1.100 rillig 8764: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8765: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8766: </pre>
1.78 rillig 8767: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8768: dir2</code></span>” to the
8769: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8770: automatically do the right thing.</p>
1.75 rillig 8771: </div>
8772: <div class="sect2" lang="en">
8773: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 8774: <a name="where-to-install-documentation"></a>18.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8775: <p>In general, documentation should be installed into
1.87 wiz 8776: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8777: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8778: includes the version number of the package).</p>
1.84 wiz 8779: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8780: directory where HTML documentation is installed with the
8781: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8782: is needed because otherwise the documentation ends up in
8783: <code class="filename">${PREFIX}/share/doc/html</code> or other
8784: places.</p>
8785: <p>An exception to the above is that library API documentation
1.91 rillig 8786: 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 8787: browsers (devhelp) should be left at their default location, which
8788: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8789: documentation can be recognized from files ending in
8790: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8791: (It is also acceptable to install such files in
8792: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8793: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8794: <code class="filename">.devhelp*</code> file must be directly in that
8795: directory then, no additional subdirectory level is allowed in
8796: this case. This is usually achieved by using
8797: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8798: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8799: though.)</p>
1.75 rillig 8800: </div>
8801: <div class="sect2" lang="en">
8802: <div class="titlepage"><div><div><h3 class="title">
1.100 rillig 8803: <a name="installing-score-files"></a>18.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8804: <p>Certain packages, most of them in the games category, install
1.87 wiz 8805: a score file that allows all users on the system to record their
8806: highscores. In order for this to work, the binaries need to be
8807: installed setgid and the score files owned by the appropriate
8808: group and/or owner (traditionally the "games" user/group). The
8809: following variables, documented in more detail in
8810: <code class="filename">mk/defaults/mk.conf</code>, control this
8811: behaviour: <code class="varname">SETGIDGAME</code>,
8812: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8813: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8814: <p>Note that per default, setgid installation of games is
1.87 wiz 8815: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8816: the other variables accordingly.</p>
1.75 rillig 8817: <p>A package should therefor never hard code file ownership or
1.87 wiz 8818: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8819: <code class="varname">INSTALL_GAME_DATA</code> to set these
8820: correctly.</p>
1.75 rillig 8821: </div>
8822: <div class="sect2" lang="en">
8823: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8824: <a name="destdir-support"></a>18.6.4. Adding DESTDIR support to packages</h3></div></div></div>
8825: <div class="itemizedlist"><ul type="disc">
8826: <li><p>All installation operations have to be prefixed with
8827: <code class="filename">${DESTDIR}</code>.</p></li>
8828: <li><p>automake gets this DESTDIR mostly right
8829: automatically. Many manual rules and pre/post-install often are
8830: incorrect; fix them.</p></li>
8831: <li><p>If files are installed with special owner/group
8832: either use @owner/@group in the <code class="filename">PLIST</code>
8833: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8834: (discouraged). Note that @owner/@group are sticky during
8835: install, keep this in mind.</p></li>
8836: <li><p>In general, packages should support
8837: <code class="varname">UNPRIVILEGED</code> to be able to use
8838: DESTDIR.</p></li>
8839: </ul></div>
8840: </div>
8841: <div class="sect2" lang="en">
8842: <div class="titlepage"><div><div><h3 class="title">
8843: <a name="hardcoded-paths"></a>18.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8844: <p>Your package may also contain scripts with hardcoded paths to
8845: other interpreters besides (or as well as) perl. To correct the
8846: full pathname to the script interpreter, you need to set the
8847: following definitions in your <code class="filename">Makefile</code> (we
8848: shall use <span><strong class="command">tclsh</strong></span> in this example):</p>
8849: <pre class="programlisting">
1.100 rillig 8850: REPLACE_INTERPRETER+= tcl
8851: REPLACE.tcl.old= .*/bin/tclsh
8852: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8853: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8854: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8855: </pre>
1.75 rillig 8856: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8857: <h3 class="title">Note</h3>
8858: <p>Before March 2006, these variables were called
1.87 wiz 8859: <code class="varname">_REPLACE.*</code> and
8860: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8861: </div>
8862: </div>
8863: <div class="sect2" lang="en">
8864: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8865: <a name="perl-modules"></a>18.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8866: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8867: the Makefile fragment
8868: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
8869: <span><strong class="command">do-configure</strong></span> target for the standard perl
8870: configuration for such modules as well as various hooks to tune
8871: this configuration. See comments in this file for
8872: details.</p>
1.75 rillig 8873: <p>Perl5 modules will install into different places depending
1.87 wiz 8874: on the version of perl used during the build process. To
8875: address this, pkgsrc will append lines to the
8876: <code class="filename">PLIST</code> corresponding to the files listed in
8877: the installed <code class="filename">.packlist</code> file generated by
8878: most perl5 modules. This is invoked by defining
8879: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8880: paths to packlist files, e.g.:</p>
1.75 rillig 8881: <pre class="programlisting">
1.100 rillig 8882: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8883: </pre>
1.75 rillig 8884: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8885: <code class="varname">PERL5_SITEARCH</code>, and
8886: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8887: in which perl5 modules may be installed, and may be used by
8888: perl5 packages that don't have a packlist. These three
8889: variables are also substituted for in the
8890: <code class="filename">PLIST</code>.</p>
1.75 rillig 8891: </div>
8892: <div class="sect2" lang="en">
8893: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8894: <a name="faq.info-files"></a>18.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8895: <p>Some packages install info files or use the
1.87 wiz 8896: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8897: commands. <code class="varname">INFO_FILES</code> should be defined in
8898: the package Makefile so that <code class="filename">INSTALL</code> and
8899: <code class="filename">DEINSTALL</code> scripts will be generated to
8900: handle registration of the info files in the Info directory
8901: file. The “<span class="quote">install-info</span>” command used for the info
8902: files registration is either provided by the system, or by a
8903: special purpose package automatically added as dependency if
8904: needed.</p>
1.75 rillig 8905: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8906: <code class="filename">${PREFIX}</code> where info files are primarily
8907: located. <code class="varname">PKGINFODIR</code> defaults to
8908: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8909: <p>The info files for the package should be listed in the
1.87 wiz 8910: package <code class="filename">PLIST</code>; however any split info files
8911: need not be listed.</p>
1.75 rillig 8912: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8913: at build time must add “<span class="quote">makeinfo</span>” to
8914: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8915: version of the “<span class="quote">makeinfo</span>” command is needed it
8916: should be noted with the <code class="varname">TEXINFO_REQD</code>
8917: variable in the package <code class="filename">Makefile</code>. By
8918: default, a minimum version of 3.12 is required. If the system
8919: does not provide a <span><strong class="command">makeinfo</strong></span> command or if it
8920: does not match the required minimum, a build dependency on the
1.91 rillig 8921: <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 8922: be added automatically.</p>
1.75 rillig 8923: <p>The build and installation process of the software provided
1.87 wiz 8924: by the package should not use the
8925: <span><strong class="command">install-info</strong></span> command as the registration of
8926: info files is the task of the package
8927: <code class="filename">INSTALL</code> script, and it must use the
8928: appropriate <span><strong class="command">makeinfo</strong></span> command.</p>
1.75 rillig 8929: <p>To achieve this goal, the pkgsrc infrastructure creates
1.87 wiz 8930: overriding scripts for the <span><strong class="command">install-info</strong></span> and
8931: <span><strong class="command">makeinfo</strong></span> commands in a directory listed early
8932: in <code class="varname">PATH</code>.</p>
1.75 rillig 8933: <p>The script overriding <span><strong class="command">install-info</strong></span> has
1.87 wiz 8934: no effect except the logging of a message. The script overriding
8935: <span><strong class="command">makeinfo</strong></span> logs a message and according to the
8936: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8937: <span><strong class="command">makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8938: </div>
8939: <div class="sect2" lang="en">
8940: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8941: <a name="manpages"></a>18.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8942: <p>All packages that install manual pages should install them
1.87 wiz 8943: into the same directory, so that there is one common place to look
8944: for them. In pkgsrc, this place is
8945: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8946: should be used in packages. The default for
8947: <code class="varname">PKGMANDIR</code> is
8948: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8949: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8950: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8951: <h3 class="title">Note</h3>
1.87 wiz 8952: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8953: is far from complete.</p>
1.75 rillig 8954: </div>
1.81 rillig 8955: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8956: <code class="filename">man/</code> as the top level directory for the man
8957: page file entries, and the pkgsrc framework will convert as
8958: needed. In all other places, the correct
8959: <code class="varname">PKGMANDIR</code> must be used.</p>
8960: <p>Packages that are
8961: configured with <code class="varname">GNU_CONFIGURE</code> set as
8962: “<span class="quote">yes</span>”, by default will use the
8963: <code class="filename">./configure</code>
8964: --mandir switch to set where the man pages should be installed.
8965: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8966: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8967: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8968: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8969: to “<span class="quote">no</span>”.
8970: Or if the <code class="filename">./configure</code> script uses
8971: a non-standard use of --mandir, you can set
8972: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.90 rillig 8973: <p>See <a href="#manpage-compression" title="12.5. Man page compression">Section 12.5, “Man page compression”</a> for
1.87 wiz 8974: information on installation of compressed manual pages.</p>
1.75 rillig 8975: </div>
8976: <div class="sect2" lang="en">
8977: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 8978: <a name="gconf2-data-files"></a>18.6.9. Packages installing GConf2 data files</h3></div></div></div>
1.87 wiz 8979: <p>If a package installs <code class="filename">.schemas</code> or
8980: <code class="filename">.entries</code> files, used by GConf2,
8981: you need to take some extra steps to make sure they get registered
8982: in the database:</p>
1.75 rillig 8983: <div class="orderedlist"><ol type="1">
1.76 rillig 8984: <li><p>Include <code class="filename">../../devel/GConf2/schemas.mk</code>
1.87 wiz 8985: instead of its <code class="filename">buildlink3.mk</code> file. This
8986: takes care of rebuilding the GConf2 database at installation and
8987: deinstallation time, and tells the package where to install
8988: GConf2 data files using some standard configure arguments. It
8989: also disallows any access to the database directly from the
8990: package.</p></li>
1.75 rillig 8991: <li><p>Ensure that the package installs its
1.87 wiz 8992: <code class="filename">.schemas</code> files under
8993: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8994: installed under <code class="filename">${PREFIX}/etc</code>, you will
8995: need to manually patch the package.</p></li>
1.75 rillig 8996: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8997: directory, as they will be handled automatically. See
1.103 wiz 8998: <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 8999: <li><p>Define the <code class="varname">GCONF2_SCHEMAS</code> variable in
1.87 wiz 9000: your <code class="filename">Makefile</code> with a list of all
9001: <code class="filename">.schemas</code> files installed by the package, if
9002: any. Names must not contain any directories in them.</p></li>
1.75 rillig 9003: <li><p>Define the <code class="varname">GCONF2_ENTRIES</code> variable in
1.87 wiz 9004: your <code class="filename">Makefile</code> with a
9005: list of all <code class="filename">.entries</code> files installed by the
9006: package, if any. Names must not contain any directories in
9007: them.</p></li>
1.75 rillig 9008: </ol></div>
9009: </div>
9010: <div class="sect2" lang="en">
9011: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9012: <a name="scrollkeeper-data-files"></a>18.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 9013: <p>If a package installs <code class="filename">.omf</code> files, used by
9014: scrollkeeper, you need to take some extra steps to make sure they
9015: get registered in the database:</p>
1.75 rillig 9016: <div class="orderedlist"><ol type="1">
9017: <li><p>Include
1.87 wiz 9018: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
9019: instead of its <code class="filename">buildlink3.mk</code> file. This
9020: takes care of rebuilding the scrollkeeper database at
9021: installation and deinstallation time, and disallows any access
9022: to it directly from the package.</p></li>
1.75 rillig 9023: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9024: <code class="filename">libdata/scrollkeeper</code> directory, as they
9025: will be handled automatically.</p></li>
1.76 rillig 9026: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 9027: the PLIST. It will be handled by scrollkeeper.</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="x11-fonts"></a>18.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 9033: <p>If a package installs font files, you will need to rebuild
1.87 wiz 9034: the fonts database in the directory where they get installed at
9035: installation and deinstallation time. This can be automatically
9036: done by using the pkginstall framework.</p>
1.75 rillig 9037: <p>You can list the directories where fonts are installed in the
1.87 wiz 9038: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9039: variables, where <em class="replaceable"><code>type</code></em> can be one of
9040: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
9041: Also make sure that the database file
9042: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 9043: <p>Note that you should not create new directories for fonts;
1.87 wiz 9044: instead use the standard ones to avoid that the user needs to
9045: manually configure his X server to find them.</p>
1.75 rillig 9046: </div>
9047: <div class="sect2" lang="en">
9048: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9049: <a name="gtk2-modules"></a>18.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 9050: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 9051: take some extra steps to get them registered in the GTK2 database
9052: properly:</p>
1.75 rillig 9053: <div class="orderedlist"><ol type="1">
9054: <li><p>Include
1.87 wiz 9055: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9056: <code class="filename">buildlink3.mk</code> file. This takes care of
9057: rebuilding the database at installation and deinstallation time.</p></li>
9058: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9059: your package installs GTK2 immodules.</p></li>
9060: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9061: GTK2 loaders.</p></li>
1.75 rillig 9062: <li>
1.87 wiz 9063: <p>Patch the package to not touch any of the GTK2
9064: databases directly. These are:</p>
1.75 rillig 9065: <div class="itemizedlist"><ul type="disc">
1.76 rillig 9066: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9067: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 9068: </ul></div>
9069: </li>
1.87 wiz 9070: <li><p>Check the <code class="filename">PLIST</code> and remove
9071: any entries under the <code class="filename">libdata/gtk-2.0</code>
9072: directory, as they will be handled automatically.</p></li>
1.75 rillig 9073: </ol></div>
9074: </div>
9075: <div class="sect2" lang="en">
9076: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9077: <a name="sgml-xml-data"></a>18.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 9078: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 9079: registered in system-wide catalogs (like DTDs, sub-catalogs,
9080: etc.), you need to take some extra steps:</p>
1.75 rillig 9081: <div class="orderedlist"><ol type="1">
9082: <li><p>Include
1.87 wiz 9083: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9084: your <code class="filename">Makefile</code>, which takes care of
9085: registering those files in system-wide catalogs at
9086: installation and deinstallation time.</p></li>
1.75 rillig 9087: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9088: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9089: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9090: any XML catalogs installed by the package.</p></li>
1.75 rillig 9091: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9092: to be added to the SGML catalog. These come in groups of
9093: three strings; see xmlcatmgr(1) for more information
9094: (specifically, arguments recognized by the 'add' action).
9095: Note that you will normally not use this variable.</p></li>
1.75 rillig 9096: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9097: to be added to the XML catalog. These come in groups of three
9098: strings; see xmlcatmgr(1) for more information (specifically,
9099: arguments recognized by the 'add' action). Note that you will
9100: normally not use this variable.</p></li>
1.75 rillig 9101: </ol></div>
9102: </div>
9103: <div class="sect2" lang="en">
9104: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9105: <a name="mime-database"></a>18.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9106: <p>If a package provides extensions to the MIME database by
1.87 wiz 9107: installing <code class="filename">.xml</code> files inside
9108: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9109: need to take some extra steps to ensure that the database is kept
9110: consistent with respect to these new files:</p>
1.75 rillig 9111: <div class="orderedlist"><ol type="1">
9112: <li><p>Include
1.87 wiz 9113: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9114: (avoid using the <code class="filename">buildlink3.mk</code> file from
9115: this same directory, which is reserved for inclusion from
9116: other <code class="filename">buildlink3.mk</code> files). It takes
9117: care of rebuilding the MIME database at installation and
9118: deinstallation time, and disallows any access to it directly
9119: from the package.</p></li>
1.75 rillig 9120: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9121: <code class="filename">share/mime</code> directory,
9122: <span class="emphasis"><em>except</em></span> for files saved under
9123: <code class="filename">share/mime/packages</code>. The former are
9124: handled automatically by
9125: the update-mime-database program, but the latter are
9126: package-dependent and must be removed by the package that
9127: installed them in the first place.</p></li>
1.76 rillig 9128: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9129: from the PLIST. They will be handled by the shared-mime-info
9130: package.</p></li>
1.75 rillig 9131: </ol></div>
9132: </div>
9133: <div class="sect2" lang="en">
9134: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9135: <a name="intltool"></a>18.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9136: <p>If a package uses intltool during its build, add
9137: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9138: which forces it to use the intltool package provided by pkgsrc,
9139: instead of the one bundled with the distribution file.</p>
1.75 rillig 9140: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9141: latest available version; this way, the package benefits of any
9142: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9143: </div>
9144: <div class="sect2" lang="en">
9145: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9146: <a name="startup-scripts"></a>18.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9147: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9148: the startup directory by default, but you can enable it, by adding
9149: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.104 ! rillig 9150: <a href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9151: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9152: it will automatically remove the scripts when the package is
9153: deinstalled.</p>
1.75 rillig 9154: </div>
9155: <div class="sect2" lang="en">
9156: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9157: <a name="tex-packages"></a>18.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9158: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9159: the <code class="filename">ls-R</code> database of the tree needs to be
9160: updated.</p>
1.75 rillig 9161: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9162: <h3 class="title">Note</h3>
9163: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 9164: packages should install files
9165: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9166: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 9167: </div>
9168: <div class="orderedlist"><ol type="1">
9169: <li><p>Include
1.87 wiz 9170: <code class="filename">../../print/teTeX/module.mk</code> instead
9171: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9172: takes care of rebuilding the <code class="filename">ls-R</code>
9173: database at installation and deinstallation time.</p></li>
1.75 rillig 9174: <li>
9175: <p>If your package installs files into a texmf
1.87 wiz 9176: tree other than the one
9177: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9178: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9179: trees that need database update.</p>
1.75 rillig 9180: <p>If your package also installs font map files that need
1.87 wiz 9181: to be registered using <span><strong class="command">updmap</strong></span>,
9182: set <code class="varname">TEX_FONTMAPS</code> to the list of all
9183: such font map files. Then <span><strong class="command">updmap</strong></span> will
9184: be run automatically at installation/deinstallation to
9185: enable/disable font map files for TeX output
9186: drivers.</p>
1.75 rillig 9187: </li>
1.76 rillig 9188: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9189: databases are included in <code class="filename">PLIST</code>, as
9190: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9191: </ol></div>
9192: </div>
1.85 jmmv 9193: <div class="sect2" lang="en">
9194: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9195: <a name="emulation-packages"></a>18.6.18. Packages supporting running binaries in
1.87 wiz 9196: emulation</h3></div></div></div>
9197: <p>There are some packages that provide libraries and
9198: executables for running binaries from a one operating system
9199: on a different one (if the latter supports it). One example
9200: is running Linux binaries on NetBSD.</p>
1.91 rillig 9201: <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 9202: helps in extracting and packaging Linux rpm packages.</p>
9203: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9204: avoid the <span><strong class="command">check-shlibs</strong></span> target, which tests
9205: if all libraries for each installed executable can be found by
9206: the dynamic linker. Since the standard dynamic linker is run,
9207: this fails for emulation packages, because the libraries used
9208: by the emulation are not in the standard directories.</p>
9209: </div>
9210: <div class="sect2" lang="en">
9211: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9212: <a name="hicolor-theme"></a>18.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9213: <p>If a package installs images under the
1.87 wiz 9214: <code class="filename">share/icons/hicolor</code> and/or updates the
9215: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9216: database, you need to take some extra steps to make sure that the
9217: shared theme directory is handled appropriately and that the cache
9218: database is rebuilt:</p>
1.85 jmmv 9219: <div class="orderedlist"><ol type="1">
9220: <li><p>Include
1.87 wiz 9221: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9222: <li><p>Check the <code class="filename">PLIST</code> and remove the
9223: entry that refers to the theme cache.</p></li>
1.85 jmmv 9224: <li><p>Ensure that the PLIST does not remove the shared icon
9225: directories from the <code class="filename">share/icons/hicolor</code>
9226: hierarchy because they will be handled automatically.</p></li>
9227: </ol></div>
9228: <p>The best way to verify that the PLIST is correct with
9229: respect to the last two points is to regenerate it using
9230: <span><strong class="command">make print-PLIST</strong></span>.</p>
9231: </div>
9232: <div class="sect2" lang="en">
9233: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 9234: <a name="desktop-files"></a>18.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9235: <p>If a package installs <code class="filename">.desktop</code> files
9236: under <code class="filename">share/applications</code> and these include
9237: MIME information, you need to take extra steps to ensure that they
9238: are registered into the MIME database:</p>
9239: <div class="orderedlist"><ol type="1">
9240: <li><p>Include
9241: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9242: <li><p>Check the PLIST and remove the entry that refers to the
9243: <code class="filename">share/applications/mimeinfo.cache</code> file.
9244: It will be handled automatically.</p></li>
9245: </ol></div>
9246: <p>The best way to verify that the PLIST is correct with
9247: respect to the last point is to regenerate it using <span><strong class="command">make
9248: print-PLIST</strong></span>.</p>
1.75 rillig 9249: </div>
9250: </div>
1.87 wiz 9251: <div class="sect1" lang="en">
9252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9253: <a name="punting"></a>18.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9254: <p>In some cases one does not have the time to solve a problem
9255: immediately. There are currently two ways to declare that one knows
9256: that a package has problems.</p>
9257: <div class="itemizedlist"><ul type="disc">
9258: <li><p>The first way is to plainly mark it as broken. For
9259: this, one just sets the variable <code class="varname">BROKEN</code> to the
9260: reason why the package is broken (similar to the
9261: <code class="varname">RESTRICTED</code> variable). A user trying to build
9262: the package will immediately be shown this message, and the build
9263: will not be even tried.</p></li>
9264: <li><p>After each pkgsrc freeze period (a time when the
9265: tree is stabilized and a new pkgsrc branch is cut), the packages
9266: that were not building in the official branch build on the latest
9267: NetBSD release will be marked as broken on that branch. This is
9268: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9269: branch name (or appending the branch name to it). If a user tries
9270: to build such a package and the build fails, the user gets a
9271: message that says that the package was broken on the respective
9272: branch(es).</p></li>
9273: </ul></div>
9274: <p>Both types of packages are removed from pkgsrc in irregular
9275: intervals.</p>
9276: </div>
1.75 rillig 9277: </div>
9278: <div class="chapter" lang="en">
9279: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9280: <a name="debug"></a>Chapter 19. Debugging</h2></div></div></div>
1.88 wiz 9281: <p>To check out all the gotchas when building a package, here are
9282: the steps that I do in order to get a package working. Please note
9283: this is basically the same as what was explained in the previous
9284: sections, only with some debugging aids.</p>
1.75 rillig 9285: <div class="itemizedlist"><ul type="disc">
1.104 ! rillig 9286: <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 9287: <li>
1.91 rillig 9288: <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 9289: create a directory for a new package, change into it, then run
9290: <span><strong class="command">url2pkg</strong></span>:</p>
1.75 rillig 9291: <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>
9292: <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>
9293: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9294: </li>
1.76 rillig 9295: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9296: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.87 wiz 9297: <li><p>Run <span><strong class="command">make configure</strong></span></p></li>
1.75 rillig 9298: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9299: configure step to the package's
9300: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9301: <li>
9302: <p>Make the package compile, doing multiple rounds of</p>
9303: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9304: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9305: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9306: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9307: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9308: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9309: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9310: <p>Doing this step as non-root user will ensure that no files
9311: are modified that shouldn't be, especially during the build
9312: phase. <span><strong class="command">mkpatches</strong></span>,
9313: <span><strong class="command">patchdiff</strong></span> and <span><strong class="command">pkgvi</strong></span> are
1.91 rillig 9314: 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 9315: package.</p>
1.75 rillig 9316: </li>
1.88 wiz 9317: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.90 rillig 9318: necessary; see <a href="#components.Makefile" title="10.1. Makefile">Section 10.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9319: <li>
1.76 rillig 9320: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9321: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9322: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9323: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9324: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9325: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9326: <p>You usually need to be <code class="username">root</code> to do
9327: this. Look if there are any files left:</p>
1.75 rillig 9328: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9329: <p>If this reveals any files that are missing in
1.88 wiz 9330: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9331: </li>
9332: <li>
1.88 wiz 9333: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9334: package again and make a binary package:</p>
1.75 rillig 9335: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9336: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9337: </li>
9338: <li>
9339: <p>Delete the installed package:</p>
1.88 wiz 9340: <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 9341: </li>
9342: <li>
1.88 wiz 9343: <p>Repeat the above <span><strong class="command">make print-PLIST</strong></span>
9344: command, which shouldn't find anything now:</p>
1.75 rillig 9345: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9346: </li>
9347: <li>
9348: <p>Reinstall the binary package:</p>
1.93 rillig 9349: <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 9350: </li>
1.88 wiz 9351: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9352: <li>
1.91 rillig 9353: <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 9354: reports:</p>
1.75 rillig 9355: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9356: </li>
1.90 rillig 9357: <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 9358: </ul></div>
9359: </div>
9360: <div class="chapter" lang="en">
9361: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9362: <a name="submit"></a>Chapter 20. Submitting and Committing</h2></div></div></div>
1.75 rillig 9363: <div class="toc">
9364: <p><b>Table of Contents</b></p>
9365: <dl>
1.90 rillig 9366: <dt><span class="sect1"><a href="#submitting-binary-packages">20.1. Submitting binary packages</a></span></dt>
9367: <dt><span class="sect1"><a href="#submitting-your-package">20.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9368: <dt><span class="sect1"><a href="#general-notes-for-changes">20.3. General notes when adding, updating, or removing packages</a></span></dt>
9369: <dt><span class="sect1"><a href="#committing-importing">20.4. Committing: Importing a package into CVS</a></span></dt>
9370: <dt><span class="sect1"><a href="#updating-package">20.5. Updating a package to a newer version</a></span></dt>
9371: <dt><span class="sect1"><a href="#moving-package">20.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9372: </dl>
9373: </div>
9374: <div class="sect1" lang="en">
9375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9376: <a name="submitting-binary-packages"></a>20.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9377: <p>Our policy is that we accept binaries only from pkgsrc
9378: developers to guarantee that the packages don't contain any
9379: trojan horses etc. This is not to annoy anyone but rather to
9380: protect our users! You're still free to put up your home-made
9381: binary packages and tell the world where to get them. NetBSD
9382: developers doing bulk builds and wanting to upload them please
9383: 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>
9384: </div>
9385: <div class="sect1" lang="en">
9386: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9387: <a name="submitting-your-package"></a>20.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9388: <p>First, check that your package is complete, compiles and
1.90 rillig 9389: runs well; see <a href="#debug" title="Chapter 19. Debugging">Chapter 19, <i>Debugging</i></a> and the rest of this
1.75 rillig 9390: 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 9391: archive that contains all files that make up the package.
1.87 wiz 9392: Finally, send this package to the pkgsrc bug tracking system,
9393: 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
9394: that, go to the web page
1.103 wiz 9395: <a href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87 wiz 9396: which contains some instructions and a link to a form, where you
9397: can submit packages.</p>
9398: <p>In the form of the problem report, the category should be
9399: “<span class="quote">pkg</span>”, the synopsis should include the package name
9400: and version number, and the description field should contain a
9401: short description of your package (contents of the COMMENT
9402: variable or DESCR file are OK). The uuencoded package data should
9403: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9404: <p>If you want to submit several packages, please send a
9405: separate PR for each one, it's easier for us to track things
9406: that way.</p>
9407: <p>Alternatively, you can also import new packages into
9408: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
9409: homepage at <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9410: for details.</p>
9411: </div>
9412: <div class="sect1" lang="en">
9413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9414: <a name="general-notes-for-changes"></a>20.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9415: <p>Please note all package additions, updates, moves, and
1.93 rillig 9416: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9417: important to keep this file up to date and conforming to the
9418: existing format, because it will be used by scripts to
9419: automatically update pages on <a href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9420: sites. Additionally, check the
1.76 rillig 9421: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9422: for the package you updated or removed, in case it was mentioned
9423: there.</p>
9424: <p>When the <code class="varname">PKGREVISION</code> of a package is
9425: bumped, the change should appear in
1.93 rillig 9426: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9427: related or otherwise relevant. Mass bumps that result from a
9428: dependency being updated should not be mentioned. In all other
9429: cases it's the developer's decision.</p>
9430: <p>There is a make target that helps in creating proper
1.93 rillig 9431: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span><strong class="command">make
1.75 rillig 9432: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9433: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9434: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9435: file is up-to-date (to avoid having to resolve conflicts later-on)
9436: and then to <span><strong class="command">cd</strong></span> to the package directory. For
9437: package updates, <span><strong class="command">make changes-entry</strong></span> is enough.
9438: For new packages, or package moves or removals, set the
9439: <code class="varname">CTYPE</code> variable on the command line to "Added",
9440: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.104 ! rillig 9441: in <a href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75 rillig 9442: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9443: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9444: </div>
9445: <div class="sect1" lang="en">
9446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9447: <a name="committing-importing"></a>20.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9448: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9449: access to the pkgsrc repository. Please remember that cvs
9450: imports files relative to the current working directory, and that
9451: the pathname that you
9452: give the <span><strong class="command">cvs import</strong></span> command is so that it knows where
9453: to place the files in the repository. Newly created packages should be
9454: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9455: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9456: <pre class="programlisting">
1.100 rillig 9457: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9458: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9459: </pre>
1.87 wiz 9460: <p>Remember to move the directory from which you imported out of
1.75 rillig 9461: the way, or cvs will complain the next time you “<span class="quote">cvs
9462: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9463: package to the category's <code class="filename">Makefile</code>.</p>
9464: <p>The commit message of the initial import should include part of the
1.76 rillig 9465: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9466: what the package is/does.</p>
9467: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9468: add</span>” because the former gets everything with a single command,
1.87 wiz 9469: and provides a consistent tag.</p>
1.75 rillig 9470: </div>
9471: <div class="sect1" lang="en">
9472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9473: <a name="updating-package"></a>20.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9474: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9475: changes between old and new versions into the commit log when updating
1.87 wiz 9476: a package. There are various reasons for this:</p>
1.75 rillig 9477: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9478: <li><p>A URL is volatile, and can change over time. It may go away completely
9479: or its information may be overwritten by newer information.</p></li>
9480: <li><p>Having the change information between old and new versions in our CVS
9481: repository is very useful for people who use either cvs or anoncvs.</p></li>
9482: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9483: repository is very useful for people who read the pkgsrc-changes mailing
9484: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9485: the package.</p></li>
1.75 rillig 9486: </ul></div>
1.87 wiz 9487: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9488: has been released, it should not automatically be upgraded in the CVS
9489: repository. We prefer to be conservative in the packages that are
9490: included in pkgsrc - development or beta packages are not really the
9491: best thing for most places in which pkgsrc is used. Please use your
9492: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9493: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9494: </div>
9495: <div class="sect1" lang="en">
9496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9497: <a name="moving-package"></a>20.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9498: <div class="orderedlist"><ol type="1">
9499: <li><p>Make a copy of the directory somewhere else.</p></li>
9500: <li>
9501: <p>Remove all CVS dirs.</p>
1.87 wiz 9502: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9503: <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 9504: <p>and use that for further work.</p>
1.75 rillig 9505: </li>
9506: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9507: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9508: instead of “<span class="quote">../../category/package</span>”.</p></li>
9509: <li><p><span><strong class="command">cvs import</strong></span> the modified package in the new
9510: place.</p></li>
9511: <li>
9512: <p>Check if any package depends on it:
9513: </p>
9514: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9515: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9516: </li>
9517: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
9518: <li><p><span><strong class="command">cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9519: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9520: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9521: <li>
9522: <p>Commit the changed and removed files:</p>
9523: <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 9524: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9525: </li>
9526: </ol></div>
9527: </div>
9528: </div>
9529: <div class="chapter" lang="en">
9530: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9531: <a name="devfaq"></a>Chapter 21. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9532: <p>This section contains the answers to questions that may
9533: arise when you are writing a package. If you don't find your
9534: question answered here, first have a look in the other chapters,
9535: and if you still don't have the answer, ask on the
9536: <code class="literal">pkgsrc-users</code> mailing list.</p>
9537: <div class="qandaset">
9538: <dl>
1.93 rillig 9539: <dt>21.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9540: MAKEFLAGS, .MAKEFLAGS and
9541: MAKE_FLAGS?</a>
9542: </dt>
1.93 rillig 9543: <dt>21.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9544: MAKE, GMAKE and
9545: MAKE_PROGRAM?</a>
9546: </dt>
1.93 rillig 9547: <dt>21.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9548: CC, PKG_CC and
9549: PKGSRC_COMPILER?</a>
9550: </dt>
1.93 rillig 9551: <dt>21.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9552: BUILDLINK_LDFLAGS,
9553: BUILDLINK_LDADD and
9554: BUILDLINK_LIBS?</a>
9555: </dt>
1.93 rillig 9556: <dt>21.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9557: VARNAME=BUILDLINK_PREFIX.foo
9558: say it's empty?</a>
9559: </dt>
1.93 rillig 9560: <dt>21.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9561: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9562: don't understand the := inside
9563: it.</a>
9564: </dt>
1.93 rillig 9565: <dt>21.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9566: developers?</a>
9567: </dt>
1.93 rillig 9568: <dt>21.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9569: documentation?</a>
9570: </dt>
1.92 rillig 9571: <dt>21.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
9572: do?</a>
9573: </dt>
1.75 rillig 9574: </dl>
9575: <table border="0" summary="Q and A Set">
9576: <col align="left" width="1%">
9577: <tbody>
9578: <tr class="question">
9579: <td align="left" valign="top">
1.104 ! rillig 9580: <a name="devfaq.makeflags"></a><a name="id2714146"></a><b>21.1.</b>
1.75 rillig 9581: </td>
9582: <td align="left" valign="top"><p>What is the difference between
9583: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9584: <code class="varname">MAKE_FLAGS</code>?</p></td>
9585: </tr>
9586: <tr class="answer">
1.91 rillig 9587: <td align="left" valign="top"></td>
1.75 rillig 9588: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9589: 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
9590: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9591: the <code class="varname">MAKE_PROGRAM</code> when building the
9592: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9593: </tr>
9594: <tr class="question">
9595: <td align="left" valign="top">
1.104 ! rillig 9596: <a name="devfaq.make"></a><a name="id2714184"></a><b>21.2.</b>
1.75 rillig 9597: </td>
9598: <td align="left" valign="top"><p>What is the difference between
9599: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9600: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9601: </tr>
9602: <tr class="answer">
1.91 rillig 9603: <td align="left" valign="top"></td>
1.75 rillig 9604: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9605: <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
9606: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9607: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9608: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9609: Make program that is used for building the
9610: package.</p></td>
9611: </tr>
9612: <tr class="question">
9613: <td align="left" valign="top">
1.104 ! rillig 9614: <a name="devfaq.cc"></a><a name="id2714225"></a><b>21.3.</b>
1.75 rillig 9615: </td>
9616: <td align="left" valign="top"><p>What is the difference between
9617: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9618: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9619: </tr>
9620: <tr class="answer">
1.91 rillig 9621: <td align="left" valign="top"></td>
1.75 rillig 9622: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9623: compiler, which can be configured by the pkgsrc user.
9624: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9625: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9626: path to a compiler, but the type of compiler that should be
1.76 rillig 9627: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9628: information about the latter variable.</p></td>
9629: </tr>
9630: <tr class="question">
9631: <td align="left" valign="top">
1.104 ! rillig 9632: <a name="devfaq.bl3flags"></a><a name="id2714264"></a><b>21.4.</b>
1.75 rillig 9633: </td>
9634: <td align="left" valign="top"><p>What is the difference between
9635: <code class="varname">BUILDLINK_LDFLAGS</code>,
9636: <code class="varname">BUILDLINK_LDADD</code> and
9637: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9638: </tr>
9639: <tr class="answer">
1.91 rillig 9640: <td align="left" valign="top"></td>
1.75 rillig 9641: <td align="left" valign="top"><p>[FIXME]</p></td>
9642: </tr>
9643: <tr class="question">
9644: <td align="left" valign="top">
1.104 ! rillig 9645: <a name="devfaq.bl3prefix"></a><a name="id2714353"></a><b>21.5.</b>
1.75 rillig 9646: </td>
9647: <td align="left" valign="top"><p>Why does <span><strong class="command">make show-var
9648: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9649: say it's empty?</p></td>
9650: </tr>
9651: <tr class="answer">
1.91 rillig 9652: <td align="left" valign="top"></td>
1.75 rillig 9653: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9654: available in the “<span class="quote">wrapper</span>” phase and later. To
9655: “<span class="quote">simulate</span>” the wrapper phase, append
9656: <span><strong class="command">PKG_PHASE=wrapper</strong></span> to the above
9657: command.</p></td>
9658: </tr>
1.78 rillig 9659: <tr class="question">
9660: <td align="left" valign="top">
1.104 ! rillig 9661: <a name="devfaq.master_sites"></a><a name="id2714382"></a><b>21.6.</b>
1.78 rillig 9662: </td>
9663: <td align="left" valign="top"><p>What does
9664: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9665: don't understand the <code class="literal">:=</code> inside
9666: it.</p></td>
9667: </tr>
9668: <tr class="answer">
1.91 rillig 9669: <td align="left" valign="top"></td>
1.78 rillig 9670: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9671: assignment operator, like you might expect at first sight.
9672: Instead, it is a degenerate form of
9673: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9674: 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
9675: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9676: case of <code class="varname">MASTER_SITE_*</code>,
9677: <em class="replaceable"><code>old_string</code></em> is the empty string and
9678: <em class="replaceable"><code>new_string</code></em> is
9679: <code class="literal">package/</code>. That's where the
9680: <code class="literal">:</code> and the <code class="literal">=</code> fall
9681: together.</p></td>
9682: </tr>
9683: <tr class="question">
9684: <td align="left" valign="top">
1.104 ! rillig 9685: <a name="devfaq.mailinglists"></a><a name="id2714459"></a><b>21.7.</b>
1.78 rillig 9686: </td>
9687: <td align="left" valign="top"><p>Which mailing lists are there for package
9688: developers?</p></td>
9689: </tr>
9690: <tr class="answer">
1.91 rillig 9691: <td align="left" valign="top"></td>
1.78 rillig 9692: <td align="left" valign="top"><div class="variablelist"><dl>
1.103 wiz 9693: <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 9694: <dd><p>This is a list for technical discussions related
9695: to pkgsrc development, e.g. soliciting feedback for changes to
9696: pkgsrc infrastructure, proposed new features, questions related
9697: to porting pkgsrc to a new platform, advice for maintaining a
9698: package, patches that affect many packages, help requests moved
9699: from pkgsrc-users when an infrastructure bug is found,
9700: etc.</p></dd>
1.103 wiz 9701: <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 9702: <dd><p>All bug reports in category "pkg" sent with
9703: <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
9704: directly; use one of the other mailing
9705: lists.</p></dd>
9706: </dl></div></td>
9707: </tr>
1.80 rillig 9708: <tr class="question">
9709: <td align="left" valign="top">
1.104 ! rillig 9710: <a name="devfaq.documentation"></a><a name="id2714498"></a><b>21.8.</b>
1.80 rillig 9711: </td>
9712: <td align="left" valign="top"><p>Where is the pkgsrc
9713: documentation?</p></td>
9714: </tr>
9715: <tr class="answer">
1.91 rillig 9716: <td align="left" valign="top"></td>
1.80 rillig 9717: <td align="left" valign="top">
9718: <p>There are many places where you can find
9719: documentation about pkgsrc:</p>
9720: <div class="itemizedlist"><ul type="disc">
9721: <li><p>The pkgsrc guide (this document) is a collection
9722: of chapters that explain large parts of pkgsrc, but some
9723: chapters tend to be outdated. Which ones they are is hard to
9724: say.</p></li>
9725: <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
9726: about certain features, announcements of new parts of the pkgsrc
9727: infrastructure and sometimes even announcements that a certain
9728: feature has been marked as obsolete. The benefit here is that
9729: each message has a date appended to it.</p></li>
9730: <li><p>Many of the files in the
9731: <code class="filename">mk/</code> directory start with a comment that
9732: describes the purpose of the file and how it can be used by the
1.92 rillig 9733: pkgsrc user and package authors. An easy way to find this
9734: documentation is to run <span><strong class="command">bmake
9735: help</strong></span>.</p></li>
1.80 rillig 9736: <li><p>The CVS log messages are a rich source of
9737: information, but they tend to be highly abbreviated, especially
9738: for actions that occur often. Some contain a detailed
9739: description of what has changed, but they are geared towards the
9740: other pkgsrc developers, not towards an average pkgsrc user.
9741: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9742: don't know what has been before, these messages may not be worth
9743: too much to you.</p></li>
9744: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9745: documented</span>”, that is the documentation exists only in the
9746: mind of the developer who wrote the code. To get this
1.93 rillig 9747: information, use the <span><strong class="command">cvs annotate</strong></span> command
1.80 rillig 9748: to see who has written it and ask on the
9749: <code class="literal">tech-pkg</code> mailing list, so that others can
9750: find your questions later (see above). To be sure that the
9751: developer in charge reads the mail, you may CC him or
9752: her.</p></li>
9753: </ul></div>
9754: </td>
9755: </tr>
1.92 rillig 9756: <tr class="question">
9757: <td align="left" valign="top">
1.104 ! rillig 9758: <a name="devfaq.too-much-time"></a><a name="id2714628"></a><b>21.9.</b>
1.92 rillig 9759: </td>
9760: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9761: do?</p></td>
9762: </tr>
9763: <tr class="answer">
9764: <td align="left" valign="top"></td>
9765: <td align="left" valign="top">
1.93 rillig 9766: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9767: anyway.</p>
9768: <div class="itemizedlist"><ul type="disc">
9769: <li><p>Run <span><strong class="command">pkg_chk -N</strong></span> (from the
9770: <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
9771: will tell you about newer versions of installed packages that are
9772: available, but not yet updated in pkgsrc.</p></li>
9773: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.104 ! rillig 9774: — it contains a list of suggested new packages and a list of
1.92 rillig 9775: cleanups and enhancements for pkgsrc that would be nice to
9776: have.</p></li>
9777: <li><p>Review packages for which review was requested on
9778: the <a href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9779: mailing list.</p></li>
9780: </ul></div>
9781: </td>
9782: </tr>
1.75 rillig 9783: </tbody>
9784: </table>
9785: </div>
9786: </div>
1.85 jmmv 9787: <div class="chapter" lang="en">
9788: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 9789: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9790: <div class="toc">
9791: <p><b>Table of Contents</b></p>
9792: <dl>
1.90 rillig 9793: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
9794: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
9795: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
9796: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
1.85 jmmv 9797: </dl>
9798: </div>
9799: <p>Quoting <a href="http://www.gnome.org/" target="_top">GNOME's web
9800: site</a>:</p>
9801: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9802: environment, an intuitive and attractive desktop for users, and the
9803: GNOME development platform, an extensive framework for building
9804: applications that integrate into the rest of the desktop.</p></blockquote></div>
9805: <p>pkgsrc provides a seamless way to automatically build and install
9806: a complete GNOME environment <span class="emphasis"><em>under many different
9807: platforms</em></span>. We can say with confidence that pkgsrc is one of
9808: the most advanced build and packaging systems for GNOME due to its
9809: included technologies buildlink3, the wrappers and tools framework and
9810: automatic configuration file management. Lots of efforts are put into
9811: achieving a completely clean deinstallation of installed software
9812: components.</p>
9813: <p>Given that pkgsrc is <a href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9814: the above also means that great efforts are put into making GNOME work
9815: under this operating system. Recently, <a href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9816: pkgsrc as its preferred packaging system, contributing lots of
9817: portability fixes to make GNOME build and install under it.</p>
9818: <p>This chapter is aimed at pkgsrc developers and other people
9819: interested in helping our GNOME porting and packaging efforts. It
9820: provides instructions on how to manage the existing packages and some
9821: important information regarding their internals.</p>
9822: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9823: <h3 class="title">We need your help!</h3>
9824: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9825: and GNOME and are willing to learn new exciting stuff, please jump
9826: straight to the <a href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9827: work</a> list! There is still a long way to go to get a
9828: fully-functional GNOME desktop under NetBSD and we need your help to
9829: achieve it!</p>
9830: </div>
9831: <div class="sect1" lang="en">
9832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9833: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
1.85 jmmv 9834: <p>pkgsrc includes three GNOME-related meta packages:</p>
9835: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9836: <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 9837: the core GNOME desktop environment. It only includes the necessary
9838: bits to get it to boot correctly, although it may lack important
9839: functionality for daily operation. The idea behind this package is
9840: to let end users build their own configurations on top of this one,
9841: first installing this meta package to achieve a functional setup and
9842: then adding individual applications.</p></li>
1.91 rillig 9843: <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 9844: complete installation of the GNOME platform and desktop as defined
9845: by the GNOME project; this is based on the components distributed in
9846: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9847: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9848: official FTP server. Developer-only tools found in those
9849: directories are not installed unless required by some other
9850: component to work properly. Similarly, packages from the bindings
9851: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9852: in unless required as a dependency for an end-user component. This
1.91 rillig 9853: 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>
9854: <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 9855: Installs all the tools required to build a GNOME component when
9856: fetched from the CVS repository. These are required to let the
9857: <span><strong class="command">autogen.sh</strong></span> scripts work appropriately.</p></li>
9858: </ul></div>
9859: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9860: sorted in a way that eases updates: a package may depend on other
9861: packages listed before it but not on any listed after it. It is very
9862: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9863: change it to alphabetical sorting!</em></span></p>
9864: </div>
9865: <div class="sect1" lang="en">
9866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9867: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9868: <p>Almost all GNOME applications are written in C and use a common
9869: set of tools as their build system. Things get different with the new
9870: bindings to other languages (such as Python), but the following will
9871: give you a general idea on the minimum required tools:</p>
9872: <div class="itemizedlist"><ul type="disc">
9873: <li>
9874: <p>Almost all GNOME applications use the GNU Autotools as their
9875: build system. As a general rule you will need to tell this to your
9876: package:</p>
1.100 rillig 9877: <pre class="programlisting">
9878: GNU_CONFIGURE=yes
1.85 jmmv 9879: USE_LIBTOOL=yes
1.100 rillig 9880: USE_TOOLS+=gmake
9881: </pre>
1.85 jmmv 9882: </li>
9883: <li>
9884: <p>If the package uses pkg-config to detect dependencies, add this
9885: tool to the list of required utilities:</p>
9886: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9887: <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 9888: the end of the build process to ensure that you did not miss to
9889: specify any dependency in your package and that the version
9890: requirements are all correct.</p>
9891: </li>
1.93 rillig 9892: <li><p>If the package uses intltool, be sure to add
9893: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9894: to handle dependencies and to force the package to use the latest
9895: available version.</p></li>
9896: <li>
9897: <p>If the package uses gtk-doc (a documentation generation
9898: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9899: tool is rather big and the distfile should come with pregenerated
9900: documentation anyway; if it does not, it is a bug that you ought to
9901: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9902: the default):</p>
9903: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9904: <p>The default location of installed HTML files
9905: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9906: and should not be changed unless the package insists on installing
9907: them somewhere else. Otherwise programs as
9908: <span><strong class="command">devhelp</strong></span> will not be able to open them. You can
9909: do that with an entry similar to:</p>
9910: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9911: </li>
9912: </ul></div>
9913: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9914: files under the installation prefix to maintain databases. In this
9915: context, shared means that those exact same directories and files are
9916: used among several different packages, leading to conflicts in the
9917: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9918: handle the most common cases, so you have to forget about using
9919: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9920: omitting shared files from them. If you find yourself doing those,
9921: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9922: <p>The following table lists the common situations that result in
9923: using shared directories or files. For each of them, the appropriate
9924: solution is given. After applying the solution be sure to
9925: <span class="emphasis"><em>regenerate the package's file list</em></span> with
9926: <span><strong class="command">make print-PLIST</strong></span> and ensure it is correct.</p>
9927: <div class="table">
1.90 rillig 9928: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9929: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9930: <colgroup>
9931: <col>
9932: <col>
9933: </colgroup>
9934: <thead><tr>
9935: <th>If the package...</th>
9936: <th>Then...</th>
9937: </tr></thead>
9938: <tbody>
9939: <tr>
9940: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.103 wiz 9941: <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 9942: </tr>
9943: <tr>
9944: <td>Installs icons under the
9945: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9946: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.103 wiz 9947: <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 9948: </tr>
9949: <tr>
9950: <td>Installs files under
9951: <code class="filename">share/mime/packages</code>.</td>
1.103 wiz 9952: <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 9953: </tr>
9954: <tr>
9955: <td>Installs <code class="filename">.desktop</code> files under
9956: <code class="filename">share/applications</code> and these include MIME
9957: information.</td>
1.103 wiz 9958: <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 9959: </tr>
9960: </tbody>
1.91 rillig 9961: </table></div>
1.85 jmmv 9962: </div>
1.91 rillig 9963: <br class="table-break">
1.85 jmmv 9964: </div>
9965: <div class="sect1" lang="en">
9966: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 9967: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9968: <p>When seeing GNOME as a whole, there are two kinds of
9969: updates:</p>
9970: <div class="variablelist"><dl>
9971: <dt><span class="term">Major update</span></dt>
9972: <dd>
9973: <p>Given that there is still a very long way for GNOME 3 (if it
9974: ever appears), we consider a major update one that goes from a
9975: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9976: where <code class="literal">Y</code> is even and greater than
9977: <code class="literal">X</code>. These are hard to achieve because they
9978: introduce lots of changes in the components' code and almost all
9979: GNOME distfiles are updated to newer versions. Some of them can
9980: even break API and ABI compatibility with the previous major
9981: version series. As a result, the update needs to be done all at
9982: once to minimize breakage.</p>
9983: <p>A major update typically consists of around 80 package
9984: updates and the addition of some new ones.</p>
9985: </dd>
9986: <dt><span class="term">Minor update</span></dt>
9987: <dd>
9988: <p>We consider a minor update one that goes from a
9989: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9990: one where <code class="literal">Y</code> is greater than
9991: <code class="literal">X</code>. These are easy to achieve because they do
9992: not update all GNOME components, can be done in an incremental way
9993: and do not break API nor ABI compatibility.</p>
9994: <p>A minor update typically consists of around 50 package
9995: updates, although the numbers here may vary a lot.</p>
9996: </dd>
9997: </dl></div>
9998: <p>In order to update the GNOME components in pkgsrc to a new stable
9999: release (either major or minor), the following steps should be
10000: followed:</p>
10001: <div class="orderedlist"><ol type="1">
10002: <li>
10003: <p>Get a list of all the tarballs that form the new release by
10004: using the following commands. These will leave the full list of the
10005: components's distfiles into the <code class="filename">list.txt</code>
10006: file:</p>
1.88 wiz 10007: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10008: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10009: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 10010: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 10011: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10012: awk '{ print $9 }' >>list.txt</code></strong></pre>
10013: </li>
10014: <li><p>Open each meta package's <code class="filename">Makefile</code> and
10015: bump their version to the release you are updating them to. The
10016: three meta packages should be always consistent with versioning.
10017: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10018: in them.</p></li>
10019: <li>
10020: <p>For each meta package, update all its
10021: <code class="varname">DEPENDS</code> lines to match the latest versions as
10022: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10023: newer version (even if found in the FTP) because the meta packages
10024: are supposed to list the exact versions that form a specific GNOME
10025: release. Exceptions are permitted here if a newer version solves a
10026: serious issue in the overall desktop experience; these typically
10027: come in the form of a revision bump in pkgsrc, not in newer versions
10028: from the developers.</p>
10029: <p>Packages not listed in the <code class="filename">list.txt</code> file
10030: should be updated to the latest version available (if found in
10031: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 10032: 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 10033: </li>
10034: <li>
10035: <p>Generate a patch from the modified meta packages and extract the
10036: list of "new" lines. This will provide you an outline on what
10037: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 10038: <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 10039: </li>
10040: <li><p>For major desktop updates it is recommended to zap all your
10041: installed packages and start over from scratch at this point.</p></li>
10042: <li><p>Now comes the longest step by far: iterate over the contents
10043: of <code class="filename">todo.txt</code> and update the packages listed in
10044: it in order. For major desktop updates none of these should be
1.93 rillig 10045: committed until the entire set is completed because there are chances
1.85 jmmv 10046: of breaking not-yet-updated packages.</p></li>
10047: <li><p>Once the packages are up to date and working, commit them to
10048: the tree one by one with appropriate log messages. At the end,
10049: commit the three meta package updates and all the corresponding
10050: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10051: <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>
10052: </ol></div>
10053: </div>
10054: <div class="sect1" lang="en">
10055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10056: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 10057: <p>GNOME is a very big component in pkgsrc which approaches 100
10058: packages. Please, it is very important that you always, always,
10059: <span class="strong"><strong>always</strong></span> feed back any portability
1.93 rillig 10060: 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 10061: their attention on portability issues and to ensure that future versions
10062: can be built out-of-the box on NetBSD. The less custom patches in
10063: pkgsrc, the easier further updates are. Those developers in charge of
10064: issuing major GNOME updates will be grateful if you do that.</p>
10065: <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
10066: Bugzilla</a>. Not all components use these to track bugs, but most
10067: of them do. Do not be short on your reports: always provide detailed
10068: explanations of the current failure, how it can be improved to achieve
10069: maximum portability and, if at all possible, provide a patch against CVS
10070: head. The more verbose you are, the higher chances of your patch being
10071: accepted.</p>
10072: <p>Also, please avoid using preprocessor magic to fix portability
10073: issues. While the FreeBSD GNOME people are doing a great job in porting
10074: GNOME to their operating system, the official GNOME sources are now
10075: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10076: and similar macros. This hurts portability. Please see our patching
1.93 rillig 10077: guidelines (<a href="#components.patches.guidelines" title="10.3.4. Patching guidelines">Section 10.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 10078: details.</p>
10079: </div>
10080: </div>
1.75 rillig 10081: </div>
10082: <div class="part" lang="en">
10083: <div class="titlepage"><div><div><h1 class="title">
10084: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10085: <div class="partintro" lang="en">
10086: <div></div>
10087: <p>This part of the guide deals with everything
10088: from the infrastructure that is behind the interfaces described
10089: in the developer's guide. A casual package maintainer should not
10090: need anything from this part.</p>
10091: <div class="toc">
10092: <p><b>Table of Contents</b></p>
10093: <dl>
1.90 rillig 10094: <dt><span class="chapter"><a href="#infr.design">23. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10095: <dd><dl>
1.90 rillig 10096: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10097: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10098: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.75 rillig 10099: <dd><dl>
1.90 rillig 10100: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10101: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.75 rillig 10102: </dl></dd>
1.90 rillig 10103: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10104: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10105: <dd><dl>
1.90 rillig 10106: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10107: <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 10108: </dl></dd>
1.90 rillig 10109: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10110: <dd><dl>
1.90 rillig 10111: <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>
10112: <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 10113: </dl></dd>
10114: </dl></dd>
1.90 rillig 10115: <dt><span class="chapter"><a href="#regression">24. Regression tests</a></span></dt>
1.75 rillig 10116: <dd><dl>
1.90 rillig 10117: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10118: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10119: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10120: <dd><dl>
1.90 rillig 10121: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10122: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10123: </dl></dd>
10124: </dl></dd>
1.90 rillig 10125: <dt><span class="chapter"><a href="#porting">25. Porting pkgsrc</a></span></dt>
1.75 rillig 10126: <dd><dl>
1.90 rillig 10127: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10128: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10129: </dl></dd>
10130: </dl>
10131: </div>
10132: </div>
10133: <div class="chapter" lang="en">
10134: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10135: <a name="infr.design"></a>Chapter 23. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10136: <div class="toc">
10137: <p><b>Table of Contents</b></p>
10138: <dl>
1.90 rillig 10139: <dt><span class="sect1"><a href="#infr.vardef">23.1. The meaning of variable definitions</a></span></dt>
10140: <dt><span class="sect1"><a href="#infr.vardef.problems">23.2. Avoiding problems before they arise</a></span></dt>
10141: <dt><span class="sect1"><a href="#infr.var">23.3. Variable evaluation</a></span></dt>
1.81 rillig 10142: <dd><dl>
1.90 rillig 10143: <dt><span class="sect2"><a href="#infr.var.load">23.3.1. At load time</a></span></dt>
10144: <dt><span class="sect2"><a href="#infr.var.run">23.3.2. At runtime</a></span></dt>
1.81 rillig 10145: </dl></dd>
1.90 rillig 10146: <dt><span class="sect1"><a href="#infr.varspec">23.4. How can variables be specified?</a></span></dt>
10147: <dt><span class="sect1"><a href="#infr.design.intf">23.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10148: <dd><dl>
1.90 rillig 10149: <dt><span class="sect2"><a href="#infr.design.intf.proc">23.5.1. Procedures with parameters</a></span></dt>
10150: <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 10151: </dl></dd>
1.90 rillig 10152: <dt><span class="sect1"><a href="#infr.order">23.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10153: <dd><dl>
1.90 rillig 10154: <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>
10155: <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 10156: </dl></dd>
10157: </dl>
10158: </div>
10159: <p>The pkgsrc infrastructure consists of many small Makefile
10160: fragments. Each such fragment needs a properly specified
10161: interface. This chapter explains how such an interface looks
10162: like.</p>
10163: <div class="sect1" lang="en">
10164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10165: <a name="infr.vardef"></a>23.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10166: <p>Whenever a variable is defined in the pkgsrc
10167: infrastructure, the location and the way of definition provide
10168: much information about the intended use of that variable.
10169: Additionally, more documentation may be found in a header
10170: comment or in this pkgsrc guide.</p>
10171: <p>A special file is
10172: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10173: variables that are intended to be user-defined. They are either
10174: defined using the <code class="literal">?=</code> operator or they are
10175: left undefined because defining them to anything would
10176: effectively mean “<span class="quote">yes</span>”. All these variables may be
10177: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10178: file.</p>
10179: <p>Outside this file, the following conventions apply:
10180: Variables that are defined using the <code class="literal">?=</code>
10181: operator may be overridden by a package.</p>
10182: <p>Variables that are defined using the <code class="literal">=</code>
10183: operator may be used read-only at run-time.</p>
10184: <p>Variables whose name starts with an underscore must not be
10185: accessed outside the pkgsrc infrastructure at all. They may
10186: change without further notice.</p>
10187: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10188: <h3 class="title">Note</h3>
10189: <p>These conventions are currently not applied
10190: consistently to the complete pkgsrc
10191: infrastructure.</p>
10192: </div>
10193: </div>
10194: <div class="sect1" lang="en">
10195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10196: <a name="infr.vardef.problems"></a>23.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10197: <p>All variables that contain lists of things should default
10198: to being empty. Two examples that do not follow this rule are
10199: <code class="varname">USE_LANGUAGES</code> and
10200: <code class="varname">DISTFILES</code>. These variables cannot simply be
10201: modified using the <code class="literal">+=</code> operator in package
10202: <code class="filename">Makefile</code>s (or other files included by
10203: them), since there is no guarantee whether the variable is
10204: already set or not, and what its value is. In the case of
10205: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10206: the default value and just define it as in the following
10207: example.</p>
10208: <pre class="programlisting">
1.100 rillig 10209: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10210: </pre>
10211: <p>Because of the selection of this default value, the same
10212: value appears in many package Makefiles. Similarly for
10213: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10214: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10215: doesn't stand out. Nevertheless it is mentioned in many
10216: files.</p>
10217: </div>
10218: <div class="sect1" lang="en">
10219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10220: <a name="infr.var"></a>23.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10221: <div class="sect2" lang="en">
10222: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10223: <a name="infr.var.load"></a>23.3.1. At load time</h3></div></div></div>
1.75 rillig 10224: <p>Variable evaluation takes place either at load time or at
10225: runtime, depending on the context in which they occur. The
10226: contexts where variables are evaluated at load time are:</p>
10227: <div class="itemizedlist"><ul type="disc">
10228: <li><p>The right hand side of the <code class="literal">:=</code>
10229: and <code class="literal">!=</code> operators,</p></li>
10230: <li><p>Make directives like <code class="literal">.if</code> or
10231: <code class="literal">.for</code>,</p></li>
10232: <li><p>Dependency lines.</p></li>
10233: </ul></div>
10234: <p>A special exception are references to the iteration
10235: variables of <code class="literal">.for</code> loops, which are expanded
10236: inline, no matter in which context they appear.</p>
10237: <p>As the values of variables may change during load time,
10238: care must be taken not to evaluate them by accident. Typical
10239: examples for variables that should not be evaluated at load time
10240: are <code class="varname">DEPENDS</code> and
10241: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10242: clear, here is an example:</p>
10243: <pre class="programlisting">
1.100 rillig 10244: CONFIGURE_ARGS= # none
10245: CFLAGS= -O
10246: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10247:
1.100 rillig 10248: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10249:
1.100 rillig 10250: CFLAGS+= -Wall
1.75 rillig 10251: </pre>
10252: <p>This code shows how the use of the <code class="literal">:=</code>
10253: operator can quickly lead to unexpected results. The first
10254: paragraph is fairly common code. The second paragraph evaluates
10255: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10256: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10257: <code class="literal">-Wall</code> is appended to the
10258: <code class="varname">CFLAGS</code>, but this addition will not appear in
10259: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10260: paragraphs from above typically occur in completely unrelated
10261: files.</p>
10262: </div>
10263: <div class="sect2" lang="en">
10264: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10265: <a name="infr.var.run"></a>23.3.2. At runtime</h3></div></div></div>
1.75 rillig 10266: <p>After all the files have been loaded, the values of the
10267: variables cannot be changed anymore. Variables that are used in
10268: the shell commands are expanded at this point.</p>
10269: </div>
10270: </div>
10271: <div class="sect1" lang="en">
10272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10273: <a name="infr.varspec"></a>23.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10274: <p>There are many ways in which the definition and use of a
10275: variable can be restricted in order to detect bugs and
10276: violations of the (mostly unwritten) policies. See the
10277: <code class="literal">pkglint</code> developer's documentation for further
10278: details.</p>
10279: </div>
10280: <div class="sect1" lang="en">
10281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10282: <a name="infr.design.intf"></a>23.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10283: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10284: of the following classes. Cases where a file falls into more
10285: than one class should be avoided as it often leads to subtle
10286: bugs.</p>
10287: <div class="sect2" lang="en">
10288: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10289: <a name="infr.design.intf.proc"></a>23.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10290: <p>In a traditional imperative programming language some of
1.76 rillig 10291: the <code class="filename">.mk</code> files could be described as
1.104 ! rillig 10292: procedures. They take some input parameters and—after
! 10293: inclusion—provide a result in output parameters. Since all
1.76 rillig 10294: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10295: care must be taken not to use parameter names that have already
10296: another meaning. For example, <code class="varname">PKGNAME</code> is a
10297: bad choice for a parameter name.</p>
10298: <p>Procedures are completely evaluated at preprocessing time.
10299: That is, when calling a procedure all input parameters must be
10300: completely resolvable. For example,
10301: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10302: parameter since it is very likely that further text will be
10303: added after calling the procedure, which would effectively apply
10304: the procedure to only a part of the variable. Also, references
10305: to other variables wit will be modified after calling the
10306: procedure.</p>
10307: <p>A procedure can declare its output parameters either as
10308: suitable for use in preprocessing directives or as only
10309: available at runtime. The latter alternative is for variables
10310: that contain references to other runtime variables.</p>
10311: <p>Procedures shall be written such that it is possible to
10312: call the procedure more than once. That is, the file must not
10313: contain multiple-inclusion guards.</p>
10314: <p>Examples for procedures are
1.76 rillig 10315: <code class="filename">mk/bsd.options.mk</code> and
10316: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10317: that the parameters are evaluated at load time, they should be
10318: assigned using the <code class="literal">:=</code> operator, which should
10319: be used only for this purpose.</p>
10320: </div>
10321: <div class="sect2" lang="en">
10322: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10323: <a name="infr.design.intf.action"></a>23.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10324: <p>Action files take some input parameters and may define
10325: runtime variables. They shall not define loadtime variables.
10326: There are action files that are included implicitly by the
10327: pkgsrc infrastructure, while other must be included
10328: explicitly.</p>
10329: <p>An example for action files is
1.76 rillig 10330: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10331: </div>
10332: </div>
1.81 rillig 10333: <div class="sect1" lang="en">
10334: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10335: <a name="infr.order"></a>23.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10336: <p>Package <code class="filename">Makefile</code>s usually consist of
10337: a set of variable definitions, and include the file
10338: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10339: Before that, they may also include various other
10340: <code class="filename">*.mk</code> files if they need to query the
10341: availability of certain features like the type of compiler or
10342: the X11 implementation. Due to the heavy use of preprocessor
10343: directives like <code class="literal">.if</code> and
10344: <code class="literal">.for</code>, the order in which the files are loaded
10345: matters.</p>
10346: <p>This section describes at which point the various files
10347: are loaded and gives reasons for that order.</p>
10348: <div class="sect2" lang="en">
10349: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10350: <a name="infr.order.prefs"></a>23.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10351: </h3></div></div></div>
10352: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10353: is to define some essential variables like
10354: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10355: <code class="varname">MACHINE_ARCH</code>.</p>
10356: <p>Then, the user settings are loaded from the file specified
1.104 ! rillig 10357: in <code class="varname">MAKECONF</code>, which is usually <a href="#mk.conf"><code class="filename">mk.conf</code></a>.
! 10358: After that, those variables
1.81 rillig 10359: that have not been overridden by the user are loaded from
10360: <code class="filename">mk/defaults/mk.conf</code>.</p>
10361: <p>After the user settings, the system settings and platform
10362: settings are loaded, which may override the user
10363: settings.</p>
10364: <p>Then, the tool definitions are loaded. The tool wrappers
10365: are not yet in effect. This only happens when building a
10366: package, so the proper variables must be used instead of the
10367: direct tool names.</p>
10368: <p>As the last steps, some essential variables from the
10369: wrapper and the package system flavor are loaded, as well as the
10370: variables that have been cached in earlier phases of a package
10371: build.</p>
10372: </div>
10373: <div class="sect2" lang="en">
10374: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10375: <a name="infr.order.pkg"></a>23.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10376: </h3></div></div></div>
1.81 rillig 10377: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10378: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10379: loaded, which fill default values for those variables that have
1.93 rillig 10380: not been defined by the package. These variables may later
1.81 rillig 10381: be used even in unrelated files.</p>
10382: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10383: provides the target <code class="literal">error-check</code> that is added
10384: as a special dependency to all other targets that use
10385: <code class="varname">DELAYED_ERROR_MSG</code> or
10386: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10387: <p>Then, the package-specific hacks from
10388: <code class="filename">hacks.mk</code> are included.</p>
10389: <p>Then, various other files follow. Most of them don't have
10390: any dependencies on what they need to have included before or
10391: after them, though some do.</p>
10392: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10393: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10394: restricts the use of these variables to all the files that have
10395: been included before. Appearances in later files will be
10396: silently ignored.</p>
10397: <p>Then, the files for the main targets are included, in the
10398: order of later execution, though the actual order should not
10399: matter.</p>
10400: <p>At last, some more files are included that don't set any
10401: interesting variables but rather just define make targets to be
10402: executed.</p>
10403: </div>
10404: </div>
1.75 rillig 10405: </div>
10406: <div class="chapter" lang="en">
10407: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10408: <a name="regression"></a>Chapter 24. Regression tests</h2></div></div></div>
1.75 rillig 10409: <div class="toc">
10410: <p><b>Table of Contents</b></p>
10411: <dl>
1.90 rillig 10412: <dt><span class="sect1"><a href="#regression.descr">24.1. The regression tests framework</a></span></dt>
10413: <dt><span class="sect1"><a href="#regression.run">24.2. Running the regression tests</a></span></dt>
10414: <dt><span class="sect1"><a href="#regression.new">24.3. Adding a new regression test</a></span></dt>
1.75 rillig 10415: <dd><dl>
1.90 rillig 10416: <dt><span class="sect2"><a href="#regression.fun.override">24.3.1. Overridable functions</a></span></dt>
10417: <dt><span class="sect2"><a href="#regression.fun.helper">24.3.2. Helper functions</a></span></dt>
1.75 rillig 10418: </dl></dd>
10419: </dl>
10420: </div>
10421: <p>The pkgsrc infrastructure consists of a large codebase,
10422: and there are many corners where every little bit of a file is
10423: well thought out, making pkgsrc likely to fail as soon as
10424: anything is changed near those parts. To prevent most changes
10425: from breaking anything, a suite of regression tests should go
10426: along with every important part of the pkgsrc infrastructure.
10427: This chapter describes how regression tests work in pkgsrc and
10428: how you can add new tests.</p>
10429: <div class="sect1" lang="en">
10430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10431: <a name="regression.descr"></a>24.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10432: <p></p>
10433: </div>
10434: <div class="sect1" lang="en">
10435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10436: <a name="regression.run"></a>24.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10437: <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 10438: provides the <span><strong class="command">pkg_regress</strong></span> command. Then you
10439: can simply run that command, which will run all tests in the
1.76 rillig 10440: <code class="filename">regress</code> category.</p>
1.75 rillig 10441: </div>
10442: <div class="sect1" lang="en">
10443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10444: <a name="regression.new"></a>24.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10445: <p>Every directory in the <code class="filename">regress</code>
10446: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10447: is considered a regression test. This file is a shell program
10448: that is included by the <span><strong class="command">pkg_regress</strong></span> command.
10449: The following functions can be overridden to suit your
10450: needs.</p>
10451: <div class="sect2" lang="en">
10452: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10453: <a name="regression.fun.override"></a>24.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10454: <p>These functions do not take any parameters. They are all
10455: called in “<span class="quote">set -e</span>” mode, so you should be careful
10456: to check the exitcodes of any commands you run in the
10457: test.</p>
10458: <div class="variablelist"><dl>
10459: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10460: <dd><p>This function prepares the environment for the
10461: test. By default it does nothing.</p></dd>
10462: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10463: <dd><p>This function runs the actual test. By default,
10464: it calls <code class="varname">TEST_MAKE</code> with the arguments
10465: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10466: error messages into the file
10467: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10468: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10469: <dd><p>This function is run after the test and is
10470: typically used to compare the actual output from the one that is
10471: expected. It can make use of the various helper functions from
10472: the next section.</p></dd>
10473: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10474: <dd><p>This function cleans everything up after the
10475: test has been run. By default it does nothing.</p></dd>
10476: </dl></div>
10477: </div>
10478: <div class="sect2" lang="en">
10479: <div class="titlepage"><div><div><h3 class="title">
1.90 rillig 10480: <a name="regression.fun.helper"></a>24.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10481: <div class="variablelist"><dl>
10482: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10483: <dd><p>This function compares the exitcode of the
10484: <span><strong class="command">do_test()</strong></span> function with its first parameter.
10485: If they differ, the test will fail.</p></dd>
10486: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10487: <dd><p>This function checks for each of its parameters
10488: if the output from <span><strong class="command">do_test()</strong></span> matches the
10489: extended regular expression. If it does not, the test will
10490: fail.</p></dd>
10491: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10492: <dd><p>This function checks for each of its parameters
10493: if the output from <span><strong class="command">do_test()</strong></span> does
10494: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10495: If any of the regular expressions matches, the test will
10496: fail.</p></dd>
10497: </dl></div>
10498: </div>
10499: </div>
10500: </div>
10501: <div class="chapter" lang="en">
10502: <div class="titlepage"><div><div><h2 class="title">
1.90 rillig 10503: <a name="porting"></a>Chapter 25. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10504: <div class="toc">
10505: <p><b>Table of Contents</b></p>
10506: <dl>
1.90 rillig 10507: <dt><span class="sect1"><a href="#porting.opsys">25.1. Porting pkgsrc to a new operating system</a></span></dt>
10508: <dt><span class="sect1"><a href="#porting.compiler">25.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10509: </dl>
10510: </div>
10511: <p>The pkgsrc system has already been ported to many
10512: operating systems, hardware architectures and compilers. This
10513: chapter explains the necessary steps to make pkgsrc even more
10514: portable.</p>
10515: <div class="sect1" lang="en">
10516: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10517: <a name="porting.opsys"></a>25.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10518: <p>To port pkgsrc to a new operating system (called
10519: <code class="literal">MyOS</code> in this example), you need to touch the
10520: following files:</p>
10521: <div class="variablelist"><dl>
1.93 rillig 10522: <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 10523: <dd><p>This file contains some basic definitions, for
10524: example the name of the C
10525: compiler.</p></dd>
1.76 rillig 10526: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10527: <dd><p>Insert code that defines the variables
10528: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10529: <code class="varname">LOWER_OS_VERSION</code>,
10530: <code class="varname">LOWER_VENDOR</code>,
10531: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10532: <code class="varname">APPEND_ELF</code>, and the other variables that
10533: appear in this file.</p></dd>
1.93 rillig 10534: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10535: <dd><p>This file contains the platform-specific
10536: definitions that are used by pkgsrc. Start by copying one of the
10537: other files and edit it to your
10538: needs.</p></dd>
1.93 rillig 10539: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10540: <dd><p>This file contains a list of directories,
10541: together with their permission bits and ownership. These
10542: directories will be created automatically with every package
1.98 wiz 10543: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10544: be removed.</p></dd>
1.93 rillig 10545: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10546: <dd><p>Just copy one of the pre-existing x11.dist files
10547: to your
1.76 rillig 10548: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10549: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10550: <dd><p>On some operating systems, the tools that are
10551: provided with the base system are not good enough for pkgsrc.
10552: 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
10553: narrow limit on the line length they can process. Therefore
10554: pkgsrc brings its own tools, which can be enabled
10555: here.</p></dd>
1.93 rillig 10556: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10557: <dd><p>This file defines the paths to all the tools
10558: that are needed by one or the other package in pkgsrc, as well
10559: as by pkgsrc itself. Find out where these tools are on your
10560: platform and add them.</p></dd>
10561: </dl></div>
10562: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10563: <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 10564: </div>
10565: <div class="sect1" lang="en">
10566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.90 rillig 10567: <a name="porting.compiler"></a>25.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10568: <p>TODO</p>
10569: </div>
10570: </div>
10571: </div>
10572: <div class="appendix" lang="en">
10573: <div class="titlepage"><div><div><h2 class="title">
10574: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10575: <div class="toc">
10576: <p><b>Table of Contents</b></p>
10577: <dl>
10578: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10579: <dd><dl>
10580: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10581: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10582: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10583: <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>
10584: </dl></dd>
10585: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10586: </dl>
10587: </div>
10588: <p>We checked to find a piece of software that wasn't in the packages
10589: collection, and picked GNU bison. Quite why someone would want to have
10590: <span><strong class="command">bison</strong></span> when Berkeley <span><strong class="command">yacc</strong></span> is already
10591: present in the tree is beyond us, but it's useful for the purposes of
10592: this exercise.</p>
10593: <div class="sect1" lang="en">
10594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10595: <a name="example-files"></a>A.1. files</h2></div></div></div>
10596: <div class="sect2" lang="en">
10597: <div class="titlepage"><div><div><h3 class="title">
10598: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10599: <pre class="programlisting">
1.100 rillig 10600: # $NetBSD$
10601: #
1.1 grant 10602:
1.100 rillig 10603: DISTNAME= bison-1.25
10604: CATEGORIES= devel
10605: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10606:
1.100 rillig 10607: MAINTAINER= thorpej@NetBSD.org
10608: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10609: COMMENT= GNU yacc clone
1.1 grant 10610:
1.100 rillig 10611: GNU_CONFIGURE= yes
10612: INFO_FILES= bison.info
1.1 grant 10613:
1.100 rillig 10614: .include "../../mk/bsd.pkg.mk"
1.1 grant 10615: </pre>
1.75 rillig 10616: </div>
10617: <div class="sect2" lang="en">
10618: <div class="titlepage"><div><div><h3 class="title">
10619: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10620: <pre class="programlisting">
1.100 rillig 10621: GNU version of yacc. Can make re-entrant parsers, and numerous other
10622: 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
10623: of the NetBSD source tree is beyond me.
1.1 grant 10624: </pre>
1.75 rillig 10625: </div>
10626: <div class="sect2" lang="en">
10627: <div class="titlepage"><div><div><h3 class="title">
10628: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10629: <pre class="programlisting">
1.100 rillig 10630: @comment $NetBSD$
10631: bin/bison
10632: man/man1/bison.1.gz
10633: share/bison.simple
10634: share/bison.hairy
1.1 grant 10635: </pre>
1.75 rillig 10636: </div>
10637: <div class="sect2" lang="en">
10638: <div class="titlepage"><div><div><h3 class="title">
1.93 rillig 10639: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span><strong class="command">pkglint</strong></span>
10640: </h3></div></div></div>
1.75 rillig 10641: <p>The NetBSD package system comes with
1.91 rillig 10642: <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 10643: which helps to check the contents of these
10644: files. After installation it is quite easy to use, just change to the
10645: directory of the package you wish to examine and execute
10646: <span><strong class="command">pkglint</strong></span>:</p>
10647: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10648: looks fine.</pre>
10649: <p>Depending on the supplied command line arguments (see pkglint(1)),
10650: more checks will be performed. Use e.g. <span><strong class="command">pkglint -Call
10651: -Wall</strong></span> for a very thorough check.</p>
10652: </div>
10653: </div>
10654: <div class="sect1" lang="en">
10655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10656: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10657: <p>Create the directory where the package lives,
10658: plus any auxiliary directories:</p>
10659: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10660: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10661: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10662: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10663: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.90 rillig 10664: <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 10665: then continue with fetching the distfile:</p>
10666: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10667: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10668: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10669: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10670: ftp: Error retrieving file: 500 Internal error
10671:
10672: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10673: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10674: ftp: Error retrieving file: 500 Internal error
10675:
10676: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10677: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10678: Successfully retrieved file.</pre>
10679: <p>Generate the checksum of the distfile into
1.76 rillig 10680: <code class="filename">distinfo</code>:</p>
1.88 wiz 10681: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10682: <p>Now compile:</p>
10683: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10684: >> Checksum OK for bison-1.25.tar.gz.
10685: ===> Extracting for bison-1.25
10686: ===> Patching for bison-1.25
10687: ===> Ignoring empty patch directory
10688: ===> Configuring for bison-1.25
10689: creating cache ./config.cache
10690: checking for gcc... cc
10691: checking whether we are using GNU C... yes
10692: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10693: checking how to run the C preprocessor... cc -E
10694: checking for minix/config.h... no
10695: checking for POSIXized ISC... no
10696: checking whether cross-compiling... no
10697: checking for ANSI C header files... yes
10698: checking for string.h... yes
10699: checking for stdlib.h... yes
10700: checking for memory.h... yes
10701: checking for working const... yes
10702: checking for working alloca.h... no
10703: checking for alloca... yes
10704: checking for strerror... yes
10705: updating cache ./config.cache
10706: creating ./config.status
10707: creating Makefile
10708: ===> Building for bison-1.25
10709: 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
10710: 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
10711: 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
10712: 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
10713: 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 10714: 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 10715: 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
10716: 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
10717: 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
10718: 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
10719: 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
10720: 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
10721: 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
10722: 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
10723: 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
10724: 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
10725: 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
10726: 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
10727: 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
10728: 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
10729: 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
10730: 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
10731: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10732: rm -f bison.s1
1.75 rillig 10733: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10734: <p>Everything seems OK, so install the files:</p>
10735: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10736: >> Checksum OK for bison-1.25.tar.gz.
10737: ===> Installing for bison-1.25
10738: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10739: rm -f /usr/pkg/bin/bison
10740: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10741: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10742: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10743: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10744: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10745: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10746: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10747: ===> Registering installation for bison-1.25</pre>
10748: <p>You can now use bison, and also - if you decide so - remove it with
10749: <span><strong class="command">pkg_delete bison</strong></span>. Should you decide that you want a
10750: binary package, do this now:</p>
10751: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10752: >> Checksum OK for bison-1.25.tar.gz.
10753: ===> Building package for bison-1.25
10754: Creating package bison-1.25.tgz
10755: Registering depends:.
1.75 rillig 10756: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10757: <p>Now that you don't need the source and object files
10758: any more, clean up:</p>
10759: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10760: ===> Cleaning for bison-1.25</pre>
10761: </div>
10762: </div>
10763: <div class="appendix" lang="en">
10764: <div class="titlepage"><div><div><h2 class="title">
10765: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10766: <div class="toc">
10767: <p><b>Table of Contents</b></p>
10768: <dl>
10769: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10770: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10771: </dl>
10772: </div>
10773: <div class="sect1" lang="en">
10774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10775: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10777: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10778: => figlet221.tar.gz doesn't seem to exist on this system.
10779: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10780: => [172219 bytes]
10781: Connected to ftp.plig.net.
10782: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10783: 331 Guest login ok, send your complete e-mail address as password.
10784: 230-You are user #5 of 500 simultaneous users allowed.
10785: 230-
1.68 rillig 10786: 230- ___ _ _ _
10787: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10788: 230- | _| _| . |_| . | | | . |_| . | _| . |
10789: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10790: 230- |_| |_| |___| |___|
10791: 230-
10792: 230-** Welcome to ftp.plig.org **
10793: 230-
10794: 230-Please note that all transfers from this FTP site are logged. If you
10795: 230-do not like this, please disconnect now.
10796: 230-
10797: 230-This arhive is available via
10798: 230-
10799: 230-HTTP: http://ftp.plig.org/
10800: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10801: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10802: 230-
10803: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10804: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10805: 230-
10806: 230-
10807: 230 Logged in anonymously.
10808: Remote system type is UNIX.
10809: Using binary mode to transfer files.
10810: 200 Type okay.
10811: 250 "/pub" is new cwd.
10812: 250-"/pub/figlet" is new cwd.
10813: 250-
10814: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10815: 250-
1.75 rillig 10816: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10817: 250-
10818: 250-The official FIGlet web page is:
1.75 rillig 10819: 250- http://www.figlet.org/
1.1 grant 10820: 250-
10821: 250-If you have questions, please mailto:info@figlet.org. If you want to
10822: 250-contribute a font or something else, you can email us.
1.68 rillig 10823: 250
1.1 grant 10824: 250 "/pub/figlet/program" is new cwd.
10825: 250 "/pub/figlet/program/unix" is new cwd.
10826: local: figlet221.tar.gz remote: figlet221.tar.gz
10827: 502 Unimplemented command.
10828: 227 Entering Passive Mode (195,40,6,41,246,104)
10829: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10830: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10831: 226 Transfer completed.
10832: 172219 bytes received in 00:02 (75.99 KB/s)
10833: 221 Goodbye.
10834: => Checksum OK for figlet221.tar.gz.
10835: ===> Extracting for figlet-2.2.1nb2
10836: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10837: ===> Patching for figlet-2.2.1nb2
10838: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10839: ===> Overriding tools for figlet-2.2.1nb2
10840: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10841: ===> Configuring for figlet-2.2.1nb2
10842: ===> Building for figlet-2.2.1nb2
10843: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10844: chmod a+x figlet
10845: gcc -O2 -o chkfont chkfont.c
10846: => Unwrapping files-to-be-installed.
1.14 xtraeme 10847: <code class="prompt">#</code>
1.75 rillig 10848: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10849: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10850: ===> Installing for figlet-2.2.1nb2
10851: install -d -o root -g wheel -m 755 /usr/pkg/bin
10852: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10853: mkdir -p /usr/pkg/share/figlet
10854: cp figlet /usr/pkg/bin
10855: cp chkfont /usr/pkg/bin
10856: chmod 555 figlist showfigfonts
10857: cp figlist /usr/pkg/bin
10858: cp showfigfonts /usr/pkg/bin
10859: cp fonts/*.flf /usr/pkg/share/figlet
10860: cp fonts/*.flc /usr/pkg/share/figlet
10861: cp figlet.6 /usr/pkg/man/man6
10862: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10863: <code class="prompt">#</code></pre>
10864: </div>
10865: <div class="sect1" lang="en">
10866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10867: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10868: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10869: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10870: ===> Packaging figlet-2.2.1nb2
10871: ===> Building binary package for figlet-2.2.1nb2
10872: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10873: Using SrcDir value of /usr/pkg
1.68 rillig 10874: Registering depends:.
1.75 rillig 10875: <code class="prompt">#</code></pre>
10876: </div>
10877: </div>
10878: <div class="appendix" lang="en">
10879: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10880: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10881: <div class="toc">
10882: <p><b>Table of Contents</b></p>
10883: <dl>
10884: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10885: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10886: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10887: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102 rillig 10888: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.76 rillig 10889: <dt><span class="sect1"><a href="#ftp-source">C.6. <code class="filename">current</code>,
1.93 rillig 10890: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10891: source packages</a></span></dt>
10892: </dl>
10893: </div>
10894: <p>As in other big projects, the directory layout of pkgsrc
10895: is quite complex for newbies. This chapter explains where you
10896: find things on the FTP server. The base directory on
1.89 rillig 10897: <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>.
10898: On other servers it may be different, but inside this directory,
10899: everything should look the same, no matter on which server you
10900: are. This directory contains some subdirectories, which are
10901: explained below.</p>
1.76 rillig 10902: <div class="sect1" lang="en">
10903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10904: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
10905: <p>For those who only want to manage binary packages on
10906: systems other than NetBSD, we provide the package management
10907: tools in a separate, small tar file.</p>
10908: </div>
10909: <div class="sect1" lang="en">
10910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10911: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10912: <p>The directory <code class="filename">distfiles</code> contains lots
10913: of archive files from all pkgsrc packages, which are mirrored
10914: here. The subdirectories are called after their package names
10915: and are used when the distributed files have names that don't
10916: explicitly contain a version number or are otherwise too generic
10917: (for example <code class="filename">release.tar.gz</code>).</p>
10918: </div>
10919: <div class="sect1" lang="en">
10920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10921: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10922: <p>This directory is currently not in use.</p>
10923: </div>
10924: <div class="sect1" lang="en">
10925: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10926: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10927: <p>This directory contains things that individual pkgsrc
10928: developers find worth publishing.</p>
10929: </div>
10930: <div class="sect1" lang="en">
10931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102 rillig 10932: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10933: <p>This directory contains binary packages for the various
10934: platforms that are supported by pkgsrc.
10935: 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>
10936: <div class="itemizedlist"><ul type="disc">
10937: <li><p><code class="varname">OPSYS</code> is the name of the operating system for which the packages have been built,</p></li>
10938: <li><p><code class="varname">ARCH</code> is the hardware architecture,</p></li>
10939: <li><p><code class="varname">OSVERSION</code> is the version of the operating system,</p></li>
10940: <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>
10941: </ul></div>
10942: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10943: can quickly click through the directories on the
10944: server and find the best binary packages for their machines. Since they
10945: usually know the operating system and the hardware architecture, OPSYS
10946: and ARCH are placed first. After these choices, they can select the
10947: best combination of OSVERSION and TAG together, since it is usually the
10948: case that packages stay compatible between different version of the
10949: operating system.</p>
10950: <p>In each of these directories, there is a
10951: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10952: <code class="filename">All</code> which contains all binary packages.
10953: Besides that, there are various category directories that
10954: contain symbolic links to the real binary packages.</p>
10955: </div>
10956: <div class="sect1" lang="en">
10957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10958: <a name="ftp-source"></a>C.6. <code class="filename">current</code>,
1.93 rillig 10959: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10960: source packages</h2></div></div></div>
10961: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10962: that is the files that define how to create binary packages from
10963: source archives.</p>
10964: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10965: snapshot of the CVS repository, which is updated regularly. The
10966: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10967: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10968: <p>In the directories for the quarterly branches, there is an
10969: additional file called
10970: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10971: which contains the state of pkgsrc when it was branched.</p>
10972: </div>
1.75 rillig 10973: </div>
10974: <div class="appendix" lang="en">
10975: <div class="titlepage"><div><div><h2 class="title">
10976: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10977: <div class="toc">
10978: <p><b>Table of Contents</b></p>
10979: <dl>
1.79 rillig 10980: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10981: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10982: </dl>
10983: </div>
1.79 rillig 10984: <p>This section contains information on editing the pkgsrc
10985: guide itself.</p>
1.75 rillig 10986: <div class="sect1" lang="en">
10987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10988: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10989: <p>The pkgsrc guide's source code is stored in
10990: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10991: are created from it:</p>
10992: <div class="itemizedlist"><ul type="disc">
10993: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10994: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.101 rillig 10995: <li><p><a href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
10996: <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 10997: The PDF version of the pkgsrc guide.</p></li>
1.101 rillig 10998: <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 10999: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 11000: </ul></div>
11001: </div>
11002: <div class="sect1" lang="en">
11003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11004: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 11005: <p>The procedure to edit the pkgsrc guide is:</p>
11006: <div class="procedure"><ol type="1">
11007: <li><p>Make sure you have the packages needed to
1.83 wiz 11008: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 11009: 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
11010: 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 11011: PostScript and PDF versions. You will need both packages
11012: installed, to make sure documentation is consistent across all
11013: formats.</p></li>
11014: <li><p>Run <span><strong class="command">cd doc/guide</strong></span> to get to the
11015: right directory. All further steps will take place
11016: here.</p></li>
11017: <li><p>Edit the XML file(s) in
11018: <code class="filename">files/</code>.</p></li>
11019: <li><p>Run <span><strong class="command">bmake</strong></span> to check the pkgsrc
11020: guide for valid XML and to build the final output files. If you
11021: get any errors at this stage, you can just edit the files, as
11022: there are only symbolic links in the working directory, pointing
11023: to the files in <code class="filename">files/</code>.</p></li>
11024: <li><p><span><strong class="command">(cd files && cvs
11025: commit)</strong></span></p></li>
11026: <li><p>Run <span><strong class="command">bmake clean && bmake</strong></span> to
11027: regenerate the output files with the proper RCS
11028: Ids.</p></li>
1.91 rillig 11029: <li>
11030: <p>Run <span><strong class="command">bmake regen</strong></span> to install and
11031: commit the files in both <code class="filename">pkgsrc/doc</code> and
11032: <code class="filename">htdocs</code>.</p>
11033: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
11034: <h3 class="title">Note</h3>
11035: <p>If you have added, removed or renamed some chapters,
1.83 wiz 11036: you need to synchronize them using <span><strong class="command">cvs add</strong></span> or
11037: <span><strong class="command">cvs delete</strong></span> in the htdocs
1.91 rillig 11038: directory.</p>
11039: </div>
11040: </li>
1.79 rillig 11041: </ol></div>
1.75 rillig 11042: </div>
11043: </div>
11044: </div></body>
1.1 grant 11045: </html>
CVSweb <webmaster@jp.NetBSD.org>