Annotation of pkgsrc/doc/pkgsrc.html, revision 1.112
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>
1.110 hubertf 21: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>></code></p></div></div>
1.75 rillig 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.110 hubertf 27: <div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>></code></p></div></div>
1.75 rillig 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>
1.106 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 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.109 rillig 116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 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>
1.106 rillig 130: </dl></dd>
131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
132: builds)</a></span></dt>
1.75 rillig 133: <dd><dl>
1.106 rillig 134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
137: <dd><dl>
138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
146: </dl></dd>
147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
148: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
149: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
150: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
151: </dl></dd>
152: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
153: <dd><dl>
154: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
155: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
156: </dl></dd>
157: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
158: <dd><dl>
159: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
160: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
161: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
162: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
163: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
164: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
165: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.110 hubertf 166: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 167: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
168: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 169: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.106 rillig 170: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
171: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
172: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
173: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
174: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
175: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
176: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 177: </dl></dd>
178: </dl></dd>
179: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
180: <dd><dl>
1.106 rillig 181: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 182: <dd><dl>
1.106 rillig 183: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 184: <dd><dl>
1.106 rillig 185: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
186: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91 rillig 187: </dl></dd>
1.106 rillig 188: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
189: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
190: </dl></dd>
191: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
192: <dd><dl>
193: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
194: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
195: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
196: <dd><dl>
197: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
198: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
199: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
200: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
201: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
202: </dl></dd>
203: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
204: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
205: <dd><dl>
206: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
207: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
208: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
209: </dl></dd>
210: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
211: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
212: </dl></dd>
213: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
214: <dd><dl>
215: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
216: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
217: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
218: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
219: <dd><dl>
220: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
221: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
222: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
223: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
224: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
225: </dl></dd>
226: </dl></dd>
227: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
228: <dd><dl>
229: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
230: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.110 hubertf 231: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 232: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
233: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
234: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
235: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
236: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
237: </dl></dd>
238: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
239: <dd><dl>
240: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
241: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
242: <dd><dl>
243: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
244: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
245: </dl></dd>
246: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
247: <dd><dl>
248: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
249: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
250: </dl></dd>
251: </dl></dd>
252: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
253: <dd><dl>
254: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
255: <dd><dl>
256: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
257: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
258: </dl></dd>
259: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
260: <dd><dl>
261: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
262: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
263: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
264: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
265: </dl></dd>
266: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
267: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
268: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
269: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
270: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
271: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
272: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
273: </dl></dd>
274: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
275: <dd><dl>
276: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
277: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
278: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 279: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 280: </dl></dd>
281: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
282: <dd><dl>
283: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
284: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
285: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
286: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
287: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
288: <dd><dl>
289: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
290: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
291: </dl></dd>
292: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
293: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
294: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
295: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
296: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
297: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
298: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
299: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
300: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
301: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
303: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
304: </dl></dd>
305: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
306: <dd><dl>
307: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
308: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
309: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
310: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
311: </dl></dd>
312: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
313: <dd><dl>
314: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
315: <dd><dl>
316: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
317: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
318: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
319: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
320: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
321: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
322: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
323: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
324: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
325: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
326: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
327: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
328: </dl></dd>
329: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
330: <dd><dl>
331: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
332: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
333: </dl></dd>
334: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
335: <dd><dl>
336: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
337: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
338: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
339: </dl></dd>
340: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
341: <dd><dl>
342: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
343: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
344: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
345: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
346: </dl></dd>
347: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
348: <dd><dl>
349: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
350: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
351: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
352: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
353: </dl></dd>
354: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
355: <dd><dl>
356: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
357: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
358: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
359: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
360: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
361: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
362: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
363: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 364: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106 rillig 365: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
366: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
367: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
368: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
369: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
370: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
371: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
372: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
373: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 374: emulation</a></span></dt>
1.106 rillig 375: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
376: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 377: </dl></dd>
1.106 rillig 378: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 379: </dl></dd>
1.106 rillig 380: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
381: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 382: <dd><dl>
1.106 rillig 383: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
384: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
385: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
386: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
387: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
388: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
389: </dl></dd>
390: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
391: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
392: <dd><dl>
393: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
394: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
395: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
396: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 397: </dl></dd>
1.75 rillig 398: </dl></dd>
399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
400: <dd><dl>
1.106 rillig 401: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 402: <dd><dl>
1.106 rillig 403: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
404: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
405: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 406: <dd><dl>
1.106 rillig 407: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
408: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 409: </dl></dd>
1.106 rillig 410: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
411: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 412: <dd><dl>
1.106 rillig 413: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
414: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 415: </dl></dd>
1.106 rillig 416: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 417: <dd><dl>
1.106 rillig 418: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
419: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 420: </dl></dd>
421: </dl></dd>
1.106 rillig 422: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 423: <dd><dl>
1.106 rillig 424: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
425: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
426: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 427: <dd><dl>
1.106 rillig 428: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
429: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 430: </dl></dd>
431: </dl></dd>
1.106 rillig 432: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 433: <dd><dl>
1.106 rillig 434: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
435: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 436: </dl></dd>
437: </dl></dd>
438: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
439: <dd><dl>
440: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
441: <dd><dl>
442: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
443: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
444: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.110 hubertf 445: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 446: </dl></dd>
447: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
448: </dl></dd>
449: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
452: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
453: </dl></dd>
1.76 rillig 454: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
455: <dd><dl>
456: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
457: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
458: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
459: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102 rillig 460: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.108 rillig 461: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
462: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.93 rillig 463: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 464: source packages</a></span></dt>
465: </dl></dd>
1.75 rillig 466: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
467: <dd><dl>
1.79 rillig 468: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 469: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
470: </dl></dd>
471: </dl>
472: </div>
1.82 rillig 473: <div class="list-of-tables">
474: <p><b>List of Tables</b></p>
475: <dl>
476: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
477: </dt>
1.106 rillig 478: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85 jmmv 479: </dt>
1.106 rillig 480: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85 jmmv 481: </dt>
1.82 rillig 482: </dl>
483: </div>
1.75 rillig 484: <div class="chapter" lang="en">
485: <div class="titlepage"><div><div><h2 class="title">
486: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
487: <div class="toc">
488: <p><b>Table of Contents</b></p>
489: <dl>
490: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82 rillig 491: <dd><dl>
492: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
493: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
494: </dl></dd>
1.75 rillig 495: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
496: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88 wiz 497: <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 498: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
499: </dl>
500: </div>
501: <div class="sect1" lang="en">
502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
503: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82 rillig 504: <p>There is a lot of software freely available for Unix-based
505: systems, which is usually available in form of the source code. Before
506: such software can be used, it needs to be configured to the local
507: system, compiled and installed, and this is exactly what The NetBSD
508: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
509: to handle binary packages, so that not every user has to build the
510: packages for himself, which is a time-costly task.</p>
1.75 rillig 511: <p>pkgsrc currently contains several thousand packages,
512: including:</p>
513: <div class="itemizedlist"><ul type="disc">
1.91 rillig 514: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75 rillig 515: web server</p></li>
1.91 rillig 516: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75 rillig 517: web browser</p></li>
1.91 rillig 518: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75 rillig 519: Desktop Environment</p></li>
1.91 rillig 520: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75 rillig 521: Desktop Environment</p></li>
522: </ul></div>
523: <p>...just to name a few.</p>
524: <p>pkgsrc has built-in support for handling varying dependencies,
525: such as pthreads and X11, and extended features such as IPv6 support on
526: a range of platforms.</p>
1.82 rillig 527: <div class="sect2" lang="en">
528: <div class="titlepage"><div><div><h3 class="title">
529: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
530: <p>
531: pkgsrc provides the following key features:
532: </p>
533: <div class="itemizedlist"><ul type="disc">
534: <li><p>Easy building of software from source as well as the creation
535: and installation of binary packages. The source and latest
536: patches are retrieved from a master or mirror download site, checksum
537: verified, then built on your system. Support for binary-only
538: distributions is available for both native platforms and NetBSD
539: emulated platforms.</p></li>
540: <li><p>All packages are installed in a consistent directory tree,
541: including binaries, libraries, man pages and other
542: documentation.</p></li>
543: <li><p>Package dependencies, including when performing package updates,
544: are handled automatically. The configuration files of various
545: packages are handled automatically during updates, so local changes
546: are preserved.</p></li>
547: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
548: consists of highly portable code. This allows the greatest speed of
549: development when porting to new a platform. This portability also
550: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
551: platforms</em></span>.</p></li>
552: <li><p>The installation prefix, acceptable software licenses,
553: international encryption requirements and build-time options for a
554: large number of packages are all set in a simple, central
555: configuration file.</p></li>
556: <li><p>The entire source (not including the distribution files) is
557: freely available under a BSD license, so you may extend and adapt
558: pkgsrc to your needs. Support for local packages and patches is
559: available right out of the box, so you can configure it specifically
560: for your environment.</p></li>
561: </ul></div>
1.91 rillig 562: <p>The following principles are basic to pkgsrc:</p>
563: <div class="itemizedlist"><ul type="disc">
564: <li><p>“<span class="quote">It should only work if it's right.</span>”
1.112 ! weinem 565: — That means, if a package contains bugs, it's better to find
1.91 rillig 566: them and to complain about them rather than to just install the package
567: and hope that it works. There are numerous checks in pkgsrc that try to
568: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
569: of shell scripts), and post-installation checks (installed files,
570: references to shared libraries, script interpreters).</p></li>
571: <li><p>“<span class="quote">If it works, it should work everywhere</span>”
1.112 ! weinem 572: — Like NetBSD has been ported to many hardware architectures,
1.91 rillig 573: pkgsrc has been ported to many operating systems. Care is taken that
574: packages behave the same on all platforms.</p></li>
575: </ul></div>
1.82 rillig 576: </div>
577: <div class="sect2" lang="en">
578: <div class="titlepage"><div><div><h3 class="title">
579: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
580: <p>pkgsrc consists of both a source distribution and a binary
581: distribution for these operating systems. After retrieving the required
582: source or binaries, you can be up and running with pkgsrc in just
583: minutes!</p>
1.75 rillig 584: <p>pkgsrc was derived from FreeBSD's ports system, and
585: initially developed for NetBSD only. Since then, pkgsrc has
586: grown a lot, and now supports the following platforms:</p>
1.82 rillig 587: <div class="table">
588: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91 rillig 589: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82 rillig 590: <colgroup>
591: <col>
592: <col>
593: </colgroup>
594: <thead><tr>
595: <th>Platform</th>
596: <th>Date Support Added</th>
597: </tr></thead>
598: <tbody>
599: <tr>
1.110 hubertf 600: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82 rillig 601: <td align="center">Aug 1997</td>
602: </tr>
603: <tr>
1.110 hubertf 604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82 rillig 605: <td align="center">Mar 1999</td>
606: </tr>
607: <tr>
1.110 hubertf 608: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82 rillig 609: <td align="center">Jun 1999</td>
610: </tr>
611: <tr>
612: <td>
1.110 hubertf 613: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
614: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82 rillig 615: </td>
616: <td align="center">Oct 2001</td>
617: </tr>
618: <tr>
1.110 hubertf 619: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82 rillig 620: <td align="center">Nov 2002</td>
621: </tr>
622: <tr>
1.110 hubertf 623: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82 rillig 624: <td align="center">Nov 2002</td>
625: </tr>
626: <tr>
1.110 hubertf 627: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82 rillig 628: <td align="center">Dec 2002</td>
629: </tr>
630: <tr>
631: <td>BSD/OS</td>
632: <td align="center">Dec 2003</td>
633: </tr>
634: <tr>
1.110 hubertf 635: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82 rillig 636: <td align="center">Dec 2003</td>
637: </tr>
638: <tr>
639: <td>
1.110 hubertf 640: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82 rillig 641: (Microsoft Windows Services for Unix)
642: </td>
643: <td align="center">Mar 2004</td>
644: </tr>
645: <tr>
1.110 hubertf 646: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82 rillig 647: <td align="center">Oct 2004</td>
648: </tr>
649: <tr>
1.110 hubertf 650: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82 rillig 651: <td align="center">Nov 2004</td>
652: </tr>
1.98 wiz 653: <tr>
1.110 hubertf 654: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98 wiz 655: <td align="center">Apr 2007</td>
656: </tr>
1.82 rillig 657: </tbody>
1.91 rillig 658: </table></div>
1.82 rillig 659: </div>
1.91 rillig 660: <br class="table-break">
1.82 rillig 661: </div>
1.75 rillig 662: </div>
663: <div class="sect1" lang="en">
664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
665: <a name="overview"></a>1.2. Overview</h2></div></div></div>
666: <p>This document is divided into three parts. The first,
1.110 hubertf 667: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75 rillig 668: describes how one can use one of the packages in the Package
669: Collection, either by installing a precompiled binary package,
1.93 rillig 670: or by building one's own copy using the NetBSD package system.
1.110 hubertf 671: The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75 rillig 672: package so it can be easily built by other NetBSD users without
673: knowing about the package's building details. The third part,
1.110 hubertf 674: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75 rillig 675: is intended for those who want to understand how pkgsrc is
676: implemented.</p>
677: <p>This document is available in various formats:
1.110 hubertf 678: <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75 rillig 679: </div>
680: <div class="sect1" lang="en">
681: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
682: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
683: <p>There has been a lot of talk about “<span class="quote">ports</span>”,
684: “<span class="quote">packages</span>”, etc. so far. Here is a description of all the
685: terminology used within this document.</p>
686: <div class="variablelist"><dl>
687: <dt><span class="term">Package</span></dt>
688: <dd><p>A set of files and building instructions
689: that describe what's necessary
690: to build a certain piece of software using
691: pkgsrc. Packages are traditionally stored under
1.76 rillig 692: <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75 rillig 693: <dt><span class="term">The NetBSD package system</span></dt>
1.87 wiz 694: <dd><p>This is the former name of “<span class="quote">pkgsrc</span>”. It
695: is part of the NetBSD operating system and can be bootstrapped
696: to run on non-NetBSD operating systems as well. It handles
697: building (compiling), installing, and removing of
698: packages.</p></dd>
1.75 rillig 699: <dt><span class="term">Distfile</span></dt>
700: <dd><p>This term describes the file or files that are
701: provided by the author of the piece of software to
702: distribute his work. All the changes necessary to build on
703: NetBSD are reflected in the corresponding package. Usually
704: the distfile is in the form of a compressed tar-archive,
705: but other types are possible, too. Distfiles are usually
706: stored below
1.76 rillig 707: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75 rillig 708: <dt><span class="term">Port</span></dt>
709: <dd><p>This is the term used by FreeBSD and OpenBSD people
710: for what we call a package.
711: In NetBSD terminology, “<span class="quote">port</span>” refers to a different
712: architecture.</p></dd>
713: <dt><span class="term">Precompiled/binary package</span></dt>
714: <dd>
715: <p>A set of binaries built with pkgsrc from a distfile
1.76 rillig 716: and stuffed together in a single <code class="filename">.tgz</code>
1.75 rillig 717: file so it can be installed on machines of the same
718: machine architecture without the need to
719: recompile. Packages are usually generated in
1.76 rillig 720: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110 hubertf 721: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75 rillig 722: <p>Sometimes, this is referred to by the term “<span class="quote">package</span>” too,
723: especially in the context of precompiled packages.</p>
724: </dd>
725: <dt><span class="term">Program</span></dt>
1.88 wiz 726: <dd><p>The piece of software to be installed which will be
727: constructed from all the files in the distfile by the
728: actions defined in the corresponding package.</p></dd>
1.75 rillig 729: </dl></div>
730: <div class="sect2" lang="en">
731: <div class="titlepage"><div><div><h3 class="title">
1.88 wiz 732: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75 rillig 733: <div class="variablelist"><dl>
734: <dt><span class="term">pkgsrc users</span></dt>
735: <dd>
736: <p>The
737: pkgsrc users are people who use the packages provided by pkgsrc.
738: Typically they are system administrators. The people using the
739: software that is inside the packages (maybe called “<span class="quote">end
740: users</span>”) are not covered by the pkgsrc guide.</p>
741: <p>There are two kinds of pkgsrc users: Some only want to
742: install pre-built binary packages. Others build the pkgsrc
743: packages from source, either for installing them directly or for
1.110 hubertf 744: building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, “The pkgsrc user's guide”</a> should provide all necessary
1.75 rillig 745: documentation.</p>
746: </dd>
747: <dt><span class="term">package maintainers</span></dt>
748: <dd><p>A
1.110 hubertf 749: package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a>.</p></dd>
1.75 rillig 750: <dt><span class="term">infrastructure developers</span></dt>
751: <dd><p>These people are involved in all those files
1.76 rillig 752: that live in the <code class="filename">mk/</code> directory and below.
1.110 hubertf 753: Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, “The pkgsrc infrastructure internals”</a>, though others might be curious,
1.75 rillig 754: too.</p></dd>
755: </dl></div>
756: </div>
757: </div>
758: <div class="sect1" lang="en">
759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
760: <a name="typography"></a>1.4. Typography</h2></div></div></div>
761: <p>When giving examples for commands, shell prompts are used to
762: show if the command should/can be issued as root, or if
763: “<span class="quote">normal</span>” user privileges are sufficient. We use a
764: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
765: shell prompt, assuming they use the C-shell or tcsh.</p>
766: </div>
767: </div>
768: <div class="part" lang="en">
769: <div class="titlepage"><div><div><h1 class="title">
770: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
771: <div class="toc">
772: <p><b>Table of Contents</b></p>
773: <dl>
774: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
775: <dd><dl>
776: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
777: <dd><dl>
778: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
779: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 780: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 781: </dl></dd>
782: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
783: <dd><dl>
784: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
785: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
786: </dl></dd>
787: </dl></dd>
788: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
789: <dd><dl>
1.82 rillig 790: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
791: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
792: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
793: <dd><dl>
794: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
795: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
796: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
797: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
798: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
799: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
800: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 801: </dl></dd>
802: </dl></dd>
803: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
804: <dd><dl>
805: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
806: <dd><dl>
807: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
808: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 809: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
810: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
811: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
812: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
813: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
814: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 815: </dl></dd>
816: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
817: <dd><dl>
818: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
819: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
820: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
821: </dl></dd>
822: </dl></dd>
823: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
824: <dd><dl>
825: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
826: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 827: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 828: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 829: <dd><dl>
1.103 wiz 830: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
831: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
832: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88 wiz 833: </dl></dd>
1.103 wiz 834: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
835: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 836: </dl></dd>
837: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
838: <dd><dl>
839: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
840: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106 rillig 841: </dl></dd>
842: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
843: builds)</a></span></dt>
1.75 rillig 844: <dd><dl>
1.106 rillig 845: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
846: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
847: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
848: <dd><dl>
849: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
850: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
851: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
852: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
853: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
854: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
855: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
856: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
857: </dl></dd>
858: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
859: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
860: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
861: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
862: </dl></dd>
863: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
864: <dd><dl>
865: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
866: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
867: </dl></dd>
868: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
869: <dd><dl>
870: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
871: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
872: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
873: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
874: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
875: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
876: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.110 hubertf 877: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 878: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
879: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 880: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.106 rillig 881: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
882: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
883: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
884: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
885: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
886: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
887: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 888: </dl></dd>
889: </dl>
890: </div>
891: <div class="chapter" lang="en">
892: <div class="titlepage"><div><div><h2 class="title">
893: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
894: <div class="toc">
895: <p><b>Table of Contents</b></p>
896: <dl>
897: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
898: <dd><dl>
899: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
900: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97 rillig 901: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75 rillig 902: </dl></dd>
903: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
904: <dd><dl>
905: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
906: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
907: </dl></dd>
908: </dl>
909: </div>
1.91 rillig 910: <p>Before you download and extract the files, you need to decide
911: where you want to extract them. When using pkgsrc as root user, pkgsrc
912: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
913: free to install the sources and binary packages wherever you want in
914: your filesystem, provided that the pathname does not contain white-space
915: or other characters that are interpreted specially by the shell and some
916: other programs. A safe bet is to use only letters, digits, underscores
917: and dashes.</p>
1.75 rillig 918: <div class="sect1" lang="en">
919: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
920: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
921: <p>Before you download any pkgsrc files, you should decide
922: whether you want the <span class="emphasis"><em>current</em></span> branch or the
923: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
924: quarterly basis from the current branch and only gets modified
925: for security updates. The names of the stable branches are built
926: from the year and the quarter, for example
1.112 ! weinem 927: <code class="literal">2007Q4</code>.</p>
1.75 rillig 928: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
929: want to download pkgsrc. You can get it as a tar file, via SUP,
930: or via CVS. All three ways are described here.</p>
931: <div class="sect2" lang="en">
932: <div class="titlepage"><div><div><h3 class="title">
933: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
934: <p>The primary download location for all pkgsrc files is
1.110 hubertf 935: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75 rillig 936: number of subdirectories for different purposes, which are
1.110 hubertf 937: described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.75 rillig 938: <p>The tar file for the current branch is in the directory
1.110 hubertf 939: <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75 rillig 940: It is autogenerated daily.</p>
1.112 ! weinem 941: <p>The tar file for the stable branch 2007Q4 is in the
! 942: directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
! 943: <p>To download a pkgsrc stable tarball, run:</p>
! 944: <pre class="screen">
! 945: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
! 946: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
! 947: stable branch to be downloaded, for example,
! 948: “<span class="quote">pkgsrc-2007Q4</span>”.</p>
! 949: <p>Then, extract it with:</p>
! 950: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
! 951: <p>This will create the directory <code class="filename">pkgsrc/</code>
! 952: in <code class="filename">/usr/</code> and all the package source will be
! 953: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
! 954: <p>To download pkgsrc-current, run:</p>
! 955: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75 rillig 956: </div>
957: <div class="sect2" lang="en">
958: <div class="titlepage"><div><div><h3 class="title">
959: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
960: <p>As an alternative to the tar file, you can get pkgsrc via
961: the Software Update Protocol, SUP. To do so, make sure your
962: supfile has a line
1.1 grant 963:
1.75 rillig 964: </p>
965: <pre class="programlisting">
1.100 rillig 966: release=pkgsrc
1.1 grant 967: </pre>
1.75 rillig 968: <p>
1.1 grant 969:
1.75 rillig 970: in it, see the examples in
1.76 rillig 971: <code class="filename">/usr/share/examples/supfiles</code>, and that the
972: <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.110 hubertf 973: run <span class="command"><strong>sup -v
1.75 rillig 974: <em class="replaceable"><code>/path/to/your/supfile</code></em></strong></span>.</p>
975: </div>
976: <div class="sect2" lang="en">
977: <div class="titlepage"><div><div><h3 class="title">
1.97 rillig 978: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112 ! weinem 979: <p>To do an initial (full) checkout of pkgsrc, you first
1.75 rillig 980: have to set some environment variables. For the C-Shell,
981: type:</p>
982: <pre class="screen">
983: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
984: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
985: </pre>
986: <p>Or, the same for the bourne shell:</p>
987: <pre class="screen">
1.112 ! weinem 988: <code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
! 989: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75 rillig 990: </pre>
1.101 rillig 991: <p>By default, cvs doesn't do things like most people would
1.112 ! weinem 992: expect it to do. But there is a
1.101 rillig 993: way to convince cvs, by creating a file called
994: <code class="filename">.cvsrc</code> in your home directory and saving
995: the following lines to it. This file will save you lots of
996: headache and some bug reports, so we strongly recommend it. You
997: can find an explanation of this file in the CVS
998: documentation.</p>
999: <pre class="programlisting">
1000: # recommended CVS configuration file from the pkgsrc guide
1001: checkout -P
1.103 wiz 1002: update -dP
1.101 rillig 1003: release -d
1.103 wiz 1004: diff -upN
1.101 rillig 1005: cvs -q -z3
1006: rdiff -u
1007: </pre>
1.112 ! weinem 1008: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
! 1009: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
! 1010: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
! 1011: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable
! 1012: branch to be checked out, for example, “<span class="quote">pkgsrc-2007Q4</span>”</p>
! 1013: <p>This will create the directory <code class="filename">pkgsrc/</code>
! 1014: in your <code class="filename">/usr/</code> directory and all the package source
! 1015: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
! 1016: <p>To fetch the pkgsrc current branch, run:</p>
! 1017: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
! 1018: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r -P pkgsrc</code></strong></pre>
1.75 rillig 1019: </div>
1020: </div>
1021: <div class="sect1" lang="en">
1022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1023: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1024: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1025: (which also works if you have first installed it via a tar
1026: file). It saves bandwidth and hard disk activity, compared to
1027: downloading the tar file again.</p>
1028: <div class="sect2" lang="en">
1029: <div class="titlepage"><div><div><h3 class="title">
1030: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1031: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1032: <h3 class="title">Warning</h3>
1.77 rillig 1033: <p>When updating from a tar file, you first need to
1034: completely remove the old pkgsrc directory. Otherwise those
1035: files that have been removed from pkgsrc in the mean time will
1036: not be removed on your local disk, resulting in inconsistencies.
1037: When removing the old files, any changes that you have done to
1038: the pkgsrc files will be lost after updating. Therefore updating
1039: via CVS is strongly recommended.</p>
1.75 rillig 1040: </div>
1.82 rillig 1041: <p>Note that by default the distfiles and the binary packages
1042: are saved in the pkgsrc tree, so don't forget to rescue them
1043: before updating. You can also configure pkgsrc to use other than
1044: the default directories by setting the
1045: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110 hubertf 1046: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75 rillig 1047: <p>To update pkgsrc from a tar file, download the tar file as
1048: explained above. Then, make sure that you have not made any
1049: changes to the files in the pkgsrc directory. Remove the pkgsrc
1050: directory and extract the new tar file. Done.</p>
1051: </div>
1052: <div class="sect2" lang="en">
1053: <div class="titlepage"><div><div><h3 class="title">
1054: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1055: <p>To update pkgsrc via CVS, make sure the environment
1056: variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.112 ! weinem 1057: change to the pkgsrc directory and run:</p>
! 1058: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75 rillig 1059: <div class="sect3" lang="en">
1060: <div class="titlepage"><div><div><h4 class="title">
1061: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1062: <p>When updating pkgsrc, the CVS program keeps track of the
1063: branch you selected. But if you, for whatever reason, want to
1064: switch from the stable branch to the current one, you can do it
1065: by adding the option “<span class="quote">-A</span>” after the
1066: “<span class="quote">update</span>” keyword. To switch from the current branch
1067: back to the stable branch, add the
1.98 wiz 1068: “<span class="quote">-rpkgsrc-2007Q1</span>” option.</p>
1.75 rillig 1069: </div>
1070: <div class="sect3" lang="en">
1071: <div class="titlepage"><div><div><h4 class="title">
1072: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1073: <p>When you update pkgsrc, the CVS program will only touch
1074: those files that are registered in the CVS repository. That
1075: means that any packages that you created on your own will stay
1076: unmodified. If you change files that are managed by CVS, later
1077: updates will try to merge your changes with those that have been
1078: done by others. See the CVS manual, chapter
1079: “<span class="quote">update</span>” for details.</p>
1080: </div>
1081: </div>
1082: </div>
1083: </div>
1084: <div class="chapter" lang="en">
1085: <div class="titlepage"><div><div><h2 class="title">
1086: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1087: <div class="toc">
1088: <p><b>Table of Contents</b></p>
1089: <dl>
1.82 rillig 1090: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1091: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1092: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1093: <dd><dl>
1094: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1095: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1096: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1097: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1098: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1099: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1100: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75 rillig 1101: </dl></dd>
1102: </dl>
1103: </div>
1104: <div class="sect1" lang="en">
1105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1106: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110 hubertf 1107: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.82 rillig 1108: </div>
1109: <div class="sect1" lang="en">
1110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1111: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1112: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75 rillig 1113: <pre class="screen">
1114: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1115: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87 wiz 1116: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1117: </pre>
1.110 hubertf 1118: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.87 wiz 1119: pkgsrc before bootstrapping. The given
1.110 hubertf 1120: <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87 wiz 1121: <code class="filename">/usr/pkg</code> for the
1122: <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1123: and <code class="filename">/var/db/pkg</code> for the package database
1124: directory where pkgsrc will do its internal bookkeeping.
1125: However, these can also be set using command-line
1126: arguments.</p>
1.75 rillig 1127: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1128: <h3 class="title">Note</h3>
1.110 hubertf 1129: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1130: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1131: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87 wiz 1132: instead of “<span class="quote">make</span>”.</p>
1.75 rillig 1133: </div>
1134: </div>
1135: <div class="sect1" lang="en">
1136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82 rillig 1137: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75 rillig 1138: <p>Here are some platform-specific notes you should be aware of.</p>
1139: <div class="sect2" lang="en">
1140: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1141: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85 jmmv 1142: <p>Darwin 5.x and up are supported. There are two methods of using
1.110 hubertf 1143: pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
1144: image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75 rillig 1145: partition</a>.</p>
1146: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110 hubertf 1147: Tools from Apple's Developer Connection. See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.87 wiz 1148: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110 hubertf 1149: from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.87 wiz 1150: if you intend to build packages that use the X11 Window System.</p>
1.89 rillig 1151: <p>If you already have a UFS or HFSX partition, or have a spare partition
1152: that you can format as UFS or HFSX, it is recommended to use that instead of
1.87 wiz 1153: the disk image. It'll be somewhat faster and will mount automatically
1154: at boot time, where you must manually mount a disk image.</p>
1.75 rillig 1155: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1156: <h3 class="title">Note</h3>
1.85 jmmv 1157: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89 rillig 1158: 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 1159: </div>
1160: <div class="sect3" lang="en">
1161: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1162: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75 rillig 1163: <p>Create the disk image:</p>
1164: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95 tron 1165: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85 jmmv 1166: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75 rillig 1167: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85 jmmv 1168: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1169: <h3 class="title">Note</h3>
1.109 rillig 1170: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid. In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page. In the case of HFSX, it will disable journaling.</p>
1.85 jmmv 1171: </div>
1.89 rillig 1172: <p>Allow suid:</p>
1173: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105 weinem 1174: <p>Changing the build directory:</p>
1175: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
1176: <pre class="programlisting">
1177: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1178: </pre>
1.75 rillig 1179: </div>
1180: <div class="sect3" lang="en">
1181: <div class="titlepage"><div><div><h4 class="title">
1.89 rillig 1182: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76 rillig 1183: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87 wiz 1184: system, normally HFS+. It is possible to use the default
1185: <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
1186: by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89 rillig 1187: or HFSX file system. Obviously, another symlink is required if you want to
1.87 wiz 1188: place the package database directory outside the
1189: <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75 rillig 1190: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
1191: <p>If you created your partitions at the time of installing Mac OS X
1.89 rillig 1192: and formatted the target partition as UFS or HFSX, it should automatically
1.87 wiz 1193: mount on <code class="filename">/Volumes/<volume name></code> when the
1.89 rillig 1194: machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87 wiz 1195: to ensure that the partition map correctly reflects
1.89 rillig 1196: “<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 1197: <p>The problem is that none of the disk tools will let you touch a
1.87 wiz 1198: disk that is booted from. You can unmount the partition, but even if
1199: you newfs it, the partition type will be incorrect and the
1200: automounter won't mount it. It can be mounted manually, but it won't
1201: appear in Finder.</p>
1.75 rillig 1202: <p>You'll need to boot off of the OS X Installation (User) CD. When
1.87 wiz 1203: the Installation program starts, go up to the menu and select Disk
1204: Utility. Now, you will be able to select the partition you want
1.89 rillig 1205: to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
1206: installer which will reboot your machine. The new UFS or HFSX file system
1.87 wiz 1207: will appear in Finder.</p>
1.75 rillig 1208: <p>Be aware that the permissions on the new file system will be writable
1.87 wiz 1209: by root only.</p>
1.75 rillig 1210: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87 wiz 1211: Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75 rillig 1212: </div>
1213: </div>
1214: <div class="sect2" lang="en">
1215: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1216: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87 wiz 1217: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1218: other versions may work.</p>
1.75 rillig 1219: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1220: with the FreeBSD userland tools. There are several steps:</p>
1.75 rillig 1221: <div class="orderedlist"><ol type="1">
1222: <li><p>FreeBSD stores its ports pkg database in
1.87 wiz 1223: <code class="filename">/var/db/pkg</code>. It is therefore
1224: recommended that you choose a different location (e.g.
1225: <code class="filename">/usr/pkgdb</code>) by
1226: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1227: <li>
1228: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87 wiz 1229: good idea to move them out of the way to avoid confusion, e.g.</p>
1230: <pre class="screen">
1231: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1232: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1233: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1234: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1235: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1236: </pre>
1.75 rillig 1237: </li>
1.110 hubertf 1238: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1239: <code class="filename">/etc/mk.conf.example</code> file
1240: when you use the bootstrap script.</p></li>
1.75 rillig 1241: </ol></div>
1242: </div>
1243: <div class="sect2" lang="en">
1244: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1245: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75 rillig 1246: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87 wiz 1247: providing a Unix-like environment with a tighter kernel integration than
1248: available with Cygwin. It is part of the Windows Services for Unix
1249: package, available for free for any licensed copy of Windows 2000, XP
1.110 hubertf 1250: (not including XP Home), or 2003. SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93 rillig 1251: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1252: are not officially supported. (The main difference in 3.0/3.1 is lack
1253: of pthreads, but other parts of libc may also be lacking.)</p>
1254: <p>Services for Unix Applications (aka SUA) is an integrated component
1255: of Windows Server 2003 R2 and Windows Vista. As of this writing, SUA's
1.95 tron 1256: Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75 rillig 1257: <div class="sect3" lang="en">
1258: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1259: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75 rillig 1260: <p>At an absolute minimum, the following packages must be installed from
1.87 wiz 1261: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75 rillig 1262: <div class="itemizedlist"><ul type="disc">
1263: <li><p>Utilities -> Base Utilities</p></li>
1264: <li><p>Interix GNU Components -> (all)</p></li>
1265: <li><p>Remote Connectivity</p></li>
1266: <li><p>Interix SDK</p></li>
1267: </ul></div>
1268: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87 wiz 1269: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1270: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1271: pkgsrc (or from a binary package).</p>
1.75 rillig 1272: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87 wiz 1273: not need to be installed, but Remote Connectivity itself should be
1274: installed in order to have a working inetd.</p>
1.75 rillig 1275: <p>During installation you may be asked whether to enable setuid
1.87 wiz 1276: behavior for Interix programs, and whether to make pathnames default to
1277: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1278: enabled. (Without case-sensitivity, a large number of packages including
1279: perl will not build.)</p>
1.75 rillig 1280: <p>NOTE: Newer Windows service packs change the way binary execution
1.87 wiz 1281: works (via the Data Execution Prevention feature). In order to use
1282: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1283: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1284: must be installed. Hotfixes are available from Microsoft through a
1285: support contract; however, a NetBSD developer has made most Interix
1.110 hubertf 1286: hotfixes available for personal use from <a class="ulink" href="http://www.duh.org/interix/hotfixes.php" target="_top">http://www.duh.org/interix/hotfixes.php</a>.</p>
1.93 rillig 1287: <p>In addition to the hotfix noted above, it may be necessary to
1288: disable Data Execution Prevention entirely to make Interix functional.
1289: This may happen only with certain types of CPUs; the cause is not fully
1290: understood at this time. If gcc or other applications still segfault
1291: repeatedly after installing one of the hotfixes note above, the
1292: following option can be added to the appropriate "boot.ini" line on the
1293: Windows boot drive: /NoExecute=AlwaysOff
1294: (WARNING, this will disable DEP completely, which may be a security
1295: risk if applications are often run as a user in the Administrators
1296: group!)</p>
1.75 rillig 1297: </div>
1298: <div class="sect3" lang="en">
1299: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1300: <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 1301: <p>If SFU is already installed and you wish to alter these settings to work
1.87 wiz 1302: with pkgsrc, note the following things.</p>
1.75 rillig 1303: <div class="itemizedlist"><ul type="disc">
1304: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87 wiz 1305: Windows Services for UNIX, then click Change. In the installer, choose
1306: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.75 rillig 1307: <li>
1308: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87 wiz 1309: change the following registry key:</p>
1.75 rillig 1310: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1311: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1312: </li>
1313: <li>
1314: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87 wiz 1315: following registry key:</p>
1.75 rillig 1316: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1317: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1318: </li>
1319: </ul></div>
1320: </div>
1321: <div class="sect3" lang="en">
1322: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1323: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75 rillig 1324: <p>The package manager (either the pkgsrc "su" user, or the user
1.87 wiz 1325: running "pkg_add") must be a member of the local Administrators
1326: group. Such a user must also be used to run the bootstrap. This is
1327: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75 rillig 1328: <p>The package manager should use a umask of 002. "make install" will
1.87 wiz 1329: automatically complain if this is not the case. This ensures that
1330: directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75 rillig 1331: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87 wiz 1332: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1333: NOT be used in conjunction with pkgsrc. If you choose to use them at
1334: the same time as the pkgsrc packages, ensure that you use the proper
1335: pkg_* tools for each type of binary package.</p>
1.75 rillig 1336: <p>The TERM setting used for DOS-type console windows (including those
1.87 wiz 1337: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1338: don't have a termcap/terminfo entry for it, but the following .termcap
1339: entry provides adequate emulation in most cases:</p>
1.75 rillig 1340: <pre class="programlisting">
1.100 rillig 1341: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87 wiz 1342: </pre>
1.75 rillig 1343: </div>
1344: <div class="sect3" lang="en">
1345: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1346: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75 rillig 1347: <p>Though Interix suffices as a familiar and flexible substitute
1.87 wiz 1348: for a full Unix-like platform, it has some drawbacks that should
1349: be noted for those desiring to make the most of Interix.</p>
1.75 rillig 1350: <div class="itemizedlist"><ul type="disc">
1351: <li>
1352: <p><span class="strong"><strong>X11:</strong></span></p>
1353: <p>Interix comes with the standard set of X11R6 client libraries,
1.87 wiz 1354: and can run X11 based applications, but it does
1355: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.110 hubertf 1356: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1357: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87 wiz 1358: (available in a trimmed version for Interix from Interop Systems as the
1.110 hubertf 1359: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87 wiz 1360: and the free X11 server included with
1.110 hubertf 1361: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75 rillig 1362: </li>
1363: <li>
1364: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1365: <p>Because Interix runs in a completely different NT subsystem from
1.87 wiz 1366: Win32 applications, it does not currently support various X11
1367: protocol extensions for acceleration (such as MIT-SHM or DGA).
1368: Most interactive applications to a local X server will run
1369: reasonably fast, but full motion video and other graphics
1370: intensive applications may require a faster-than-expected CPU.</p>
1.75 rillig 1371: </li>
1372: <li>
1373: <p><span class="strong"><strong>Audio:</strong></span></p>
1374: <p>Interix has no native support for audio output. For audio
1.110 hubertf 1375: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87 wiz 1376: audio system on Interix. Unlike on most platforms, the
1.91 rillig 1377: <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.110 hubertf 1378: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87 wiz 1379: server component. To output audio via an Interix host, the
1.91 rillig 1380: <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 1381: must also be installed.</p>
1.75 rillig 1382: </li>
1383: <li>
1384: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1385: <p>Direct device access is not currently supported in Interix, so it
1.87 wiz 1386: is not currently possible to access CD/DVD drives, USB devices,
1387: or SCSI devices through non-filesystem means. Among other things,
1388: this makes it impossible to use Interix directly for CD/DVD
1389: burning.</p>
1.75 rillig 1390: </li>
1391: <li>
1392: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1393: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87 wiz 1394: drives are also not directly accessible in Interix. However,
1395: support is in work to make tape drive access possible by using
1396: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1397: esound server).</p>
1.75 rillig 1398: </li>
1399: </ul></div>
1400: </div>
1401: <div class="sect3" lang="en">
1402: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1403: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75 rillig 1404: <p>It is not necessary, in general, to have a "root" user on the
1.87 wiz 1405: Windows system; any member of the local Administrators group will
1406: suffice. However, some packages currently assume that the user
1407: named "root" is the privileged user. To accommodate these, you
1408: may create such a user; make sure it is in the local group
1409: Administrators (or your language equivalent).</p>
1.110 hubertf 1410: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87 wiz 1411: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1412: time being, install packages as the local Administrator (or
1413: your language equivalent), or run the following command after
1414: installing a package to work around the issue:</p>
1.75 rillig 1415: <pre class="screen">
1.87 wiz 1416: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1417: </pre>
1.75 rillig 1418: </div>
1419: </div>
1420: <div class="sect2" lang="en">
1421: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1422: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75 rillig 1423: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87 wiz 1424: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1425: according to your preference. If you do not have a license for the MIPSpro
1.110 hubertf 1426: compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75 rillig 1427: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110 hubertf 1428: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87 wiz 1429: etc.</p>
1.86 schwarz 1430: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1.75 rillig 1431: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1432: you start out using "abi=n32", that's what all your packages will be built
1433: with.</p>
1434: <p>Therefore, please make sure that you have no conflicting
1.87 wiz 1435: <code class="varname">CFLAGS</code> in your environment or the
1.110 hubertf 1436: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.87 wiz 1437: try to link n32 object files with lib64 or vice versa. Check your
1438: <code class="filename">/etc/compiler.defaults</code>!</p>
1.75 rillig 1439: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87 wiz 1440: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1441: as it appears that IRIX linker occasionally runs into issues when trying to
1442: link over a network-mounted file system.</p>
1.75 rillig 1443: <p>The bootstrapping process should set all the right options for programs such
1.87 wiz 1444: as imake(1), but you may want to set some options depending on your local
1445: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1446: course, your compiler's man pages for details.</p>
1.75 rillig 1447: <p>If you are using SGI's MIPSPro compiler, please set
1.1 grant 1448:
1.87 wiz 1449: </p>
1.75 rillig 1450: <pre class="programlisting">
1.100 rillig 1451: PKGSRC_COMPILER= mipspro
1.87 wiz 1452: </pre>
1.75 rillig 1453: <p>
1.1 grant 1454:
1.110 hubertf 1455: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.87 wiz 1456: are using gcc and may end up passing invalid flags to the compiler. Note that
1457: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1458: default.</p>
1.75 rillig 1459: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93 rillig 1460: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87 wiz 1461: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1462: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1463: '--preserve-path' flag.</p>
1.75 rillig 1464: </div>
1465: <div class="sect2" lang="en">
1466: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1467: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87 wiz 1468: <p>Some versions of Linux (for example Debian GNU/Linux) need
1469: either libtermcap or libcurses (libncurses). Installing the
1470: distributions libncurses-dev package (or equivalent) should fix
1471: the problem.</p>
1472: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1473: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1474: i386 have been tested.</p>
1.75 rillig 1475: <p>To bootstrap using icc, assuming the default icc installation
1.87 wiz 1476: directory:</p>
1.75 rillig 1477: <pre class="programlisting">
1.100 rillig 1478: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1479: ac_cv___attribute__=yes ./bootstrap
1.87 wiz 1480: </pre>
1.75 rillig 1481: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1482: <h3 class="title">Note</h3>
1483: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1484: </div>
1485: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87 wiz 1486: function, which icc does not support. #undef'ing __attribute__ has the
1487: unfortunate side-effect of breaking many of the Linux header files, which
1488: cannot be compiled properly without __attribute__. The test must be
1489: overridden so that __attribute__ is assumed supported by the
1490: compiler.</p>
1.75 rillig 1491: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110 hubertf 1492: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1493: <pre class="programlisting">
1.100 rillig 1494: PKGSRC_COMPILER= icc
1.87 wiz 1495: </pre>
1.75 rillig 1496: <p>The default installation directory for icc is
1.87 wiz 1497: <code class="filename">/opt/intel_cc_80</code>, which
1498: is also the pkgsrc default. If you have installed it into a different
1499: directory, set <code class="varname">ICCBASE</code> in
1.110 hubertf 1500: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 1501: <pre class="programlisting">
1.100 rillig 1502: ICCBASE= /opt/icc
1.87 wiz 1503: </pre>
1.75 rillig 1504: <p>pkgsrc uses the static linking method of the runtime libraries
1.87 wiz 1505: provided by icc, so binaries can be run on other systems which do not
1506: have the shared libraries installed.</p>
1507: <p>Libtool, however, extracts a list of libraries from the
1.110 hubertf 1508: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87 wiz 1509: records it, throwing away the -Bstatic and -Bdynamic options
1510: interspersed between the libraries. This means that
1511: libtool-linked C++ shared libraries will have a runtime
1512: dependency on the icc libraries until this is fixed in
1513: libtool.</p>
1.75 rillig 1514: </div>
1515: <div class="sect2" lang="en">
1516: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1517: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75 rillig 1518: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1519: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87 wiz 1520: with the OpenBSD userland tools. There are several steps:</p>
1.75 rillig 1521: <div class="orderedlist"><ol type="1">
1522: <li><p>OpenBSD stores its ports pkg database in
1.87 wiz 1523: <code class="filename">/var/db/pkg</code>. It is therefore
1524: recommended that you choose a different location (e.g.
1525: <code class="filename">/usr/pkgdb</code>) by
1526: using the --pkgdbdir option to the bootstrap script.</p></li>
1.75 rillig 1527: <li>
1528: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87 wiz 1529: good idea to move them out of the way to avoid confusion, e.g.</p>
1530: <pre class="screen">
1531: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75 rillig 1532: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1533: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1534: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87 wiz 1535: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1536: </pre>
1.75 rillig 1537: </li>
1538: <li>
1.110 hubertf 1539: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87 wiz 1540: <code class="filename">/etc/mk.conf.example</code> file
1541: when you use the bootstrap script. OpenBSD's make program uses
1.110 hubertf 1542: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87 wiz 1543: as well. You can work around this by enclosing all the pkgsrc-specific parts
1544: of the file with:</p>
1545: <pre class="programlisting">
1.100 rillig 1546: .ifdef BSD_PKG_MK
1547: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1548: .else
1549: # OpenBSD stuff
1550: .endif
1.87 wiz 1551: </pre>
1.75 rillig 1552: </li>
1553: </ol></div>
1554: </div>
1555: <div class="sect2" lang="en">
1556: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1557: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75 rillig 1558: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87 wiz 1559: You will need a working C compiler. Both gcc 2.95.3 and
1560: Sun WorkShop 5 have been tested.</p>
1.75 rillig 1561: <p>The following packages are required on Solaris 8 for the bootstrap
1.87 wiz 1562: process and to build packages.</p>
1.75 rillig 1563: <div class="itemizedlist"><ul type="disc">
1564: <li><p>SUNWsprot</p></li>
1565: <li><p>SUNWarc</p></li>
1566: <li><p>SUNWbtool</p></li>
1567: <li><p>SUNWtoo</p></li>
1568: <li><p>SUNWlibm</p></li>
1569: </ul></div>
1.78 rillig 1570: <p>Please note that the use of GNU binutils on Solaris is
1.87 wiz 1571: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75 rillig 1572: <p>Whichever compiler you use, please ensure the compiler tools and
1.87 wiz 1573: your $prefix are in your <code class="varname">PATH</code>. This includes
1574: <code class="filename">/usr/ccs/{bin,lib}</code>
1575: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75 rillig 1576: <div class="sect3" lang="en">
1577: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1578: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75 rillig 1579: <p>It makes life much simpler if you only use the same gcc consistently
1.87 wiz 1580: for building all packages.</p>
1.75 rillig 1581: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87 wiz 1582: then either build gcc from
1.91 rillig 1583: <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 1584: package, then remove gcc used during bootstrapping.</p>
1.110 hubertf 1585: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75 rillig 1586: </div>
1587: <div class="sect3" lang="en">
1588: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1589: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75 rillig 1590: <p>You will need at least the following packages installed (from WorkShop
1.87 wiz 1591: 5.0)</p>
1.75 rillig 1592: <div class="itemizedlist"><ul type="disc">
1593: <li><p>SPROcc
1.87 wiz 1594: - Sun WorkShop Compiler C 5.0</p></li>
1.75 rillig 1595: <li><p>SPROcpl
1.87 wiz 1596: - Sun WorkShop Compiler C++ 5.0</p></li>
1.75 rillig 1597: <li><p>SPROild
1.87 wiz 1598: - Sun WorkShop Incremental Linker</p></li>
1.75 rillig 1599: <li><p>SPROlang
1.87 wiz 1600: - Sun WorkShop Compilers common components</p></li>
1.75 rillig 1601: </ul></div>
1.96 rillig 1602: <p>You should set the following variables in your
1.110 hubertf 1603: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96 rillig 1604: <pre class="programlisting">
1.100 rillig 1605: CC= cc
1606: CXX= CC
1607: CPP= cc -E
1608: CXXCPP= CC -E
1.96 rillig 1609: </pre>
1610: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1611: <h3 class="title">Note</h3>
1612: <p>The <code class="varname">CPP</code> setting might break some
1613: packages that use the C preprocessor for processing things other
1614: than C source code.</p>
1615: </div>
1.75 rillig 1616: </div>
1617: <div class="sect3" lang="en">
1618: <div class="titlepage"><div><div><h4 class="title">
1.93 rillig 1619: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96 rillig 1620: <p>To build 64-bit packages, you just need to have the
1.110 hubertf 1621: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75 rillig 1622: <pre class="programlisting">
1.100 rillig 1623: PKGSRC_COMPILER= sunpro
1624: ABI= 64
1.96 rillig 1625: </pre>
1626: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1627: <h3 class="title">Note</h3>
1628: <p>This setting has been tested for the SPARC
1629: architecture. Intel and AMD machines need some more
1630: work.</p>
1631: </div>
1.75 rillig 1632: </div>
1633: <div class="sect3" lang="en">
1634: <div class="titlepage"><div><div><h4 class="title">
1.82 rillig 1635: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110 hubertf 1636: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87 wiz 1637: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1638: The workaround is to use another shell for the configure
1.91 rillig 1639: 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.110 hubertf 1640: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87 wiz 1641: <pre class="programlisting">
1.100 rillig 1642: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1643: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1.87 wiz 1644: </pre>
1.91 rillig 1645: <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 1646: </div>
1647: </div>
1648: </div>
1649: </div>
1650: <div class="chapter" lang="en">
1651: <div class="titlepage"><div><div><h2 class="title">
1652: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1653: <div class="toc">
1654: <p><b>Table of Contents</b></p>
1655: <dl>
1656: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1657: <dd><dl>
1658: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1659: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82 rillig 1660: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1661: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1662: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1663: <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>
1664: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1665: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75 rillig 1666: </dl></dd>
1667: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1668: <dd><dl>
1669: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1670: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1671: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1672: </dl></dd>
1673: </dl>
1674: </div>
1675: <p>Basically, there are two ways of using pkgsrc. The first
1.88 wiz 1676: is to only install the package tools and to use binary packages
1677: that someone else has prepared. This is the “<span class="quote">pkg</span>”
1678: in pkgsrc. The second way is to install the “<span class="quote">src</span>”
1679: of pkgsrc, too. Then you are able to build your own packages,
1680: and you can still use binary packages from someone else.</p>
1.75 rillig 1681: <div class="sect1" lang="en">
1682: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1683: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110 hubertf 1684: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109 rillig 1685: server and its mirrors, there are collections of binary packages,
1686: ready to be installed. These binary packages have been built using the
1687: default settings for the directories, that is:</p>
1688: <div class="itemizedlist"><ul type="disc">
1689: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1690: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1691: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1692: </ul></div>
1693: <p>If you cannot use these directories for whatever reasons (maybe
1694: because you're not root), you cannot use these binary packages, but
1.110 hubertf 1695: have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, “Bootstrapping pkgsrc”</a>.</p>
1.75 rillig 1696: <div class="sect2" lang="en">
1697: <div class="titlepage"><div><div><h3 class="title">
1698: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105 weinem 1699: <p>To install binary packages, you first need to know from where
1700: to get them. The first place where you should look is on the main
1.110 hubertf 1701: pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105 weinem 1702: <p>This directory contains binary packages for multiple
1703: platforms. First, select your operating system. (Ignore the
1704: directories with version numbers attached to it, they just exist for
1705: legacy reasons.) Then, select your hardware architecture, and in the
1.109 rillig 1706: third step, the OS version and the “<span class="quote">version</span>” of pkgsrc.</p>
1707: <p>In this directory, you often find a file called
1708: <code class="filename">bootstrap.tar.gz</code> which contains the package
1709: management tools. If the file is missing, it is likely that your
1710: operating system already provides those tools. Download the file and
1711: extract it in the <code class="filename">/</code> directory. It will create
1712: the directories <code class="filename">/usr/pkg</code> (containing the tools
1713: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1714: (the database of installed packages).</p>
1.75 rillig 1715: </div>
1716: <div class="sect2" lang="en">
1717: <div class="titlepage"><div><div><h3 class="title">
1718: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109 rillig 1719: <p>In the directory from the last section, there is a
1720: subdirectory called <code class="filename">All</code>, which contains all the
1721: binary packages that are available for the platform, excluding those
1722: that may not be distributed via FTP or CDROM (depending on which
1723: medium you are using), and the ones that have vulnerabilities and
1724: therefore are considered insecure to install without thinking
1725: before.</p>
1726: <p>To install packages directly from an FTP or HTTP server, run
1727: the following commands in a Bourne-compatible shell (be sure to
1.110 hubertf 1728: <span class="command"><strong>su</strong></span> to root first):</p>
1.109 rillig 1729: <pre class="screen">
1730: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1731: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
1732: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1733: </pre>
1734: <p>Instead of URLs, you can also use local paths, for example if
1735: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1736: repository. If you want to install packages from multiple sources,
1737: you can separate them by a semicolon in
1738: <code class="varname">PKG_PATH</code>.</p>
1739: <p>After these preparations, installing a package is very
1740: easy:</p>
1741: <pre class="screen">
1742: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1743: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1744: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1745: </pre>
1.75 rillig 1746: <p>Note that any prerequisite packages needed to run the
1.88 wiz 1747: package in question will be installed, too, assuming they are
1748: present where you install from.</p>
1.109 rillig 1749: <p>As mentioned above, packages for which vulnerabilities get
1750: known are not stored in the <code class="filename">All</code> subdirectory.
1751: They don't get deleted since that could be very frustrating if many
1752: other packages depend on it. Instead, they are moved to the
1753: <code class="filename">vulnerable</code> subdirectory. So you may need to add
1754: this directory to the <code class="varname">PKG_PATH</code> variable.
1755: However, you should run <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> regularly, especially
1756: after installing new packages, and verify that the vulnerabilities
1757: are acceptable for your configuration.</p>
1.75 rillig 1758: <p>After you've installed packages, be sure to have
1.88 wiz 1759: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1760: <code class="varname">PATH</code> so you can actually start the just
1761: installed program.</p>
1.75 rillig 1762: </div>
1763: <div class="sect2" lang="en">
1764: <div class="titlepage"><div><div><h3 class="title">
1.82 rillig 1765: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1766: <p>To deinstall a package, it does not matter whether it was
1.88 wiz 1767: installed from source code or from a binary package. The
1.110 hubertf 1768: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1769: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88 wiz 1770: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1771: name can be given with or without version number. Wildcards can
1772: also be used to deinstall a set of packages, for example
1773: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1774: so that the shell does not expand them before
1775: <code class="literal">pkg_delete</code> sees them.</p>
1.82 rillig 1776: <p>The <code class="option">-r</code> option is very powerful: it
1.88 wiz 1777: removes all the packages that require the package in question
1778: and then removes the package itself. For example:
1.82 rillig 1779:
1.88 wiz 1780: </p>
1.82 rillig 1781: <pre class="screen">
1.88 wiz 1782: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1783: </pre>
1.82 rillig 1784: <p>
1785:
1.88 wiz 1786: will remove jpeg and all the packages that used it; this allows
1787: upgrading the jpeg package.</p>
1.82 rillig 1788: </div>
1789: <div class="sect2" lang="en">
1790: <div class="titlepage"><div><div><h3 class="title">
1791: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110 hubertf 1792: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88 wiz 1793: installed packages or binary package files.</p>
1.82 rillig 1794: </div>
1795: <div class="sect2" lang="en">
1796: <div class="titlepage"><div><div><h3 class="title">
1797: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1798: <p>
1.88 wiz 1799: The NetBSD Security-Officer and Packages Groups maintain a list of
1800: known security vulnerabilities to packages which are (or have been)
1801: included in pkgsrc. The list is available from the NetBSD
1.110 hubertf 1802: FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88 wiz 1803: </p>
1.82 rillig 1804: <p>
1.93 rillig 1805: 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 1806: this list can be downloaded
1807: automatically, and a security audit of all packages installed on a system
1808: can take place.
1809: </p>
1.82 rillig 1810: <p>
1.93 rillig 1811: There are two components to
1.91 rillig 1812: <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 1813: component, “<span class="quote">download-vulnerability-list</span>”, is for downloading
1814: the list of vulnerabilities from the NetBSD FTP site. The second
1815: component, “<span class="quote">audit-packages</span>”, checks to see if any of your
1816: installed packages are vulnerable. If a package is vulnerable, you
1817: will see output similar to the following:
1818: </p>
1.82 rillig 1819: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88 wiz 1820: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82 rillig 1821: <p>
1.91 rillig 1822: 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.110 hubertf 1823: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.88 wiz 1824: file daily, and include a package audit in the daily security script.
1.110 hubertf 1825: Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91 rillig 1826: 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 1827: </p>
1.82 rillig 1828: </div>
1829: <div class="sect2" lang="en">
1830: <div class="titlepage"><div><div><h3 class="title">
1831: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1832: <p>
1.112 ! weinem 1833: Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.110 hubertf 1834: <span class="command"><strong>lintpkgsrc</strong></span> with the “<span class="quote">-i</span>”
1.88 wiz 1835: argument to check if your packages are up-to-date, e.g.
1836: </p>
1837: <pre class="screen">
1838: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82 rillig 1839: ...
1.88 wiz 1840: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1841: </pre>
1.110 hubertf 1842: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88 wiz 1843: package on your system and rebuild any dependencies.
1844: </p>
1.82 rillig 1845: </div>
1846: <div class="sect2" lang="en">
1847: <div class="titlepage"><div><div><h3 class="title">
1848: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110 hubertf 1849: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88 wiz 1850: administrative functions on the package system.</p>
1.82 rillig 1851: </div>
1852: <div class="sect2" lang="en">
1853: <div class="titlepage"><div><div><h3 class="title">
1854: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75 rillig 1855: <p>Please pay very careful attention to the warnings
1.110 hubertf 1856: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88 wiz 1857: inherent dangers of installing binary packages which you did
1858: not create yourself, and the security holes that can be
1859: introduced onto your system by indiscriminate adding of such
1860: files.</p>
1.75 rillig 1861: <p>The same warning of course applies to every package you
1.88 wiz 1862: install from source when you haven't completely read and
1863: understood the source code of the package, the compiler that
1864: is used to build the package and all the other tools that are
1865: involved.</p>
1.75 rillig 1866: </div>
1867: </div>
1868: <div class="sect1" lang="en">
1869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1870: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88 wiz 1871: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1872: directory now contains a set of packages, organized into
1873: categories. You can browse the online index of packages, or run
1.110 hubertf 1874: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88 wiz 1875: directory to build local <code class="filename">README.html</code> files for
1.91 rillig 1876: 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 1877: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1878: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1879: should do so by setting <code class="varname">LOCALBASE</code> in
1.110 hubertf 1880: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88 wiz 1881: different <code class="varname">LOCALBASE</code> definitions on the same
1882: system (inside a chroot is an exception). </p>
1883: <p>The rest of this chapter assumes that the package is already
1.110 hubertf 1884: in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, “The pkgsrc developer's guide”</a> for
1.88 wiz 1885: instructions how to create your own packages.</p>
1.75 rillig 1886: <div class="sect2" lang="en">
1887: <div class="titlepage"><div><div><h3 class="title">
1888: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82 rillig 1889: <p>To build packages from source, you need a working C
1.88 wiz 1890: compiler. On NetBSD, you need to install the
1891: “<span class="quote">comp</span>” and the “<span class="quote">text</span>” distribution
1892: sets. If you want to build X11-related packages, the
1893: “<span class="quote">xbase</span>” and “<span class="quote">xcomp</span>” distribution
1894: sets are required, too.</p>
1.75 rillig 1895: </div>
1896: <div class="sect2" lang="en">
1897: <div class="titlepage"><div><div><h3 class="title">
1898: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1899: <p>The first step for building a package is downloading the
1.88 wiz 1900: distfiles (i.e. the unmodified source). If they have not yet been
1901: downloaded, pkgsrc will fetch them automatically.</p>
1902: <p>If you have all files that you need in the
1903: <code class="filename">distfiles</code> directory,
1904: you don't need to connect. If the distfiles are on CD-ROM, you can
1905: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1906: </p>
1.82 rillig 1907: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1908: <p>
1.110 hubertf 1909: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91 rillig 1910: <p>By default a list of distribution sites will be randomly
1911: intermixed to prevent huge load on servers which holding popular
1912: packages (for example, SourceForge.net mirrors). Thus, every
1913: time when you need to fetch yet another distfile all the mirrors
1914: will be tried in new (random) order. You can turn this feature
1915: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1916: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88 wiz 1917: <p>You can overwrite some of the major distribution sites to
1918: fit to sites that are close to your own. By setting one or two
1919: variables you can modify the order in which the master sites are
1920: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1921: delimited list of domain suffixes.
1922: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1923: contains a whitespace delimited list of regular expressions. It
1924: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1925: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1926: some examples. This may save some of your bandwidth and
1927: time.</p>
1.75 rillig 1928: <p>You can change these settings either in your shell's environment, or,
1.88 wiz 1929: if you want to keep the settings, by editing the
1.110 hubertf 1930: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88 wiz 1931: and adding the definitions there.</p>
1.82 rillig 1932: <p>
1.88 wiz 1933: If a package depends on many other packages (such as
1.93 rillig 1934: <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 1935: alternate between periods of
1936: downloading source, and compiling. To ensure you have all the source
1937: downloaded initially you can run the command:
1938: </p>
1.82 rillig 1939: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1940: <p>
1.88 wiz 1941: which will output and run a set of shell commands to fetch the
1942: necessary files into the <code class="filename">distfiles</code> directory. You can
1943: also choose to download the files manually.
1944: </p>
1.75 rillig 1945: </div>
1946: <div class="sect2" lang="en">
1947: <div class="titlepage"><div><div><h3 class="title">
1948: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82 rillig 1949: <p>
1.88 wiz 1950: Once the software has downloaded, any patches will be applied, then it
1951: will be compiled for you. This may take some time depending on your
1952: computer, and how many other packages the software depends on and their
1953: compile time.
1954: </p>
1.75 rillig 1955: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1956: <h3 class="title">Note</h3>
1957: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110 hubertf 1958: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88 wiz 1959: “<span class="quote">make</span>” in the examples in this guide.</p>
1.75 rillig 1960: </div>
1.87 wiz 1961: <p>For example, type</p>
1.88 wiz 1962: <pre class="screen">
1963: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1964: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1965: </pre>
1.75 rillig 1966: <p>at the shell prompt to build the various components of the
1.88 wiz 1967: package.</p>
1.82 rillig 1968: <p>The next stage is to actually install the newly compiled
1.88 wiz 1969: program onto your system. Do this by entering:
1.82 rillig 1970:
1.88 wiz 1971: </p>
1.82 rillig 1972: <pre class="screen">
1.88 wiz 1973: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1974: </pre>
1.82 rillig 1975: <p>
1976:
1.88 wiz 1977: while you are still in the directory for whatever package you
1978: are installing.</p>
1.82 rillig 1979: <p>Installing the package on your system may require you to
1.88 wiz 1980: be root. However, pkgsrc has a
1981: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1982: to only become root for the actual installation step.</p>
1.82 rillig 1983: <p>That's it, the software should now be installed and setup for use.
1.88 wiz 1984: You can now enter:
1.82 rillig 1985:
1.88 wiz 1986: </p>
1.82 rillig 1987: <pre class="screen">
1.88 wiz 1988: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1989: </pre>
1.82 rillig 1990: <p>
1991:
1.88 wiz 1992: to remove the compiled files in the work directory, as you shouldn't need
1993: them any more. If other packages were also added to your system
1994: (dependencies) to allow your program to compile, you can tidy these up
1995: also with the command:</p>
1.82 rillig 1996: <pre class="screen">
1.88 wiz 1997: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1998: </pre>
1.75 rillig 1999: <p>Taking the figlet utility as an example, we can install it on our
1.110 hubertf 2000: system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88 wiz 2001: <p>The program is installed under the default root of the
2002: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2003: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2004: variable in your environment, and it will use that value as the
2005: root of your packages tree. So, to use
2006: <code class="filename">/usr/local</code>, set
2007: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2008: Please note that you should use a directory which is dedicated to
2009: packages and not shared with other programs (i.e., do not try and
2010: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2011: to add any of your own files or directories (such as
2012: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2013: <code class="filename">pkgsrc/</code>) below the
2014: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2015: conflicts between programs and other files installed by the
2016: package system and whatever else may have been installed
2017: there.</p>
1.110 hubertf 2018: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88 wiz 2019: alter some configuration options at build time. Have a look at
2020: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2021: of what will be set there by default. Environment variables such
2022: as <code class="varname">LOCALBASE</code> can be set in
1.110 hubertf 2023: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88 wiz 2024: set them each time you want to use pkgsrc.</p>
2025: <p>Occasionally, people want to “<span class="quote">look under the
2026: covers</span>” to see what is going on when a package is building
2027: or being installed. This may be for debugging purposes, or out of
2028: simple curiosity. A number of utility values have been added to
2029: help with this.</p>
1.75 rillig 2030: <div class="orderedlist"><ol type="1">
2031: <li>
1.110 hubertf 2032: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88 wiz 2033: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2034: information will be displayed. For example,</p>
1.75 rillig 2035: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88 wiz 2036: <p>will show all the commands that are invoked, up to and
2037: including the “<span class="quote">patch</span>” stage.</p>
1.75 rillig 2038: </li>
2039: <li>
1.110 hubertf 2040: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2041: definition, then the <code class="varname">VARNAME</code> definition
2042: should be used, in conjunction with the show-var
1.110 hubertf 2043: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 2044: variable <code class="varname">LOCALBASE</code>:</p>
2045: <pre class="screen">
2046: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75 rillig 2047: /usr/pkg
2048: <code class="prompt">%</code>
1.88 wiz 2049: </pre>
1.75 rillig 2050: </li>
2051: </ol></div>
2052: <p>If you want to install a binary package that you've either
1.88 wiz 2053: created yourself (see next section), that you put into
2054: pkgsrc/packages manually or that is located on a remote FTP
2055: server, you can use the "bin-install" target. This target will
1.110 hubertf 2056: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
2057: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.88 wiz 2058: sites searched is kept in the variable
2059: <code class="varname">BINPKG_SITES</code>, which defaults to
1.110 hubertf 2060: ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88 wiz 2061: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2062: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2063: details.</p>
2064: <p>A final word of warning: If you set up a system that has a
2065: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2066: set that before any packages are installed, as you cannot use
2067: several directories for the same purpose. Doing so will result in
2068: pkgsrc not being able to properly detect your installed packages,
2069: and fail miserably. Note also that precompiled binary packages are
2070: usually built with the default <code class="varname">LOCALBASE</code> of
2071: <code class="filename">/usr/pkg</code>, and that you should
2072: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2073: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 2074: </div>
2075: </div>
2076: </div>
2077: <div class="chapter" lang="en">
2078: <div class="titlepage"><div><div><h2 class="title">
2079: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2080: <div class="toc">
2081: <p><b>Table of Contents</b></p>
2082: <dl>
2083: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2084: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109 rillig 2085: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103 wiz 2086: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88 wiz 2087: <dd><dl>
1.103 wiz 2088: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2089: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2090: <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 2091: </dl></dd>
1.103 wiz 2092: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2093: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75 rillig 2094: </dl>
2095: </div>
1.104 rillig 2096: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89 rillig 2097: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2098: that file depends on the installation. On NetBSD, when you use
1.110 hubertf 2099: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89 rillig 2100: <code class="filename">/etc/</code>. In all other cases the default location is
2101: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2102: bootstrap program to install the binary packages.</p>
2103: <p>During the bootstrap, an example configuration file is created. To
2104: use that, you have to create the directory
2105: <code class="filename">${PREFIX}/etc</code> and copy the example file
2106: there.</p>
2107: <p>The format of the configuration file is that of the usual
2108: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2109: is done by setting variables in this file. Note that you can define all
2110: kinds of variables, and no special error checking (for example for
2111: spelling mistakes) takes place, so you have to try it out to see if it
2112: works.</p>
1.75 rillig 2113: <div class="sect1" lang="en">
2114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2115: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2116: <p>In this section, you can find some variables that apply to all
1.89 rillig 2117: pkgsrc packages. A complete list of the variables that can be
2118: configured by the user is available in
2119: <code class="filename">mk/defaults/mk.conf</code>, together with some
2120: comments that describe each variable's intent.</p>
1.75 rillig 2121: <div class="itemizedlist"><ul type="disc">
2122: <li><p><code class="varname">LOCALBASE</code>: Where
2123: packages will be installed. The default is
1.76 rillig 2124: <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75 rillig 2125: with different <code class="varname">LOCALBASE</code>s!</p></li>
2126: <li><p><code class="varname">CROSSBASE</code>: Where
2127: “<span class="quote">cross</span>” category packages will be
2128: installed. The default is
1.76 rillig 2129: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75 rillig 2130: <li><p><code class="varname">X11BASE</code>: Where
2131: X11 is installed on the system. The default is
1.76 rillig 2132: <code class="filename">/usr/X11R6</code>.</p></li>
1.75 rillig 2133: <li><p><code class="varname">DISTDIR</code>: Where to store the
2134: downloaded copies of the original source distributions used
2135: for building pkgsrc packages. The default is
1.76 rillig 2136: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97 rillig 2137: <li><p><code class="varname">PKG_DBDIR</code>: Where the
2138: database about installed packages is stored. The default is
2139: <code class="filename">/var/db/pkg</code>.</p></li>
1.75 rillig 2140: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2141: If set, override the packages'
2142: <code class="varname">MASTER_SITES</code> with this value.</p></li>
2143: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
2144: Backup location(s) for distribution files and patch files
2145: if not found locally or in
1.76 rillig 2146: <code class="filename">${MASTER_SITES}</code> or
2147: <code class="filename">${PATCH_SITES}</code> respectively.
1.75 rillig 2148: The defaults are
1.76 rillig 2149: <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75 rillig 2150: and
1.76 rillig 2151: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75 rillig 2152: <li><p><code class="varname">BINPKG_SITES</code>:
1.93 rillig 2153: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2154: <em class="replaceable"><code>arch</code></em> are replaced with OS
2155: release (“<span class="quote">2.0</span>”, etc.) and architecture
2156: (“<span class="quote">mipsel</span>”, etc.).</p></li>
1.82 rillig 2157: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2158: List of acceptable licenses. Whenever you try to build a package
2159: whose license is not in this list, you will get an error message
2160: that includes instructions on how to change this variable.</p></li>
1.75 rillig 2161: </ul></div>
2162: </div>
2163: <div class="sect1" lang="en">
2164: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2165: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2166: <p>XXX
2167: </p>
2168: <div class="itemizedlist"><ul type="disc">
2169: <li><p><code class="varname">PACKAGES</code>: The top level
2170: directory for the binary packages. The default is
1.76 rillig 2171: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75 rillig 2172: <li><p><code class="varname">WRKOBJDIR</code>:
2173: The top level directory where, if defined, the separate
2174: working directories will get created, and symbolically
1.76 rillig 2175: linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75 rillig 2176: This is useful for building packages on several
1.76 rillig 2177: architectures, then <code class="filename">${PKGSRCDIR}</code>
2178: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75 rillig 2179: is local to every architecture. (It should be noted that
2180: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.112 ! weinem 2181: — it is an internal definition which refers to the
1.75 rillig 2182: root of the pkgsrc tree. It is possible to have many
2183: pkgsrc tree instances.)</p></li>
2184: <li><p><code class="varname">LOCALPATCHES</code>:
2185: Directory for local patches that aren't part of pkgsrc.
1.110 hubertf 2186: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.93 rillig 2187: information.</p></li>
1.75 rillig 2188: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110 hubertf 2189: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75 rillig 2190: BSD-style Makefile. If this is not set,
2191: <code class="varname">MAKECONF</code> is set to
1.76 rillig 2192: <code class="filename">/dev/null</code> to avoid picking up
2193: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82 rillig 2194: <li><p><code class="varname">DEPENDS_TARGET</code>:
2195: By default, dependencies are only installed, and no binary
2196: package is created for them. You can set this variable to
2197: <code class="literal">package</code> to automatically create binary
2198: packages after installing dependencies.</p></li>
1.75 rillig 2199: </ul></div>
2200: </div>
2201: <div class="sect1" lang="en">
2202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109 rillig 2203: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103 wiz 2204: <p>A growing number of packages support installation into a
2205: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2206: to be built, before the actual filesystem is touched. DESTDIR
2207: support exists in two variations:</p>
2208: <div class="itemizedlist"><ul type="disc">
2209: <li><p>Basic DESTDIR support means that the package
2210: installation and packaging is still run as
2211: root.</p></li>
2212: <li><p>Full DESTDIR support can run the complete build,
2213: installation and packaging as normal user. Root privileges are
2214: only needed to add packages.</p></li>
2215: </ul></div>
2216: <p>To use the DESTDIR support, set either
2217: <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
2218: packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
2219: get the full support with fallback to basic
2220: 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
2221: newer). It might become the default DESTDIR support later.</p>
2222: <p>DESTDIR support changes the behaviour of various targets
2223: slightly. To install a package after building it, use
2224: <code class="literal">package-install</code>. <code class="literal">package</code> and
2225: <code class="literal">install</code> don't do that any
2226: longer. <code class="literal">package-install</code> can be used as
2227: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2228: will ask for the root password to install the package and fail,
2229: <code class="literal">package-install</code> will ask again.</p>
2230: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2231: clean</code></strong> needs to be run as root.</p>
2232: </div>
2233: <div class="sect1" lang="en">
2234: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2235: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78 rillig 2236: <div class="sect2" lang="en">
2237: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2238: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89 rillig 2239: <p>By default, pkgsrc will use GCC to build packages. This may be
2240: overridden by setting the following variables in /etc/mk.conf:</p>
2241: <div class="variablelist"><dl>
2242: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2243: <dd>
2244: <p>This is a list of values specifying the chain of
2245: compilers to invoke when building packages. Valid values
2246: are:</p>
2247: <div class="itemizedlist"><ul type="disc">
2248: <li><p><code class="varname">distcc</code>:
2249: distributed C/C++ (chainable)</p></li>
2250: <li><p><code class="varname">ccache</code>:
2251: compiler cache (chainable)</p></li>
2252: <li><p><code class="varname">gcc</code>:
2253: GNU C/C++ Compiler</p></li>
2254: <li><p><code class="varname">mipspro</code>:
2255: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2256: <li><p><code class="varname">mipspro</code>:
2257: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2258: <li><p><code class="varname">sunpro</code>:
2259: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2260: </ul></div>
2261: <p>The default is
2262: “<span class="quote"><code class="varname">gcc</code></span>”. You can use
2263: <code class="varname">ccache</code> and/or
2264: <code class="varname">distcc</code> with an appropriate
2265: <code class="varname">PKGSRC_COMPILER</code> setting,
2266: e.g. “<span class="quote"><code class="varname">ccache gcc</code></span>”. This
1.94 dmcmahil 2267: variable should always be terminated with a value for
2268: a real compiler. Note that only one real compiler
2269: should be listed (e.g. “<span class="quote"><code class="varname">sunpro gcc</code></span>”
2270: is not allowed).</p>
1.89 rillig 2271: </dd>
2272: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2273: <dd><p>This specifies the minimum version of GCC to use
2274: when building packages. If the system GCC doesn't
2275: satisfy this requirement, then pkgsrc will build and
2276: install one of the GCC packages to use instead.</p></dd>
2277: </dl></div>
2278: </div>
2279: <div class="sect2" lang="en">
2280: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2281: <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 2282: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2283: please make sure to use the <code class="literal">+=</code> operator
2284: instead of the <code class="literal">=</code> operator:</p>
2285: <pre class="programlisting">
1.100 rillig 2286: CFLAGS+= -your -flags
1.78 rillig 2287: </pre>
2288: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2289: “<span class="quote">+</span>”) may lead to problems with packages that need
2290: to add their own flags. Also, you may want to take a look at
1.91 rillig 2291: 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 2292: you're interested in optimization for the current CPU.</p>
2293: </div>
1.88 wiz 2294: <div class="sect2" lang="en">
2295: <div class="titlepage"><div><div><h3 class="title">
1.103 wiz 2296: <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 2297: <p>If you want to pass flags to the linker, both in the configure
2298: step and the build step, you can do this in two ways. Either set
2299: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2300: between the two is that <code class="varname">LIBS</code> will be appended to
2301: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2302: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2303: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2304: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2305: <code class="varname">CFLAGS</code>, if you do not wish to override these
2306: settings, use the <code class="literal">+=</code> operator:</p>
2307: <pre class="programlisting">
1.100 rillig 2308: LDFLAGS+= -your -linkerflags
1.88 wiz 2309: </pre>
2310: </div>
1.78 rillig 2311: </div>
2312: <div class="sect1" lang="en">
2313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2314: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75 rillig 2315: <p>XXX
2316: </p>
2317: <div class="itemizedlist"><ul type="disc">
2318: <li>
2319: <p><code class="varname">PKG_DEVELOPER</code>:
2320: Run some sanity checks that package developers want:
2321: </p>
2322: <div class="itemizedlist"><ul type="circle">
1.88 wiz 2323: <li><p>make sure patches apply with zero
2324: fuzz</p></li>
2325: <li><p>run check-shlibs to see that all
2326: binaries will find their shared libs.</p></li>
1.75 rillig 2327: </ul></div>
2328: <p>
1.87 wiz 2329: </p>
1.75 rillig 2330: </li>
1.88 wiz 2331: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2332: of debugging output which is displayed whilst making and
2333: installing the package. The default value for this is 0,
2334: which will not display the commands as they are executed
2335: (normal, default, quiet operation); the value 1 will display
2336: all shell commands before their invocation, and the value 2
2337: will display both the shell commands before their invocation,
1.110 hubertf 2338: and their actual execution progress with <span class="command"><strong>set
1.88 wiz 2339: -x</strong></span> will be displayed.</p></li>
1.75 rillig 2340: </ul></div>
2341: <p>
2342: </p>
2343: </div>
2344: <div class="sect1" lang="en">
2345: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103 wiz 2346: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88 wiz 2347: <p>Some packages have build time options, usually to select
2348: between different dependencies, enable optional support for big
2349: dependencies or enable experimental features.</p>
1.75 rillig 2350: <p>To see which options, if any, a package supports, and which
1.110 hubertf 2351: options are mutually exclusive, run <span class="command"><strong>make
1.88 wiz 2352: show-options</strong></span>, for example:</p>
1.75 rillig 2353: <pre class="programlisting">
2354: The following options are supported by this package:
2355: ssl Enable SSL support.
2356: Exactly one of the following gecko options is required:
2357: firefox Use firefox as gecko rendering engine.
2358: mozilla Use mozilla as gecko rendering engine.
2359: At most one of the following database options may be selected:
2360: mysql Enable support for MySQL database.
2361: pgsql Enable support for PostgreSQL database.
1.1 grant 2362:
1.75 rillig 2363: These options are enabled by default: firefox
2364: These options are currently enabled: mozilla ssl
1.1 grant 2365: </pre>
1.75 rillig 2366: <p>The following variables can be defined in
1.110 hubertf 2367: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88 wiz 2368: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2369: which can be used to select or disable options for all packages
2370: that support them, and
2371: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2372: which can be used to select or disable options specifically for
2373: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
2374: these variables are selected, options preceded by “<span class="quote">-</span>”
2375: are disabled. A few examples:</p>
1.75 rillig 2376: <pre class="screen">
1.110 hubertf 2377: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75 rillig 2378: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2379: PKG_OPTIONS.kdebase= debug -sasl
2380: PKG_OPTIONS.apache= suexec </pre>
1.111 rillig 2381: <p>It is important to note that options that were specifically
2382: suggested by the package maintainer must be explicitely removed if
2383: you do not wish to include the option. If you are unsure you can view
2384: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88 wiz 2385: <p>The following settings are consulted in the order given, and
2386: the last setting that selects or disables an option is
2387: used:</p>
1.75 rillig 2388: <div class="orderedlist"><ol type="1">
2389: <li><p>the default options as suggested by the package
1.88 wiz 2390: maintainer</p></li>
1.75 rillig 2391: <li><p>the options implied by the settings of legacy
1.88 wiz 2392: variables (see below)</p></li>
1.75 rillig 2393: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2394: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2395: </ol></div>
2396: <p>For groups of mutually exclusive options, the last option
1.88 wiz 2397: selected is used, all others are automatically disabled. If an
2398: option of the group is explicitly disabled, the previously
2399: selected option, if any, is used. It is an error if no option
2400: from a required group of options is selected, and building the
2401: package will fail.</p>
2402: <p>Before the options framework was introduced, build options
2403: were selected by setting a variable (often named
2404: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110 hubertf 2405: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.88 wiz 2406: transition to the options framework for the user, these legacy
2407: variables are converted to the appropriate options setting
2408: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2409: automatically. A warning is issued to prompt the user to update
1.110 hubertf 2410: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88 wiz 2411: directly. Support for the legacy variables will be removed
2412: eventually.</p>
1.75 rillig 2413: </div>
2414: </div>
2415: <div class="chapter" lang="en">
2416: <div class="titlepage"><div><div><h2 class="title">
2417: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2418: <div class="toc">
2419: <p><b>Table of Contents</b></p>
2420: <dl>
2421: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2422: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2423: </dl>
2424: </div>
2425: <div class="sect1" lang="en">
2426: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2427: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87 wiz 2428: <p>Once you have built and installed a package, you can create
2429: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110 hubertf 2430: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87 wiz 2431: the same package on a group of hosts and wasting CPU time. It also
2432: provides a simple means for others to install your package, should
2433: you distribute it.</p>
2434: <p>To create a binary package, change into the appropriate
1.110 hubertf 2435: directory in pkgsrc, and run <span class="command"><strong>make
1.87 wiz 2436: package</strong></span>:</p>
2437: <pre class="screen">
2438: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2439: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2440: </pre>
2441: <p>This will build and install your package (if not already done),
2442: and then build a binary package from what was installed. You can
1.110 hubertf 2443: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87 wiz 2444: it. Binary packages are created by default in
2445: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110 hubertf 2446: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.91 rillig 2447: 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.110 hubertf 2448: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87 wiz 2449: such a binary package.</p>
1.75 rillig 2450: </div>
2451: <div class="sect1" lang="en">
2452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2453: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110 hubertf 2454: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.106 rillig 2455: </div>
2456: </div>
2457: <div class="chapter" lang="en">
2458: <div class="titlepage"><div><div><h2 class="title">
2459: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2460: builds)</h2></div></div></div>
2461: <div class="toc">
2462: <p><b>Table of Contents</b></p>
2463: <dl>
2464: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2465: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2466: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2467: <dd><dl>
2468: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2469: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2470: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2471: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2472: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2473: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2474: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2475: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2476: </dl></dd>
2477: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
2478: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.1. Configuration</a></span></dt></dl></dd>
2479: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2480: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2481: </dl>
2482: </div>
2483: <p>When you have multiple machines that should run the same packages,
2484: it is wasted time if they all build their packages themselves from
2485: source. There are two ways of getting a set of binary packages: The old
2486: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2487: system. This chapter describes how to set them up so that the packages
2488: are most likely to be usable later.</p>
2489: <div class="sect1" lang="en">
2490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2491: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2492: <p>Since a bulk build takes several days or even weeks to finish, you
2493: should think about the setup before you start everything. Pay attention
2494: to at least the following points:</p>
2495: <div class="itemizedlist"><ul type="disc">
2496: <li>
2497: <p>If you want to upload the binary packages to
2498: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2499: packages:</p>
2500: <div class="itemizedlist"><ul type="circle">
2501: <li><p>To end up on ftp.NetBSD.org, the packages must be built
2502: by a NetBSD developer on a trusted machine (that is, where you and only
2503: you have root access).</p></li>
2504: <li><p>Packages on ftp.NetBSD.org should only be created from
2505: the stable branches (like 2007Q1), so that users browsing the available
2506: collections can see at a glance how old the packages
2507: are.</p></li>
2508: <li><p>The packages must be built as root, since some packages
2509: require set-uid binaries at runtime, and creating those packages as
2510: unprivileged user doesn't work well at the moment.</p></li>
2511: </ul></div>
2512: </li>
2513: <li><p>Make sure that the bulk build cannot break anything in
2514: your system. Most bulk builds run as root, so they should be run at least
2515: in a chroot environment or something even more restrictive, depending on
2516: what the operating system provides. There have been numerous cases where
2517: certain packages tried to install files outside the
2518: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2519: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2520: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2521: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2522: that you don't need any package during the build.</p></li>
2523: </ul></div>
2524: </div>
2525: <div class="sect1" lang="en">
2526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2527: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2528: <p>A complete bulk build requires lots of disk space. Some of the
2529: disk space can be read-only, some other must be writable. Some can be on
2530: remote filesystems (such as NFS) and some should be local. Some can be
2531: temporary filesystems, others must survive a sudden reboot.</p>
2532: <div class="itemizedlist"><ul type="disc">
2533: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2534: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2535: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2536: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2537: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2538: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2539: </ul></div>
1.75 rillig 2540: </div>
2541: <div class="sect1" lang="en">
2542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2543: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
2544: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2545: <h3 class="title">Warning</h3>
2546: <p>The rest of this section is rather old. Don't rely on it
2547: too much.</p>
2548: </div>
1.75 rillig 2549: <div class="sect2" lang="en">
2550: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2551: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75 rillig 2552: <div class="sect3" lang="en">
2553: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2554: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93 rillig 2555: </h4></div></div></div>
1.76 rillig 2556: <p>The <code class="filename">build.conf</code> file is the main
1.87 wiz 2557: configuration file for bulk builds. You can configure how your
2558: copy of pkgsrc is kept up to date, how the distfiles are
2559: downloaded, how the packages are built and how the report is
2560: generated. You can find an annotated example file in
2561: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2562: it, copy <code class="filename">build.conf-example</code> to
2563: <code class="filename">build.conf</code> and edit it, following the
2564: comments in that file.</p>
1.75 rillig 2565: </div>
2566: <div class="sect3" lang="en">
2567: <div class="titlepage"><div><div><h4 class="title">
1.110 hubertf 2568: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104 rillig 2569: </h4></div></div></div>
1.110 hubertf 2570: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87 wiz 2571: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2572: details of the default settings. You will want to ensure that
2573: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2574: As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104 rillig 2575: completely bypasses the license check.</p>
1.87 wiz 2576: <pre class="programlisting">
1.100 rillig 2577: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2578: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2579: BSDSRCDIR= /usr/src
2580: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2581: OBJHOSTNAME?= yes # use work.`hostname`
2582: FAILOVER_FETCH= yes # insist on the correct checksum
2583: PKG_DEVELOPER?= yes
2584: _ACCEPTABLE= yes
2585: </pre>
1.75 rillig 2586: <p>Some options that are especially useful for bulk builds
2587: can be found at the top lines of the file
1.76 rillig 2588: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75 rillig 2589: options of these are briefly described here.</p>
2590: <div class="itemizedlist"><ul type="disc">
2591: <li><p>If you are on a slow machine, you may want to
1.87 wiz 2592: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2593: “<span class="quote">no</span>”.</p></li>
1.75 rillig 2594: <li><p>If you are doing bulk builds from a read-only
1.87 wiz 2595: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2596: to the directory where all log files are created. Otherwise the
2597: log files are created in the pkgsrc directory.</p></li>
1.75 rillig 2598: <li><p>Another important variable is
1.87 wiz 2599: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2600: should be always available while building other
2601: packages.</p></li>
1.75 rillig 2602: </ul></div>
2603: <p>Some other options are scattered in the pkgsrc
2604: infrastructure:</p>
2605: <div class="itemizedlist"><ul type="disc">
2606: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87 wiz 2607: should be set to <code class="literal">yes</code>. The purpose of the bulk
2608: builds is creating binary packages, no matter if they are
2609: vulnerable or not. When uploading the packages to a public
2610: server, the vulnerable packages will be put into a directory of
2611: their own. Leaving this variable unset would prevent the bulk
2612: build system from even trying to build them, so possible
2613: building errors would not show up.</p></li>
1.75 rillig 2614: <li><p><code class="varname">CHECK_FILES</code>
1.93 rillig 2615: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87 wiz 2616: “<span class="quote">yes</span>” to check that the installed set of files
2617: matches the <code class="filename">PLIST</code>.</p></li>
1.75 rillig 2618: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93 rillig 2619: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87 wiz 2620: “<span class="quote">yes</span>” to check that the installed
2621: “<span class="quote">#!</span>”-scripts will find their
2622: interpreter.</p></li>
1.91 rillig 2623: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2624: set to “<span class="quote"><code class="literal">yes</code></span>” to run each
2625: package's self-test before installing it. Note that some
2626: packages make heavy use of “<span class="quote">good</span>” random
2627: numbers, so you need to assure that the machine on which you
2628: are doing the bulk builds is not completely idle. Otherwise
2629: some test programs will seem to hang, while they are just
2630: waiting for new random data to be
2631: available.</p></li>
1.75 rillig 2632: </ul></div>
2633: </div>
2634: <div class="sect3" lang="en">
2635: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 2636: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93 rillig 2637: </h4></div></div></div>
1.75 rillig 2638: <p>It is possible to configure the bulk build to perform
1.87 wiz 2639: certain site-specific tasks at the end of the pre-build
2640: stage. If the file
2641: <code class="filename">pre-build.local</code> exists in
2642: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110 hubertf 2643: (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87 wiz 2644: stage. An example use of
2645: <code class="filename">pre-build.local</code> is to have the line:</p>
1.75 rillig 2646: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87 wiz 2647: > misc/openoffice/$BROKENF</pre>
1.75 rillig 2648: <p>to prevent the system from trying to build a particular package
1.87 wiz 2649: which requires nearly 3 GB of disk space.</p>
1.75 rillig 2650: </div>
2651: </div>
2652: <div class="sect2" lang="en">
2653: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2654: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76 rillig 2655: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87 wiz 2656: deleted at the start of bulk builds, make sure your login
2657: shell is placed somewhere else. Either drop it into
2658: <code class="filename">/usr/local/bin</code> (and adjust your login
2659: shell in the passwd file), or (re-)install it via
1.110 hubertf 2660: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87 wiz 2661: you can login after a reboot (remember that your current
2662: process won't die if the package is removed, you just can't
2663: start any new instances of the shell any more). Also, if you
2664: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2665: version of ssh for some reason, be sure to install ssh before
2666: starting it from <code class="filename">rc.local</code>:</p>
2667: <pre class="programlisting">
1.100 rillig 2668: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2669: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2670: /usr/pkg/etc/rc.d/sshd
2671: fi
2672: </pre>
1.75 rillig 2673: <p>Not doing so will result in you being not able to log in
1.87 wiz 2674: via ssh after the bulk build is finished or if the machine
2675: gets rebooted or crashes. You have been warned! :)</p>
1.75 rillig 2676: </div>
2677: <div class="sect2" lang="en">
2678: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2679: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75 rillig 2680: <p>Make sure you don't need any of the packages still
1.87 wiz 2681: installed.</p>
1.75 rillig 2682: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2683: <h3 class="title">Warning</h3>
1.99 rillig 2684: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2685: configuration files and some more files from
2686: <code class="filename">/var</code>, <code class="filename">/home</code> and
2687: possibly other locations will be removed! So don't run a bulk
2688: build with privileges that might harm your
2689: system.</em></span></p>
1.75 rillig 2690: </div>
2691: <p>Be sure to remove all other things that might
1.87 wiz 2692: interfere with builds, like some libs installed in
2693: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2694: <pre class="screen">
2695: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2696: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2697: </pre>
1.75 rillig 2698: <p>If for some reason your last build didn't complete (power
1.87 wiz 2699: failure, system panic, ...), you can continue it by
2700: running:</p>
1.75 rillig 2701: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87 wiz 2702: <p>At the end of the bulk build, you will get a summary via mail,
2703: and find build logs in the directory specified by
2704: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2705: file.</p>
1.75 rillig 2706: </div>
2707: <div class="sect2" lang="en">
2708: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2709: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75 rillig 2710: <p>The bulk builds consist of three steps:</p>
2711: <div class="variablelist"><dl>
2712: <dt><span class="term">1. pre-build</span></dt>
1.87 wiz 2713: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2714: cleans out any broken distfiles, and removes all
2715: packages installed.</p></dd>
1.75 rillig 2716: <dt><span class="term">2. the bulk build</span></dt>
1.87 wiz 2717: <dd><p>This is basically “<span class="quote">make bulk-package</span>” with
2718: an optimised order in which packages will be
2719: built. Packages that don't require other packages will
2720: be built first, and packages with many dependencies will
2721: be built later.</p></dd>
1.75 rillig 2722: <dt><span class="term">3. post-build</span></dt>
1.87 wiz 2723: <dd><p>Generates a report that's placed in the directory
2724: specified in the <code class="filename">build.conf</code> file
2725: named <code class="filename">broken.html</code>, a short version
2726: of that report will also be mailed to the build's
2727: admin.</p></dd>
1.75 rillig 2728: </dl></div>
1.87 wiz 2729: <p>During the build, a list of broken packages will be compiled
2730: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2731: <code class="filename">.../.broken.${MACHINE}</code> if
2732: <code class="varname">OBJMACHINE</code> is set), individual build logs
2733: of broken builds can be found in the package's
2734: directory. These files are used by the bulk-targets to mark
2735: broken builds to not waste time trying to rebuild them, and
2736: they can be used to debug these broken package builds
2737: later.</p>
1.75 rillig 2738: </div>
2739: <div class="sect2" lang="en">
2740: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2741: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75 rillig 2742: <p>Currently, roughly the following requirements are valid for
1.87 wiz 2743: NetBSD 2.0/i386:</p>
1.75 rillig 2744: <div class="itemizedlist"><ul type="disc">
1.87 wiz 2745: <li><p>10 GB - distfiles (NFS ok)</p></li>
2746: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
2747: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2748: </ul></div>
2749: <p>Note that all pkgs will be de-installed as soon as they are
2750: turned into a binary package, and that sources are removed,
2751: so there is no excessively huge demand to disk
2752: space. Afterwards, if the package is needed again, it will
1.110 hubertf 2753: be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87 wiz 2754: there are no cycles wasted by recompiling.</p>
1.75 rillig 2755: </div>
2756: <div class="sect2" lang="en">
2757: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2758: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87 wiz 2759: <p>If you don't want all the packages nuked from a machine
2760: (rendering it useless for anything but pkg compiling), there
2761: is the possibility of doing the package bulk build inside a
2762: chroot environment.</p>
2763: <p>The first step is to set up a chroot sandbox,
2764: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2765: using null mounts, or manually.</p>
2766: <p>There is a shell script called
2767: <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2768: up the sandbox environment using null mounts. It will also
2769: create a script called <code class="filename">sandbox</code> in the
2770: root of the sandbox environment, which will allow the null
1.110 hubertf 2771: mounts to be activated using the <span class="command"><strong>sandbox
1.87 wiz 2772: mount</strong></span> command and deactivated using the
1.110 hubertf 2773: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87 wiz 2774: <p>To set up a sandbox environment by hand, after extracting all
1.110 hubertf 2775: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87 wiz 2776: distribution DESTDIR=/usr/sandbox</strong></span> in
2777: <code class="filename">/usr/src/etc</code>, be sure the following items
2778: are present and properly configured:</p>
1.75 rillig 2779: <div class="procedure"><ol type="1">
2780: <li>
2781: <p>Kernel</p>
2782: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2783: </li>
2784: <li>
1.76 rillig 2785: <p><code class="filename">/dev/*</code></p>
1.75 rillig 2786: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2787: </li>
2788: <li>
1.91 rillig 2789: <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 2790: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2791: </li>
2792: <li>
2793: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2794: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2795: </li>
2796: <li>
1.91 rillig 2797: <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 2798: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2799: </li>
2800: <li>
1.76 rillig 2801: <p><code class="filename">/usr/src</code> (system sources,
1.112 ! weinem 2802: 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 2803: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87 wiz 2804: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75 rillig 2805: </li>
2806: <li>
1.76 rillig 2807: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75 rillig 2808: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2809: </li>
2810: <li>
1.76 rillig 2811: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75 rillig 2812: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2813: </li>
2814: <li>
2815: <p>Checkout pkgsrc via cvs into
1.87 wiz 2816: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2817: <pre class="screen">
2818: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2819: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2820: </pre>
1.75 rillig 2821: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87 wiz 2822: you do development in, as this will likely cause problems!</p>
1.75 rillig 2823: </li>
2824: <li><p>Make
1.87 wiz 2825: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2826: <code class="filename">.../distfiles</code> point somewhere
2827: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.110 hubertf 2828: <li><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, “<code class="filename">mk.conf</code>”</a>.</p></li>
1.76 rillig 2829: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75 rillig 2830: </ol></div>
2831: <p>When the chroot sandbox is set up, you can start
1.87 wiz 2832: the build with the following steps:</p>
2833: <pre class="screen">
2834: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2835: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2836: </pre>
2837: <p>This will just jump inside the sandbox and start building. At
2838: the end of the build, mail will be sent with the results of
2839: the build. Created binary pkgs will be in
2840: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2841: (wherever that points/mounts to/from).</p>
1.75 rillig 2842: </div>
2843: <div class="sect2" lang="en">
2844: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2845: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87 wiz 2846: <p>In addition to building a complete set of all packages in
2847: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2848: may be used to build a subset of the packages contained in
2849: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.110 hubertf 2850: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75 rillig 2851: <div class="itemizedlist"><ul type="disc">
2852: <li><p>SITE_SPECIFIC_PKGS</p></li>
2853: <li><p>HOST_SPECIFIC_PKGS</p></li>
2854: <li><p>GROUP_SPECIFIC_PKGS</p></li>
2855: <li><p>USER_SPECIFIC_PKGS</p></li>
2856: </ul></div>
1.87 wiz 2857: <p>will define the set of packages which should be built.
2858: The bulk build code will also include any packages which are
2859: needed as dependencies for the explicitly listed packages.</p>
2860: <p>One use of this is to do a bulk build with
2861: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2862: periodically to have a complete set of the binary packages
2863: needed for your site available without the overhead of
2864: building extra packages that are not needed.</p>
1.75 rillig 2865: </div>
2866: <div class="sect2" lang="en">
2867: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2868: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87 wiz 2869: <p>This section describes how pkgsrc developers can upload binary
2870: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2871: <p>If you would like to automatically create checksum files for the
2872: binary packages you intend to upload, remember to set
2873: <code class="varname">MKSUMS=yes</code> in your
2874: <code class="filename">mk/bulk/build.conf</code>.</p>
2875: <p>If you would like to PGP sign the checksum files (highly
2876: recommended!), remember to set
2877: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2878: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2879: your GPG password to sign the files before uploading everything.</p>
2880: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2881: set properly in your <code class="filename">mk/bulk/build.conf</code>
2882: file, i.e. adjust it to something like one of the following:</p>
1.93 rillig 2883: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
2884: <p>Please use appropriate values for "packages-200xQy",
1.87 wiz 2885: "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2886: is different from your local login, write your login directly
2887: into the variable, e.g. my local account is "feyrer", but for my
2888: login "hubertf", I use:</p>
1.93 rillig 2889: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87 wiz 2890: <p>A separate <code class="filename">upload</code> directory is used
2891: here to allow "closing" the directory during upload. To do
2892: so, run the following command on ftp.NetBSD.org next:</p>
1.93 rillig 2893: <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 2894: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2895: only appropriate for packages for the NetBSD operating
2896: system. Binary packages for other operating systems should go
2897: into <code class="filename">/pub/pkgsrc</code>.</p>
2898: <p>Before uploading the binary pkgs, ssh authentication needs
2899: to be set up. This example shows how to set up temporary keys
2900: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2901: (assuming that no keys should be present there usually):</p>
2902: <pre class="screen">
2903: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75 rillig 2904: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2905: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87 wiz 2906: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2907: </pre>
2908: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2909: append it to your <code class="filename">~/.ssh/authorized_keys</code>
2910: file on ftp.NetBSD.org. You can remove the key after the
2911: upload is done!</p>
2912: <p>Next, test if your ssh connection really works:</p>
1.75 rillig 2913: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87 wiz 2914: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2915: <p>Now after all this works, you can exit the sandbox and start
2916: the upload:</p>
2917: <pre class="screen">
2918: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75 rillig 2919: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87 wiz 2920: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2921: </pre>
1.110 hubertf 2922: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
2923: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87 wiz 2924: upload. The upload script will take care of not uploading
2925: restricted packages and putting vulnerable packages into the
2926: <code class="filename">vulnerable</code> subdirectory.</p>
2927: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75 rillig 2928: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87 wiz 2929: Gdd:x! </pre>
2930: <p>Use whatever is needed to remove the key you've entered
2931: before! Last, move the uploaded packages out of the
2932: <code class="filename">upload</code> directory to have them accessible
2933: to everyone:</p>
2934: <pre class="screen">
1.93 rillig 2935: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75 rillig 2936: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2937: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87 wiz 2938: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2939: </pre>
1.75 rillig 2940: </div>
2941: </div>
2942: <div class="sect1" lang="en">
2943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 2944: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
2945: <div class="sect2" lang="en">
2946: <div class="titlepage"><div><div><h3 class="title">
2947: <a name="bulk.pbulk.conf"></a>7.4.1. Configuration</h3></div></div></div>
1.110 hubertf 2948: <p>TODO; see <a class="ulink" href="http://wiki.netbsd.se/index.php/pbulk-HOWTO" target="_top">the wiki</a> for
1.106 rillig 2949: more information.</p>
2950: </div>
2951: </div>
2952: <div class="sect1" lang="en">
2953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2954: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87 wiz 2955: <p>After your pkgsrc bulk-build has completed, you may wish to
2956: create a CD-ROM set of the resulting binary packages to assist
2957: in installing packages on other machines. The
1.91 rillig 2958: <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 2959: a simple tool for creating the ISO 9660 images.
1.110 hubertf 2960: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87 wiz 2961: way that keeps all the dependencies for a given package on the same
2962: CD as that package.</p>
1.75 rillig 2963: <div class="sect2" lang="en">
2964: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 2965: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87 wiz 2966: <p>Complete documentation for cdpack is found in the cdpack(1)
2967: man page. The following short example assumes that the binary
2968: packages are left in
2969: <code class="filename">/usr/pkgsrc/packages/All</code> and that
2970: sufficient disk space exists in <code class="filename">/u2</code> to
2971: hold the ISO 9660 images.</p>
2972: <pre class="screen">
2973: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75 rillig 2974: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87 wiz 2975: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2976: </pre>
2977: <p>If you wish to include a common set of files
2978: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2979: etc.) on each CD in the collection, then you need to create a
2980: directory which contains these files. e.g.</p>
2981: <pre class="screen">
2982: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75 rillig 2983: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
2984: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
2985: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
2986: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
2987: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
1.87 wiz 2988: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
2989: </pre>
1.75 rillig 2990: <p>Now create the images:</p>
2991: <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 2992: <p>Each image will contain <code class="filename">README</code>,
1.87 wiz 2993: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
2994: in their root directories.</p>
1.75 rillig 2995: </div>
2996: </div>
2997: </div>
2998: <div class="chapter" lang="en">
2999: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3000: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90 rillig 3001: <div class="toc">
3002: <p><b>Table of Contents</b></p>
3003: <dl>
1.106 rillig 3004: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3005: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90 rillig 3006: </dl>
3007: </div>
3008: <p>The files that are installed by pkgsrc are organized in a way that
3009: is similar to what you find in the <code class="filename">/usr</code> directory
3010: of the base system. But some details are different. This is because
3011: pkgsrc initially came from FreeBSD and had adopted its file system
3012: hierarchy. Later it was largely influenced by NetBSD. But no matter
3013: which operating system you are using pkgsrc with, you can expect the
3014: same layout for pkgsrc.</p>
1.91 rillig 3015: <p>There are mainly four root directories for pkgsrc, which are all
3016: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3017: When pkgsrc has been installed as root, the default locations
3018: are:</p>
3019: <pre class="programlisting">
1.100 rillig 3020: LOCALBASE= /usr/pkg
3021: PKG_SYSCONFBASE= /usr/pkg/etc
3022: VARBASE= /var
3023: PKG_DBDIR= /var/db/pkg
1.91 rillig 3024: </pre>
3025: <p>In unprivileged mode (when pkgsrc has been installed as any other
3026: user), the default locations are:</p>
3027: <pre class="programlisting">
1.100 rillig 3028: LOCALBASE= ${HOME}/pkg
3029: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3030: VARBASE= ${HOME}/pkg/var
3031: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
1.91 rillig 3032: </pre>
3033: <p>What these four directories are for, and what they look like is
3034: explained below.</p>
1.90 rillig 3035: <div class="itemizedlist"><ul type="disc">
3036: <li><p><code class="varname">LOCALBASE</code> corresponds to the
3037: <code class="filename">/usr</code> directory in the base system. It is the
3038: “<span class="quote">main</span>” directory where the files are installed and contains
3039: the well-known subdirectories like <code class="filename">bin</code>,
3040: <code class="filename">include</code>, <code class="filename">lib</code>,
3041: <code class="filename">share</code> and
3042: <code class="filename">sbin</code>.</p></li>
3043: <li><p><code class="varname">VARBASE</code> corresponds to
3044: <code class="filename">/var</code> in the base system. Some programs (especially
3045: games, network daemons) need write access to it during normal
3046: operation.</p></li>
3047: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3048: <code class="filename">/etc</code> in the base system. It contains configuration
1.110 hubertf 3049: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90 rillig 3050: itself.</p></li>
3051: </ul></div>
3052: <div class="sect1" lang="en">
3053: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3054: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93 rillig 3055: </h2></div></div></div>
1.90 rillig 3056: <p>The following directories exist in a typical pkgsrc installation
1.91 rillig 3057: in <code class="filename">${LOCALBASE}</code>.</p>
1.90 rillig 3058: <div class="variablelist"><dl>
3059: <dt><span class="term"><code class="filename">bin</code></span></dt>
3060: <dd><p>Contains executable programs that are intended to be
3061: directly used by the end user.</p></dd>
3062: <dt><span class="term"><code class="filename">emul</code></span></dt>
3063: <dd><p>Contains files for the emulation layers of various other
3064: operating systems, especially for
3065: NetBSD.</p></dd>
3066: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3067: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3068: <dd><p>Contains
3069: the configuration files.</p></dd>
3070: <dt><span class="term"><code class="filename">include</code></span></dt>
3071: <dd><p>Contains headers for the C and C++ programming
3072: languages.</p></dd>
3073: <dt><span class="term"><code class="filename">info</code></span></dt>
3074: <dd><p>Contains GNU info files of various
3075: packages.</p></dd>
3076: <dt><span class="term"><code class="filename">lib</code></span></dt>
3077: <dd><p>Contains shared and static
3078: libraries.</p></dd>
3079: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3080: <dd><p>Contains data files that don't change after
3081: installation. Other data files belong into
3082: <code class="filename">${VARBASE}</code>.</p></dd>
3083: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3084: <dd><p>Contains programs that are not intended to be used by
3085: end users, such as helper programs or network
3086: daemons.</p></dd>
3087: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3088: <dd><p>Contains programs that are intended to be executed as
3089: CGI scripts by a web server.</p></dd>
3090: <dt><span class="term"><code class="filename">man</code> (the usual value of
3091: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3092: <dd><p>Contains brief
3093: documentation in form of manual pages.</p></dd>
3094: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3095: <dd><p>Contains programs that are intended to be used only by
3096: the super-user.</p></dd>
3097: <dt><span class="term"><code class="filename">share</code></span></dt>
3098: <dd><p>Contains platform-independent data files that don't
3099: change after installation.</p></dd>
3100: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3101: <dd><p>Contains documentation files provided by the
3102: packages.</p></dd>
3103: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3104: <dd><p>Contains example files provided by the packages. Among
3105: others, the original configuration files are saved here and copied to
3106: <code class="filename">${PKG_SYSCONFDIR}</code> during
3107: installation.</p></dd>
3108: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3109: <dd><p>Contains the original files for rc.d
3110: scripts.</p></dd>
3111: <dt><span class="term"><code class="filename">var</code> (the usual location of
3112: <code class="filename">${VARBASE}</code>)</span></dt>
3113: <dd><p>Contains files
3114: that may be modified after
3115: installation.</p></dd>
3116: </dl></div>
3117: </div>
3118: <div class="sect1" lang="en">
3119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3120: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93 rillig 3121: </h2></div></div></div>
1.90 rillig 3122: <div class="variablelist"><dl>
3123: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3124: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3125: <dd><p>Contains
3126: information about the currently installed
3127: packages.</p></dd>
3128: <dt><span class="term"><code class="filename">games</code></span></dt>
3129: <dd><p>Contains highscore
3130: files.</p></dd>
3131: <dt><span class="term"><code class="filename">log</code></span></dt>
3132: <dd><p>Contains log files.</p></dd>
3133: <dt><span class="term"><code class="filename">run</code></span></dt>
3134: <dd><p>Contains informational files about daemons that are
3135: currently running.</p></dd>
3136: </dl></div>
3137: </div>
3138: </div>
3139: <div class="chapter" lang="en">
3140: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3141: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 3142: <div class="toc">
3143: <p><b>Table of Contents</b></p>
3144: <dl>
1.106 rillig 3145: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3146: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3147: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3148: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3149: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3150: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
3151: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.110 hubertf 3152: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
1.106 rillig 3153: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
3154: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3155: /usr/share/tmac/tmac.andoc</span>” mean?</a></span></dt>
1.106 rillig 3156: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</a></span></dt>
3157: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3158: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3159: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
3160: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3161: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
3162: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</a></span></dt>
1.75 rillig 3163: </dl>
3164: </div>
3165: <p>This section contains hints, tips & tricks on special things in
3166: pkgsrc that we didn't find a better place for in the previous chapters, and
3167: it contains items for both pkgsrc users and developers.</p>
3168: <div class="sect1" lang="en">
3169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3170: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75 rillig 3171: <p>The following mailing lists may be of interest to pkgsrc users:</p>
3172: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 3173: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78 rillig 3174: This is a general purpose list for most issues regarding
3175: pkgsrc, regardless of platform, e.g. soliciting user help
3176: for pkgsrc configuration, unexpected build failures, using
3177: particular packages, upgrading pkgsrc installations,
3178: questions regarding the pkgsrc release branches, etc. General announcements or
3179: proposals for changes that impact the pkgsrc user community,
3180: e.g. major infrastructure changes, new features, package
3181: removals, etc., may also be posted.</p></li>
1.110 hubertf 3182: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75 rillig 3183: A list where the results of pkgsrc bulk builds are sent and
3184: discussed.</p></li>
1.110 hubertf 3185: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75 rillig 3186: This list is for those who are interested in getting a
3187: commit message for every change committed to pkgsrc. It is
3188: also available in digest form, meaning one daily message
3189: containing all commit messages for changes to the package
3190: source tree in that 24 hour period.</p></li>
3191: </ul></div>
3192: <p>To subscribe, do:</p>
3193: <pre class="programlisting">
1.100 rillig 3194: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75 rillig 3195: </pre>
3196: <p>Archives for all these mailing lists are available from
1.110 hubertf 3197: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75 rillig 3198: </div>
3199: <div class="sect1" lang="en">
3200: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3201: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75 rillig 3202: <p>Pkgviews is tightly integrated with buildlink. You can find a
3203: pkgviews User's guide in
1.76 rillig 3204: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75 rillig 3205: </div>
3206: <div class="sect1" lang="en">
3207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3208: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80 rillig 3209: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75 rillig 3210: a number of useful utilities for both users and developers of pkgsrc. This
3211: section attempts only to make the reader aware of the utilities and when
3212: they might be useful, and not to duplicate the documentation that comes
3213: with each package.</p>
3214: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91 rillig 3215: <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 3216: Symlinks for use by buildlink.</p></li></ul></div>
3217: <p>OS tool augmentation (automatically installed when needed):</p>
3218: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3219: <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 3220: Calculates various kinds of checksums (including SHA1).</p></li>
1.91 rillig 3221: <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 3222: Compatibility library for pkgsrc tools.</p></li>
1.91 rillig 3223: <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 3224: non-BSD systems due to lack of native mtree.</p></li>
1.91 rillig 3225: <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 3226: Up-to-date replacement for
1.76 rillig 3227: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75 rillig 3228: systems where pkg_install is not present.</p></li>
3229: </ul></div>
3230: <p>Utilities used by pkgsrc (not automatically installed):</p>
3231: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3232: <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 3233: Create a binary package from an
1.110 hubertf 3234: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.75 rillig 3235: save the old package.</p></li>
1.91 rillig 3236: <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 3237: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3238: from multiple locations. It currently supports the following
3239: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91 rillig 3240: <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 3241: packages someplace else (enabled by default).</p></li>
1.91 rillig 3242: <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 3243: best compiler flags to optimise code for your current CPU and
3244: compiler.</p></li>
3245: </ul></div>
3246: <p>Utilities for keeping track of installed packages, being up to date,
3247: etc:</p>
3248: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3249: <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 3250: packages whose installed versions do not match the latest pkgsrc
3251: entries.</p></li>
1.91 rillig 3252: <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 3253: dependency graphs of packages, to aid in choosing a strategy for
3254: updating.</p></li>
1.91 rillig 3255: <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
3256: 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>
3257: <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.112 ! weinem 3258: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
! 3259: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75 rillig 3260: does various checks on the complete pkgsrc system.</p></li>
1.91 rillig 3261: <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 3262: packages you have installed.</p></li>
3263: </ul></div>
3264: <p>Utilities for people maintaining or creating individual packages:</p>
3265: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3266: <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 3267: making and maintaining patches for a package (includes pkgdiff,
3268: pkgvi, mkpatches, etc.).</p></li>
1.91 rillig 3269: <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>,
3270: <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 3271: converting to pkgsrc.</p></li>
1.91 rillig 3272: <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 3273: pkgsrc to a Solaris package.</p></li>
3274: </ul></div>
3275: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3276: utilities)</p>
3277: <div class="itemizedlist"><ul type="disc">
1.91 rillig 3278: <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 3279: packages in a chrooted area.</p></li>
1.91 rillig 3280: <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 3281: kernel version for chrooted cross builds.</p></li>
3282: </ul></div>
3283: </div>
3284: <div class="sect1" lang="en">
3285: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3286: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75 rillig 3287: <p>If you want to use pkgsrc as non-root user, you can set some
3288: variables to make pkgsrc work under these conditions. At the very least,
3289: you need to set <code class="varname">UNPRIVILEGED</code> to “<span class="quote">yes</span>”; this
3290: will turn on unprivileged mode and set multiple related variables to allow
3291: installation of packages as non-root.</p>
3292: <p>In case the defaults are not enough, you may want to tune some other
3293: variables used. For example, if the automatic user/group detection leads
3294: to incorrect values (or not the ones you would like to use), you can change
3295: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3296: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3297: <p>As regards bootstrapping, please note that the
1.110 hubertf 3298: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75 rillig 3299: given the “<span class="quote">--ignore-user-check</span>” flag, as it will choose and
1.76 rillig 3300: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93 rillig 3301: installation targets. These directories can be overridden by the
1.75 rillig 3302: “<span class="quote">--prefix</span>” flag provided by the script, as well as some others
3303: that allow finer tuning of the tree layout.</p>
3304: </div>
3305: <div class="sect1" lang="en">
3306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3307: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75 rillig 3308: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3309: enable this feature by adding the option
3310: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110 hubertf 3311: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.75 rillig 3312: distfile is found, pkgsrc will try to resume it.</p>
3313: <p>You can also
1.110 hubertf 3314: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.75 rillig 3315: <code class="varname">FETCH_CMD</code> variable. Don't forget to set
3316: <code class="varname">FETCH_RESUME_ARGS</code> and
3317: <code class="varname">FETCH_OUTPUT_ARGS</code> if you are not using default
3318: values.</p>
3319: <p>For example, if you want to use
1.76 rillig 3320: <code class="filename">wget</code> to resume downloads, you'll have to use something
1.75 rillig 3321: like:</p>
3322: <pre class="programlisting">
1.100 rillig 3323: FETCH_CMD= wget
3324: FETCH_BEFORE_ARGS= --passive-ftp
3325: FETCH_RESUME_ARGS= -c
1.110 hubertf 3326: FETCH_OUTPUT_ARGS= -O -nc
1.1 grant 3327: </pre>
1.75 rillig 3328: </div>
3329: <div class="sect1" lang="en">
3330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3331: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103 wiz 3332: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76 rillig 3333: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75 rillig 3334: you will have to add the following line into
1.110 hubertf 3335: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75 rillig 3336: <pre class="programlisting">
1.103 wiz 3337: X11_TYPE=modular
1.1 grant 3338: </pre>
1.75 rillig 3339: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
3340: <h3 class="title">Note</h3>
1.103 wiz 3341: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3342: </p>
1.75 rillig 3343: </div>
3344: </div>
3345: <div class="sect1" lang="en">
3346: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3347: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75 rillig 3348: <p>If you are sitting behind a firewall which does not allow direct
3349: connections to Internet hosts (i.e. non-NAT), you may specify the
3350: relevant proxy hosts. This is done using an environment variable in the
3351: form of a URL, e.g. in Amdahl, the machine
3352: “<span class="quote">orpheus.amdahl.com</span>” is one of the firewalls, and it uses
3353: port 80 as the proxy port number. So the proxy environment variables
3354: are:</p>
3355: <pre class="programlisting">
1.100 rillig 3356: ftp_proxy=ftp://orpheus.amdahl.com:80/
3357: http_proxy=http://orpheus.amdahl.com:80/
1.1 grant 3358: </pre>
1.75 rillig 3359: </div>
3360: <div class="sect1" lang="en">
3361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 3362: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75 rillig 3363: <p>This depends on which utility is used to retrieve distfiles. From
1.76 rillig 3364: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75 rillig 3365: the first available command from the following list:</p>
3366: <div class="itemizedlist"><ul type="disc">
1.76 rillig 3367: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3368: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75 rillig 3369: </ul></div>
3370: <p>On a default NetBSD installation, this will be
1.76 rillig 3371: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75 rillig 3372: connections first, and falls back to active connections if the server
3373: refuses to do passive. For the other tools, add the following to your
1.110 hubertf 3374: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75 rillig 3375: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3376: <p>Having that option present will prevent
1.76 rillig 3377: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75 rillig 3378: transfers.</p>
3379: </div>
3380: <div class="sect1" lang="en">
3381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3382: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88 wiz 3383: <p>You would like to download all the distfiles in a single batch
1.110 hubertf 3384: from work or university, where you can't run a <span class="command"><strong>make
3385: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75 rillig 3386: but downloading the entire directory may not be appropriate.</p>
1.110 hubertf 3387: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76 rillig 3388: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75 rillig 3389: resulting list to your machine at work/school and use it there. If you
1.110 hubertf 3390: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75 rillig 3391: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3392: URL:</p>
3393: <p>At home:</p>
3394: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3395: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3396: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3397: <p>At work:</p>
3398: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76 rillig 3399: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75 rillig 3400: home.</p>
3401: <p>If you have a machine running NetBSD, and you want to get
1.88 wiz 3402: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3403: machine architecture), you can do so by using the above-mentioned
1.110 hubertf 3404: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88 wiz 3405: directly by running:</p>
1.75 rillig 3406: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3407: <p>If you even decide to ignore
3408: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3409: by running:</p>
3410: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3411: </div>
3412: <div class="sect1" lang="en">
3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3414: <a name="tmac.andoc-missing"></a>9.10. What does “<span class="quote">Don't know how to make
1.75 rillig 3415: /usr/share/tmac/tmac.andoc</span>” mean?</h2></div></div></div>
1.91 rillig 3416: <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 3417: package, you get the error from make that it doesn't know how to make
1.76 rillig 3418: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75 rillig 3419: you don't have installed the “<span class="quote">text</span>” set (nroff, ...) from
3420: the NetBSD base distribution on your machine. It is recommended to do
3421: that to format man pages.</p>
1.91 rillig 3422: <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 3423: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110 hubertf 3424: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 3425: </div>
3426: <div class="sect1" lang="en">
3427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3428: <a name="bsd.own.mk-missing"></a>9.11. What does “<span class="quote">Could not find bsd.own.mk</span>” mean?</h2></div></div></div>
1.87 wiz 3429: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75 rillig 3430: when you installed your NetBSD machine. Please get and install it, by
1.76 rillig 3431: extracting it in <code class="filename">/</code>:</p>
1.75 rillig 3432: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3433: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76 rillig 3434: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.110 hubertf 3435: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75 rillig 3436: -r</strong></span>).</p>
3437: </div>
3438: <div class="sect1" lang="en">
3439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3440: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75 rillig 3441: <p>When installing packages as non-root user and using the just-in-time
1.110 hubertf 3442: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75 rillig 3443: password for each required package installed. To avoid this, the sudo
3444: package can be used, which does password caching over a limited time. To
3445: use it, install sudo (either as binary package or from
1.98 wiz 3446: <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.110 hubertf 3447: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98 wiz 3448: <span class="emphasis"><em>after</em></span> the definition of the
3449: <code class="varname">LOCALBASE</code> variable:</p>
1.75 rillig 3450: <pre class="programlisting">
1.100 rillig 3451: .if exists(${LOCALBASE}/bin/sudo)
3452: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3453: .endif
1.1 grant 3454: </pre>
1.75 rillig 3455: </div>
3456: <div class="sect1" lang="en">
3457: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3458: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75 rillig 3459: <p>As the system administrator, you can choose where configuration files
3460: are installed. The default settings make all these files go into
1.76 rillig 3461: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75 rillig 3462: be suboptimal depending on your expectations (e.g., a read-only,
3463: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3464: configuration of the provided packages).</p>
3465: <p>In order to change the defaults, you can modify the
3466: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110 hubertf 3467: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76 rillig 3468: directory; some common examples include <code class="filename">/etc</code> or
3469: <code class="filename">/etc/pkg</code>.</p>
1.75 rillig 3470: <p>Furthermore, you can change this value on a per-package basis by
3471: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3472: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3473: package you would like to modify, that is, the contents of
3474: <code class="varname">PKGBASE</code>.</p>
3475: <p>Note that after changing these settings, you must rebuild and
3476: reinstall any affected packages.</p>
3477: </div>
3478: <div class="sect1" lang="en">
3479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3480: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75 rillig 3481: <p>Please be aware that there can often be bugs in third-party software,
3482: and some of these bugs can leave a machine vulnerable to exploitation by
3483: attackers. In an effort to lessen the exposure, the NetBSD packages team
3484: maintains a database of known-exploits to packages which have at one time
3485: been included in pkgsrc. The database can be downloaded automatically, and
3486: a security audit of all packages installed on a system can take place. To
1.91 rillig 3487: 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 3488: components:</p>
3489: <div class="orderedlist"><ol type="1">
3490: <li>
1.110 hubertf 3491: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.75 rillig 3492: download a list of the security vulnerabilities information. This list
3493: is kept up to date by the NetBSD security officer and the NetBSD
3494: packages team, and is distributed from the NetBSD ftp server:</p>
1.110 hubertf 3495: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75 rillig 3496: </li>
1.110 hubertf 3497: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.75 rillig 3498: current machine, checking each vulnerability which is known. If a
3499: vulnerable package is installed, it will be shown by output to stdout,
3500: including a description of the type of vulnerability, and a URL
3501: containing more information.</p></li>
3502: </ol></div>
1.91 rillig 3503: <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 3504: package is strongly recommended! After
3505: “<span class="quote">audit-packages</span>” is installed, please read
3506: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3507: audit-packages</code></strong>.</p>
1.87 wiz 3508: <p>If this package is installed, pkgsrc builds will use it to
1.110 hubertf 3509: perform a security check before building any package. See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, “Variables affecting the build process”</a> for ways to control this
1.87 wiz 3510: check.</p>
1.75 rillig 3511: </div>
3512: <div class="sect1" lang="en">
3513: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3514: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75 rillig 3515: <p>When you add your own preferences to the
3516: <code class="varname">CFLAGS</code> variable in your
1.110 hubertf 3517: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76 rillig 3518: environment variables to the <code class="filename">./configure</code>
1.110 hubertf 3519: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75 rillig 3520: <code class="varname">CFLAGS</code> from the environment variable by
1.76 rillig 3521: overriding them in the <code class="filename">Makefile</code>s of their
1.75 rillig 3522: package.</p>
3523: <p>Currently there is no solution to this problem. If you
3524: really need the package to use your <code class="varname">CFLAGS</code>
1.110 hubertf 3525: you should run <span class="command"><strong>make patch</strong></span> in the package
1.76 rillig 3526: directory and then inspect any <code class="filename">Makefile</code> and
3527: <code class="filename">Makefile.in</code> for whether they define
1.75 rillig 3528: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3529: these lines. But be aware that some “<span class="quote">smart</span>”
3530: programmers write so bad code that it only works for the
3531: specific combination of <code class="varname">CFLAGS</code> they have
3532: chosen.</p>
3533: </div>
1.80 rillig 3534: <div class="sect1" lang="en">
3535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3536: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.80 rillig 3537: <div class="procedure"><ol type="1">
3538: <li><p>Make sure that your copy of pkgsrc is consistent. A
3539: case that occurs often is that people only update pkgsrc in
3540: parts, because of performance reasons. Since pkgsrc is one large
3541: system, not a collection of many small systems, there are
3542: sometimes changes that only work when the whole pkgsrc tree is
3543: updated.</p></li>
3544: <li><p>Make sure that you don't have any CVS conflicts.
3545: Search for “<span class="quote"><<<<<<</span>” or
3546: “<span class="quote">>>>>>></span>” in all your pkgsrc
3547: files.</p></li>
3548: <li><p>Make sure that you don't have old copies of the packages
1.110 hubertf 3549: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80 rillig 3550: verify this.</p></li>
3551: <li><p>If the problem still exists, write a mail to the
3552: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3553: </ol></div>
3554: </div>
1.88 wiz 3555: <div class="sect1" lang="en">
3556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3557: <a name="faq.rcs-conflicts"></a>9.17. What does “<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>” mean?</h2></div></div></div>
1.89 rillig 3558: <p>You have modified a file from pkgsrc, and someone else has
3559: modified that same file afterwards in the CVS repository. Both changes
3560: are in the same region of the file, so when you updated pkgsrc, the
3561: <code class="literal">cvs</code> command marked the conflicting changes in the
3562: file. Because of these markers, the file is no longer a valid
3563: <code class="filename">Makefile</code>.</p>
3564: <p>Have a look at that file, and if you don't need your local changes
1.110 hubertf 3565: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89 rillig 3566: -dP</strong></span> in that directory to download the current version.</p>
3567: </div>
1.75 rillig 3568: </div>
3569: </div>
3570: <div class="part" lang="en">
3571: <div class="titlepage"><div><div><h1 class="title">
3572: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77 rillig 3573: <div class="partintro" lang="en">
3574: <div></div>
3575: <p>This part of the book deals with creating and
3576: modifying packages. It starts with a “<span class="quote">HOWTO</span>”-like
3577: guide on creating a new package. The remaining chapters are more
3578: like a reference manual for pkgsrc.</p>
1.75 rillig 3579: <div class="toc">
3580: <p><b>Table of Contents</b></p>
3581: <dl>
1.106 rillig 3582: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91 rillig 3583: <dd><dl>
1.106 rillig 3584: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3585: <dd><dl>
1.106 rillig 3586: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3587: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91 rillig 3588: </dl></dd>
1.106 rillig 3589: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3590: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3591: </dl></dd>
3592: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3593: <dd><dl>
3594: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3595: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
3596: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3597: <dd><dl>
3598: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3599: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3600: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3601: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3602: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3603: </dl></dd>
3604: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3605: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3606: <dd><dl>
3607: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3608: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3609: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3610: </dl></dd>
3611: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3612: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
3613: </dl></dd>
3614: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3615: <dd><dl>
3616: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
3617: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
3618: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3619: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3620: <dd><dl>
3621: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3622: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3623: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3624: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3625: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3626: </dl></dd>
3627: </dl></dd>
3628: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3629: <dd><dl>
3630: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
3631: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.110 hubertf 3632: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 3633: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3634: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
3635: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3636: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3637: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3638: </dl></dd>
3639: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3640: <dd><dl>
3641: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
3642: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3643: <dd><dl>
3644: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3645: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
3646: </dl></dd>
3647: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3648: <dd><dl>
3649: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
3650: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3651: </dl></dd>
3652: </dl></dd>
3653: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3654: <dd><dl>
3655: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3656: <dd><dl>
3657: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3658: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3659: </dl></dd>
3660: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3661: <dd><dl>
3662: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3663: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3664: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3665: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3666: </dl></dd>
3667: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3668: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3669: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3670: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3671: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3672: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3673: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3674: </dl></dd>
3675: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3676: <dd><dl>
3677: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3678: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3679: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 3680: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106 rillig 3681: </dl></dd>
3682: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3683: <dd><dl>
3684: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3685: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3686: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3687: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
3688: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3689: <dd><dl>
3690: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3691: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3692: </dl></dd>
3693: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3694: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3695: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3696: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3697: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3698: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3699: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3700: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3701: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3702: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3703: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3704: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3705: </dl></dd>
3706: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3707: <dd><dl>
3708: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3709: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3710: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3711: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3712: </dl></dd>
3713: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3714: <dd><dl>
3715: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3716: <dd><dl>
3717: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
3718: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3719: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3720: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3721: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3722: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3723: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3724: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3725: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3726: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3727: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3728: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3729: </dl></dd>
3730: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3731: <dd><dl>
3732: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3733: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3734: </dl></dd>
3735: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3736: <dd><dl>
3737: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3738: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3739: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3740: </dl></dd>
3741: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3742: <dd><dl>
3743: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3744: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3745: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3746: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3747: </dl></dd>
3748: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3749: <dd><dl>
3750: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3751: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
3752: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
3753: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3754: </dl></dd>
3755: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3756: <dd><dl>
3757: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3758: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3759: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3760: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3761: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3762: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3763: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3764: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 3765: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106 rillig 3766: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
3767: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3768: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3769: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3770: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3771: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3772: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3773: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3774: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 3775: emulation</a></span></dt>
1.106 rillig 3776: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3777: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77 rillig 3778: </dl></dd>
1.106 rillig 3779: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77 rillig 3780: </dl></dd>
1.106 rillig 3781: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3782: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77 rillig 3783: <dd><dl>
1.106 rillig 3784: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3785: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3786: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3787: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3788: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3789: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
3790: </dl></dd>
3791: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3792: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3793: <dd><dl>
3794: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3795: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3796: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3797: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 3798: </dl></dd>
1.75 rillig 3799: </dl>
3800: </div>
1.77 rillig 3801: </div>
3802: <div class="chapter" lang="en">
3803: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 3804: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91 rillig 3805: <div class="toc">
3806: <p><b>Table of Contents</b></p>
3807: <dl>
1.106 rillig 3808: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91 rillig 3809: <dd><dl>
1.106 rillig 3810: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3811: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.91 rillig 3812: </dl></dd>
1.106 rillig 3813: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3814: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91 rillig 3815: </dl>
3816: </div>
1.77 rillig 3817: <p>When you find a package that is not yet in pkgsrc, you
1.91 rillig 3818: most likely have a URL from where you can download the source
3819: code. Starting with this URL, creating a package involves only a
3820: few steps.</p>
1.77 rillig 3821: <div class="procedure"><ol type="1">
1.91 rillig 3822: <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 3823: <li><p>Then, choose one of the top-level directories as the
1.91 rillig 3824: category in which you want to place your package. You can also create a
3825: directory of your own (maybe called <code class="filename">local</code>). In that
3826: category directory, create another directory for your package and change
3827: into it.</p></li>
1.110 hubertf 3828: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91 rillig 3829: you for a URL. Enter the URL of the distribution file (in most cases a
3830: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3831: of your package are created automatically. The distribution file is
3832: extracted automatically to fill in some details in the
3833: <code class="filename">Makefile</code> that would otherwise have to be done
3834: manually.</p></li>
3835: <li>
3836: <p>Examine the extracted files to determine the dependencies of
3837: your package. Ideally, this is mentioned in some
3838: <code class="filename">README</code> file, but things may differ. For each of
3839: these dependencies, look where it exists in pkgsrc, and if there is a
3840: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3841: line to your package <code class="filename">Makefile</code> which includes that
3842: file just before the last line. If the
3843: <code class="filename">buildlink3.mk</code> file does not exist, add a
3844: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3845: version of the dependency and where it can be found in pkgsrc. This line
3846: should be placed in the third paragraph. If the dependency is only
3847: needed for building the package, but not when using it, use
3848: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3849: Your package may then look like this:</p>
1.77 rillig 3850: <pre class="programlisting">
1.100 rillig 3851: [...]
1.77 rillig 3852:
1.100 rillig 3853: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3854: DEPENDS+= screen-[0-9]*:../../misc/screen
3855: DEPENDS+= screen>=4.0:../../misc/screen
1.77 rillig 3856:
1.100 rillig 3857: [...]
1.77 rillig 3858:
1.100 rillig 3859: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3860: .include "../../devel/glib2/buildlink3.mk"
3861: .include "../../mk/bsd.pkg.mk"
1.77 rillig 3862: </pre>
3863: </li>
1.110 hubertf 3864: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91 rillig 3865: to be done to make your package a “<span class="quote">good</span>” one. If you don't
1.110 hubertf 3866: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3867: --explain</strong></span> or <span class="command"><strong>pkglint
1.91 rillig 3868: -e</strong></span>, which outputs additional
3869: explanations.</p></li>
3870: <li><p>In many cases the package is not yet ready to build. You can
1.110 hubertf 3871: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, “Common types of packages”</a>. After you have followed the instructions
1.91 rillig 3872: over there, you can hopefully continue here.</p></li>
1.110 hubertf 3873: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91 rillig 3874: directory from the extracted files. Besides these files, a lot of cache
3875: files and other system information has been saved in the working
3876: directory, which may become wrong after you edited the
3877: <code class="filename">Makefile</code>.</p></li>
1.110 hubertf 3878: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3879: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.91 rillig 3880: <li><p>When the package builds fine, the next step is to install
1.110 hubertf 3881: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91 rillig 3882: everything works.</p></li>
3883: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
3884: contains a list of the files that are installed by the package, is
1.110 hubertf 3885: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91 rillig 3886: >PLIST</strong></span> to generate a probably correct list. Check
3887: the file using your preferred text editor to see if the list of
3888: files looks plausible.</p></li>
1.110 hubertf 3889: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91 rillig 3890: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110 hubertf 3891: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91 rillig 3892: has been registered in the database of installed files, but with an
1.110 hubertf 3893: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3894: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91 rillig 3895: registered with the list of files from
3896: <code class="filename">PLIST</code>.</p></li>
1.110 hubertf 3897: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91 rillig 3898: package from the set of installed files.</p></li>
1.77 rillig 3899: </ol></div>
1.91 rillig 3900: <div class="sect1" lang="en">
3901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3902: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91 rillig 3903: <div class="sect2" lang="en">
3904: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3905: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91 rillig 3906: <p>Simple Perl modules are handled automatically by
1.110 hubertf 3907: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91 rillig 3908: </div>
3909: <div class="sect2" lang="en">
3910: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3911: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91 rillig 3912: <p>KDE applications should always include
3913: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3914: settings that are typical of KDE packages.</p>
3915: </div>
3916: </div>
3917: <div class="sect1" lang="en">
3918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 3919: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91 rillig 3920: <div class="sect2" lang="en">
3921: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 3922: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91 rillig 3923: <div class="sect3" lang="en">
3924: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3925: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91 rillig 3926: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
3927: that the “<span class="quote">nvu</span>” package has not yet been imported into
3928: pkgsrc. As the description says it has to do with the web, the obvious
3929: choice for the category is “<span class="quote">www</span>”.</p>
3930: <pre class="programlisting">
1.100 rillig 3931: <code class="prompt">$</code> mkdir www/nvu
3932: <code class="prompt">$</code> cd www/nvu
1.91 rillig 3933: </pre>
3934: <p>The web site says that the sources are available as a tar file, so
1.110 hubertf 3935: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91 rillig 3936: <pre class="programlisting">
1.100 rillig 3937: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91 rillig 3938: </pre>
3939: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
3940: below the <code class="varname">DISTNAME</code> line, as the package name should
3941: not have the word “<span class="quote">sources</span>” in it. I also filled in the
3942: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
3943: <code class="varname">COMMENT</code> fields. Then the package
3944: <code class="filename">Makefile</code> looked like that:</p>
3945: <pre class="programlisting">
1.100 rillig 3946: # $NetBSD$
3947: #
1.91 rillig 3948:
1.100 rillig 3949: DISTNAME= nvu-1.0-sources
3950: PKGNAME= nvu-1.0
3951: CATEGORIES= www
3952: MASTER_SITES= http://cvs.nvu.com/download/
3953: EXTRACT_SUFX= .tar.bz2
3954:
3955: MAINTAINER= rillig@NetBSD.org
3956: HOMEPAGE= http://cvs.nvu.com/
3957: COMMENT= Web Authoring System
1.91 rillig 3958:
1.100 rillig 3959: # url2pkg-marker (please do not remove this line.)
3960: .include "../../mk/bsd.pkg.mk"
1.91 rillig 3961: </pre>
3962: <p>Then, I quit the editor and watched pkgsrc downloading a large
3963: source archive:</p>
3964: <pre class="programlisting">
1.100 rillig 3965: url2pkg> Running "make makesum" ...
3966: => Required installed package digest>=20010302: digest-20060826 found
3967: => Fetching nvu-1.0-sources.tar.bz2
3968: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3969: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3970: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3971: url2pkg> Running "make extract" ...
3972: => Required installed package digest>=20010302: digest-20060826 found
3973: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3974: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3975: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3976: ===> Installing dependencies for nvu-1.0
3977: ===> Overriding tools for nvu-1.0
3978: ===> Extracting for nvu-1.0
3979: url2pkg> Adjusting the Makefile.
1.91 rillig 3980:
1.100 rillig 3981: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91 rillig 3982:
1.100 rillig 3983: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91 rillig 3984: </pre>
3985: </div>
3986: <div class="sect3" lang="en">
3987: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 3988: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91 rillig 3989: <p>Now that the package has been extracted, let's see what's inside
3990: it. The package has a <code class="filename">README.txt</code>, but that only
3991: says something about mozilla, so it's probably useless for seeing what
3992: dependencies this package has. But since there is a GNU configure script
3993: in the package, let's hope that it will complain about everything it
3994: needs.</p>
3995: <pre class="programlisting">
1.100 rillig 3996: <code class="prompt">$</code> bmake
3997: => Required installed package digest>=20010302: digest-20060826 found
3998: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3999: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4000: ===> Patching for nvu-1.0
4001: ===> Creating toolchain wrappers for nvu-1.0
4002: ===> Configuring for nvu-1.0
4003: [...]
4004: configure: error: Perl 5.004 or higher is required.
4005: [...]
4006: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4007: [...]
1.91 rillig 4008: </pre>
4009: <p>That worked quite well. So I opened the package Makefile in my
4010: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4011: just appended “<span class="quote">perl</span>” to it. Since the dependencies of the
4012: package have changed now, and since a perl wrapper is automatically
4013: installed in the “<span class="quote">tools</span>” phase, I need to build the package
4014: from scratch.</p>
4015: <pre class="programlisting">
1.100 rillig 4016: <code class="prompt">$</code> bmake clean
4017: ===> Cleaning for nvu-1.0
4018: <code class="prompt">$</code> bmake
4019: [...]
4020: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4021: GNU Make. You will not be able to build Mozilla without GNU Make.
4022: [...]
1.91 rillig 4023: </pre>
4024: <p>So I added “<span class="quote">gmake</span>” to the
4025: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4026: <pre class="programlisting">
1.100 rillig 4027: [...]
4028: checking for GTK - version >= 1.2.0... no
4029: *** Could not run GTK test program, checking why...
4030: [...]
1.91 rillig 4031: </pre>
4032: <p>Now to the other dependencies. The first question is: Where is the
4033: GTK package hidden in pkgsrc?</p>
4034: <pre class="programlisting">
1.100 rillig 4035: <code class="prompt">$</code> echo ../../*/gtk*
4036: [many packages ...]
4037: <code class="prompt">$</code> echo ../../*/gtk
4038: ../../x11/gtk
4039: <code class="prompt">$</code> echo ../../*/gtk2
4040: ../../x11/gtk2
4041: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4042: ../../x11/gtk2/buildlink3.mk
1.91 rillig 4043: </pre>
4044: <p>The first try was definitely too broad. The second one had exactly
4045: one result, which is very good. But there is one pitfall with GNOME
4046: packages. Before GNOME 2 had been released, there were already many
4047: GNOME 1 packages in pkgsrc. To be able to continue to use these
4048: packages, the GNOME 2 packages were imported as separate packages, and
4049: their names usually have a “<span class="quote">2</span>” appended. So I checked
4050: whether this was the case here, and indeed it was.</p>
4051: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4052: file, adding the dependency is very easy. I just inserted an
4053: <code class="literal">.include</code> line before the last line of the package
4054: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4055: <pre class="programlisting">
1.100 rillig 4056: [...]
4057: .include "../../x11/gtk2/buildlink3.mk"
4058: .include "../../mk/bsd.pkg.mk
1.91 rillig 4059: </pre>
1.110 hubertf 4060: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.91 rillig 4061: was:</p>
4062: <pre class="programlisting">
1.100 rillig 4063: [...]
4064: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4065: checking for GTK - version >= 1.2.0... no
4066: *** Could not run GTK test program, checking why...
4067: *** The test program failed to compile or link. See the file config.log for the
4068: *** exact error that occured. This usually means GTK was incorrectly installed
4069: *** or that you have moved GTK since it was installed. In the latter case, you
4070: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4071: configure: error: Test for GTK failed.
4072: [...]
1.91 rillig 4073: </pre>
4074: <p>In this particular case, the assumption that “<span class="quote">every package
4075: prefers GNOME 2</span>” had been wrong. The first of the lines above
4076: told me that this package really wanted to have the GNOME 1 version of
4077: GTK. If the package had looked for GTK2, it would have looked for
1.110 hubertf 4078: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91 rillig 4079: So I changed the <code class="literal">x11/gtk2</code> to
4080: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4081: and tried again.</p>
4082: <pre class="programlisting">
1.100 rillig 4083: [...]
4084: 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
4085: In file included from xpidl.c:42:
4086: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4087: In file included from xpidl.c:42:
4088: xpidl.h:132: error: parse error before "IDL_ns"
4089: [...]
1.91 rillig 4090: </pre>
4091: <p>The package still does not find all of its dependencies. Now the
4092: question is: Which package provides the
4093: <code class="filename">libIDL/IDL.h</code> header file?</p>
4094: <pre class="programlisting">
1.100 rillig 4095: <code class="prompt">$</code> echo ../../*/*idl*
4096: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4097: <code class="prompt">$</code> echo ../../*/*IDL*
4098: ../../net/libIDL
1.91 rillig 4099: </pre>
4100: <p>Let's take the one from the second try. So I included the
4101: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4102: again. But the error didn't change. After digging through some of the
4103: code, I concluded that the build process of the package was broken and
4104: couldn't have ever worked, but since the Mozilla source tree is quite
4105: large, I didn't want to fix it. So I added the following to the package
4106: <code class="filename">Makefile</code> and tried again:</p>
4107: <pre class="programlisting">
1.100 rillig 4108: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4109: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
1.91 rillig 4110: </pre>
4111: <p>The latter line is needed because the package expects the library
4112: <code class="filename">libIDL.so</code>, but only
4113: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4114: wrapper to rewrite that on the fly.</p>
4115: <p>The next problem was related to a recent change of the FreeType
4116: 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>
4117: which patch files were relevant for this issue and copied them to the
4118: <code class="filename">patches</code> directory. Then I retried, fixed the
4119: patches so that they applied cleanly and retried again. This time,
4120: everything worked.</p>
4121: </div>
4122: <div class="sect3" lang="en">
4123: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 4124: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91 rillig 4125: <pre class="programlisting">
1.100 rillig 4126: <code class="prompt">$</code> bmake CHECK_FILES=no install
4127: [...]
4128: <code class="prompt">$</code> bmake print-PLIST >PLIST
4129: <code class="prompt">$</code> bmake deinstall
4130: <code class="prompt">$</code> bmake install
1.91 rillig 4131: </pre>
4132: </div>
4133: </div>
4134: </div>
1.77 rillig 4135: </div>
1.75 rillig 4136: <div class="chapter" lang="en">
4137: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4138: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75 rillig 4139: <div class="toc">
4140: <p><b>Table of Contents</b></p>
4141: <dl>
1.106 rillig 4142: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4143: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
4144: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4145: <dd><dl>
4146: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4147: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4148: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4149: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4150: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4151: </dl></dd>
4152: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4153: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4154: <dd><dl>
4155: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4156: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4157: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78 rillig 4158: </dl></dd>
1.106 rillig 4159: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4160: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75 rillig 4161: </dl>
4162: </div>
1.87 wiz 4163: <p>Whenever you're preparing a package, there are a number of
4164: files involved which are described in the following
4165: sections.</p>
1.75 rillig 4166: <div class="sect1" lang="en">
4167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4168: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93 rillig 4169: </h2></div></div></div>
1.75 rillig 4170: <p>Building, installation and creation of a binary package are all
1.87 wiz 4171: controlled by the package's <code class="filename">Makefile</code>.
4172: The <code class="filename">Makefile</code> describes various things about
4173: a package, for example from where to get it, how to configure,
4174: build, and install it.</p>
1.76 rillig 4175: <p>A package <code class="filename">Makefile</code> contains several
1.87 wiz 4176: sections that describe the package.</p>
1.75 rillig 4177: <p>In the first section there are the following variables, which
1.87 wiz 4178: should appear exactly in the order given here. The order and
4179: grouping of the variables is mostly historical and has no further
4180: meaning.</p>
1.75 rillig 4181: <div class="itemizedlist"><ul type="disc">
4182: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87 wiz 4183: distribution file to be downloaded from the package's
4184: website.</p></li>
1.75 rillig 4185: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87 wiz 4186: package, as used by pkgsrc. You only need to provide it if
4187: <code class="varname">DISTNAME</code> (which is the default) is not a good
4188: name for the package in pkgsrc. Usually it is the pkgsrc
4189: directory name together with the version number. It must match the
4190: regular expression
4191: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4192: starts with a letter or digit, and contains only letters, digits,
4193: dashes, underscores, dots and plus signs.</p></li>
4194: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
4195: the package file to create if the <code class="varname">PKGNAME</code>
4196: isn't unique on a SVR4 system. The default is
4197: <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91 rillig 4198: <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 4199: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4200: does not produce an unique package name on a SVR4 system.
4201: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4202: characters.</p></li>
1.75 rillig 4203: <li>
4204: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87 wiz 4205: which the package fits in. You can choose any of the top-level
4206: directories of pkgsrc for it.</p>
1.75 rillig 4207: <p>Currently the following values are available for
1.87 wiz 4208: <code class="varname">CATEGORIES</code>. If more than
4209: one is used, they need to be separated by spaces:</p>
1.75 rillig 4210: <pre class="programlisting">
1.100 rillig 4211: archivers cross geography meta-pkgs security
4212: audio databases graphics misc shells
4213: benchmarks devel ham multimedia sysutils
4214: biology editors inputmethod net textproc
4215: cad emulators lang news time
4216: chat finance mail parallel wm
4217: comms fonts math pkgtools www
4218: converters games mbone print x11
4219: </pre>
1.75 rillig 4220: </li>
1.81 rillig 4221: <li><p><code class="varname">MASTER_SITES</code>,
1.87 wiz 4222: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4223: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4224: and <code class="varname">DISTFILES</code> are discussed in detail in
1.110 hubertf 4225: <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, “The <span class="emphasis"><em>fetch</em></span> phase”</a>.</p></li>
1.75 rillig 4226: </ul></div>
4227: <p>The second section contains information about separately
1.87 wiz 4228: downloaded patches, if any.
4229: </p>
1.75 rillig 4230: <div class="itemizedlist"><ul type="disc">
4231: <li><p><code class="varname">PATCHFILES:</code>
1.87 wiz 4232: Name(s) of additional files that contain distribution patches.
4233: There is no default. pkgsrc will look for them at
4234: <code class="varname">PATCH_SITES</code>.
4235: They will automatically be uncompressed before patching if
4236: the names end with <code class="filename">.gz</code> or
4237: <code class="filename">.Z</code>.</p></li>
1.75 rillig 4238: <li><p><code class="varname">PATCH_SITES</code>:
1.87 wiz 4239: Primary location(s) for distribution patch files (see
4240: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75 rillig 4241: </ul></div>
4242: <p>The third section contains the following variables.
1.87 wiz 4243: </p>
1.75 rillig 4244: <div class="itemizedlist"><ul type="disc">
4245: <li><p><code class="varname">MAINTAINER</code> is the email address
1.87 wiz 4246: of the person who feels responsible for this package, and who is
4247: most likely to look at problems or questions regarding this
1.110 hubertf 4248: package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>. Other
1.87 wiz 4249: developers should contact the <code class="varname">MAINTAINER</code> before
4250: making major changes to the package. When packaging a new program,
4251: set <code class="varname">MAINTAINER</code> to yourself. If you really can't
4252: maintain the package for future updates, set it to
1.110 hubertf 4253: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.75 rillig 4254: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87 wiz 4255: find more information about the package.</p></li>
1.75 rillig 4256: <li><p><code class="varname">COMMENT</code> is a one-line
1.87 wiz 4257: description of the package (should not include the package
4258: name).</p></li>
1.75 rillig 4259: </ul></div>
4260: <p>Other variables that affect the build:
1.87 wiz 4261: </p>
1.75 rillig 4262: <div class="itemizedlist"><ul type="disc"><li>
4263: <p><code class="varname">WRKSRC</code>: The directory where the
1.87 wiz 4264: interesting distribution files of the package are found. The
4265: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4266: works for most packages.</p>
1.75 rillig 4267: <p>If a package doesn't create a subdirectory for itself
1.87 wiz 4268: (most GNU software does, for instance), but extracts itself in
4269: the current directory, you should set
4270: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4271: <p>If a package doesn't create a subdirectory with the
4272: name of <code class="varname">DISTNAME</code> but some different name,
4273: set <code class="varname">WRKSRC</code> to point to the proper name in
4274: <code class="filename">${WRKDIR}</code>, for example
4275: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91 rillig 4276: <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 4277: <p>The name of the working directory created by pkgsrc is
1.87 wiz 4278: taken from the <code class="varname">WRKDIR_BASENAME</code>
4279: variable. By default, its value is
4280: <code class="filename">work</code>. If you want to use the same
4281: pkgsrc tree for building different kinds of binary packages,
4282: you can change the variable according to your needs. Two
4283: other variables handle common cases of setting
4284: <code class="varname">WRKDIR_BASENAME</code> individually. If
4285: <code class="varname">OBJHOSTNAME</code> is defined in
1.110 hubertf 4286: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87 wiz 4287: the host's name is attached to the directory name. If
4288: <code class="varname">OBJMACHINE</code> is defined, the platform name
4289: is attached, which might look like
4290: <code class="filename">work.i386</code> or
4291: <code class="filename">work.sparc</code>.</p>
1.75 rillig 4292: </li></ul></div>
4293: <p>Please pay attention to the following gotchas:</p>
4294: <div class="itemizedlist"><ul type="disc">
1.87 wiz 4295: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88 wiz 4296: installed in compressed form by the package. For packages using
4297: BSD-style makefiles which honor MANZ, there is
4298: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76 rillig 4299: <li><p>Replace <code class="filename">/usr/local</code> with
1.88 wiz 4300: “<span class="quote">${PREFIX}</span>” in all files (see patches,
4301: below).</p></li>
1.110 hubertf 4302: <li><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, “Packages installing info files”</a>.</p></li>
1.75 rillig 4303: </ul></div>
4304: </div>
4305: <div class="sect1" lang="en">
4306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4307: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93 rillig 4308: </h2></div></div></div>
1.76 rillig 4309: <p>The <code class="filename">distinfo</code> file contains the message
1.87 wiz 4310: digest, or checksum, of each distfile needed for the package. This
4311: ensures that the distfiles retrieved from the Internet have not been
4312: corrupted during transfer or altered by a malign force to introduce
4313: a security hole. Due to recent rumor about weaknesses of digest
4314: algorithms, all distfiles are protected using both SHA1 and RMD160
4315: message digests, as well as the file size.</p>
1.76 rillig 4316: <p>The <code class="filename">distinfo</code> file also contains the
1.87 wiz 4317: checksums for all the patches found in the
1.110 hubertf 4318: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.76 rillig 4319: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110 hubertf 4320: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87 wiz 4321: command.</p>
1.75 rillig 4322: <p>Some packages have different sets of distfiles depending on
1.91 rillig 4323: 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 4324: <code class="filename">distinfo</code> file and care should be taken when
4325: upgrading such a package to ensure distfile information is not
4326: lost.</p>
1.75 rillig 4327: </div>
4328: <div class="sect1" lang="en">
4329: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4330: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93 rillig 4331: <p>Many packages still don't work out-of-the box on the various
4332: platforms that are supported by pkgsrc. Therefore, a number of custom
4333: patch files are needed to make the package work. These patch files are
4334: found in the <code class="filename">patches/</code> directory.</p>
4335: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4336: applied to the files in <code class="varname">WRKSRC</code> directory after
1.110 hubertf 4337: extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.93 rillig 4338: order</a>, so <code class="filename">patch-aa</code> is applied before
1.87 wiz 4339: <code class="filename">patch-ab</code>, etc.</p>
1.93 rillig 4340: <div class="sect2" lang="en">
4341: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4342: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76 rillig 4343: <p>The <code class="filename">patch-*</code> files should be in
1.110 hubertf 4344: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93 rillig 4345: problems. (To force patches to apply with fuzz you can set
4346: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94 dmcmahil 4347: should contain only changes for a single file, and no file should be
1.93 rillig 4348: patched by more than one patch file. This helps to keep future
4349: modifications simple.</p>
4350: <p>Each patch file is structured as follows: In the first line,
4351: there is the RCS Id of the patch itself. The second line should be
4352: empty for aesthetic reasons. After that, there should be a comment for
4353: each change that the patch does. There are a number of standard
4354: cases:</p>
4355: <div class="itemizedlist"><ul type="disc">
4356: <li><p>Patches that replace the <code class="literal">==</code>
1.110 hubertf 4357: operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111 rillig 4358: are so common that they don't need a comment at all.</p></li>
1.93 rillig 4359: <li><p>Patches for commonly known vulnerabilities should
4360: mention the vulnerability ID (CAN, CVE).</p></li>
4361: <li><p>Patches that change source code should mention the
4362: platform and other environment (for example, the compiler) that the
4363: patch is needed for.</p></li>
4364: </ul></div>
4365: <p>In all other cases, the patch should be commented so that any
4366: developer who knows the code of the application can make some use of
4367: the patch. Special care should be taken for the upstream developers,
4368: since we generally want that they accept our patches, so we have less
4369: work in the future.</p>
4370: </div>
4371: <div class="sect2" lang="en">
4372: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4373: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93 rillig 4374: <p>One important thing to mention is to pay attention that no RCS
4375: IDs get stored in the patch files, as these will cause problems when
1.87 wiz 4376: later checked into the NetBSD CVS tree. Use the
1.110 hubertf 4377: <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93 rillig 4378: problems.</p>
1.87 wiz 4379: <p>For even more automation, we recommend using
1.110 hubertf 4380: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87 wiz 4381: whole set of patches. You just have to backup files before you
4382: edit them to <code class="filename">filename.orig</code>, e.g. with
1.110 hubertf 4383: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4384: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87 wiz 4385: you upgrade a package this way, you can easily compare the new
4386: set of patches with the previously existing one with
1.110 hubertf 4387: <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87 wiz 4388: or update from the <code class="filename">work/.newpatches</code>
4389: directory to <code class="filename">patches/</code>.</p>
4390: <p>When you have finished a package, remember to generate
1.110 hubertf 4391: the checksums for the patch files by using the <span class="command"><strong>make
4392: makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, “<code class="filename">distinfo</code>”</a>.</p>
1.87 wiz 4393: <p>When adding a patch that corrects a problem in the
4394: distfile (rather than e.g. enforcing pkgsrc's view of where
4395: man pages should go), send the patch as a bug report to the
4396: maintainer. This benefits non-pkgsrc users of the package,
4397: and usually makes it possible to remove the patch in future
4398: version.</p>
1.101 rillig 4399: <p>The file names of the patch files are usually of the form
4400: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93 rillig 4401: </div>
4402: <div class="sect2" lang="en">
4403: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4404: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87 wiz 4405: <p>If you want to share patches between multiple packages
4406: in pkgsrc, e.g. because they use the same distfiles, set
4407: <code class="varname">PATCHDIR</code> to the path where the patch files
4408: can be found, e.g.:</p>
4409: <pre class="programlisting">
1.100 rillig 4410: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93 rillig 4411: </pre>
1.75 rillig 4412: <p>Patch files that are distributed by the author or other
1.87 wiz 4413: maintainers can be listed in
4414: <code class="varname">PATCHFILES</code>.</p>
4415: <p>If it is desired to store any patches that should not be
4416: committed into pkgsrc, they can be kept outside the pkgsrc
4417: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4418: directory tree there is expected to have the same
4419: “<span class="quote">category/package</span>” structure as pkgsrc, and
4420: patches are expected to be stored inside these dirs (also
4421: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4422: example, if you want to keep a private patch for
4423: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4424: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4425: files in the named directory are expected to be patch files,
4426: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4427: applied</em></span>.</p>
1.93 rillig 4428: </div>
1.85 jmmv 4429: <div class="sect2" lang="en">
4430: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4431: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85 jmmv 4432: <p>When fixing a portability issue in the code do not use
4433: preprocessor magic to check for the current operating system nor
4434: platform. Doing so hurts portability to other platforms because
4435: the OS-specific details are not abstracted appropriately.</p>
4436: <p>The general rule to follow is: instead of checking for the
4437: operating system the application is being built on, check for the
4438: specific <span class="emphasis"><em>features</em></span> you need. For example,
4439: instead of assuming that kqueue is available under NetBSD and
4440: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.112 ! weinem 4441: kqueue support, add a check that detects kqueue itself —
1.85 jmmv 4442: yes, this generally involves patching the
1.110 hubertf 4443: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.85 jmmv 4444: that prevents some OSes from adopting interfaces from other OSes
4445: (e.g. Linux implementing kqueue), something that the above checks
4446: cannot take into account.</p>
4447: <p>Of course, checking for features generally involves more
4448: work on the developer's side, but the resulting changes are
1.87 wiz 4449: cleaner and there are chances they will work on many other
1.85 jmmv 4450: platforms. Not to mention that there are higher chances of being
4451: later integrated into the mainstream sources. Remember:
4452: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4453: <p>Some typical examples:</p>
4454: <div class="table">
1.106 rillig 4455: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91 rillig 4456: <div class="table-contents"><table summary="Patching examples" border="1">
1.85 jmmv 4457: <colgroup>
4458: <col>
4459: <col>
4460: <col>
4461: </colgroup>
4462: <thead><tr>
4463: <th>Where</th>
4464: <th>Incorrect</th>
4465: <th>Correct</th>
4466: </tr></thead>
4467: <tbody>
4468: <tr>
4469: <td>configure script</td>
4470: <td>
1.100 rillig 4471: <pre class="programlisting">
4472: case ${target_os} in
4473: netbsd*) have_kvm=yes ;;
4474: *) have_kvm=no ;;
4475: esac
4476: </pre>
1.85 jmmv 4477: </td>
4478: <td>
1.100 rillig 4479: <pre class="programlisting">
4480: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4481: </pre>
1.85 jmmv 4482: </td>
4483: </tr>
4484: <tr>
4485: <td>C source file</td>
4486: <td>
1.100 rillig 4487: <pre class="programlisting">
4488: #if defined(__NetBSD__)
4489: # include <sys/event.h>
4490: #endif
4491: </pre>
1.85 jmmv 4492: </td>
4493: <td>
1.100 rillig 4494: <pre class="programlisting">
4495: #if defined(HAVE_SYS_EVENT_H)
4496: # include <sys/event.h>
4497: #endif
4498: </pre>
1.85 jmmv 4499: </td>
4500: </tr>
4501: <tr>
4502: <td>C source file</td>
4503: <td>
1.100 rillig 4504: <pre class="programlisting">
4505: int
4506: monitor_file(...)
4507: {
4508: #if defined(__NetBSD__)
4509: int fd = kqueue();
4510: ...
4511: #else
4512: ...
4513: #endif
4514: }
4515: </pre>
1.85 jmmv 4516: </td>
4517: <td>
1.100 rillig 4518: <pre class="programlisting">
4519: int
4520: monitor_file(...)
4521: {
4522: #if defined(HAVE_KQUEUE)
4523: int fd = kqueue();
4524: ...
4525: #else
4526: ...
4527: #endif
4528: }
4529: </pre>
1.85 jmmv 4530: </td>
4531: </tr>
4532: </tbody>
1.91 rillig 4533: </table></div>
1.85 jmmv 4534: </div>
1.91 rillig 4535: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110 hubertf 4536: packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
4537: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85 jmmv 4538: 2</a>). It summarizes multiple details on how to make
4539: software easier to package; all the suggestions in it were
4540: collected from our experience in pkgsrc work, so they are possibly
4541: helpful when creating patches too.</p>
4542: </div>
4543: <div class="sect2" lang="en">
4544: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4545: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85 jmmv 4546: <p>Always, always, <span class="strong"><strong>always</strong></span>
4547: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4548: improvements you do to a package to the mainstream developers.
4549: This is the only way to get their attention on portability issues
4550: and to ensure that future versions can be built out-of-the box on
4551: NetBSD. Furthermore, any user that gets newer distfiles will get
4552: the fixes straight from the packaged code.</p>
1.93 rillig 4553: <p>This generally involves cleaning up the patches
4554: (because sometimes the patches that are
1.85 jmmv 4555: added to pkgsrc are quick hacks), filling bug reports in the
4556: appropriate trackers for the projects and working with the
4557: mainstream authors to accept your changes. It is
4558: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4559: the packages in pkgsrc are kept simple and thus further changes
4560: can be done without much hassle.</p>
4561: <p>Support the idea of free software!</p>
4562: </div>
1.75 rillig 4563: </div>
4564: <div class="sect1" lang="en">
4565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4566: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75 rillig 4567: <div class="variablelist"><dl>
1.76 rillig 4568: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75 rillig 4569: <dd><p>A multi-line description of the piece of software. This should include
1.87 wiz 4570: any credits where they are due. Please bear in mind that others do not
4571: share your sense of humour (or spelling idiosyncrasies), and that others
4572: will read everything that you write here.</p></dd>
1.76 rillig 4573: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87 wiz 4574: <dd><p>This file governs the files that are installed on your
4575: system: all the binaries, manual pages, etc. There are other
4576: directives which may be entered in this file, to control the
4577: creation and deletion of directories, and the location of
1.110 hubertf 4578: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87 wiz 4579: information.</p></dd>
1.75 rillig 4580: </dl></div>
4581: </div>
4582: <div class="sect1" lang="en">
4583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4584: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78 rillig 4585: <div class="sect2" lang="en">
4586: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4587: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75 rillig 4588: <div class="variablelist"><dl>
1.76 rillig 4589: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110 hubertf 4590: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87 wiz 4591: First time after package extraction and before files are
4592: moved in place, the second time after the files to install
4593: are moved in place. This can be used to do any custom
4594: procedures not possible with @exec commands in
1.110 hubertf 4595: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4596: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information. See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a>.</p></dd>
1.76 rillig 4597: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75 rillig 4598: <dd><p>This script is executed before and after any files are removed. It is
1.87 wiz 4599: this script's responsibility to clean up any additional messy details
4600: around the package's installation, since all pkg_delete knows is how to
4601: delete the files created in the original distribution.
1.110 hubertf 4602: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4603: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76 rillig 4604: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75 rillig 4605: <dd>
4606: <p>This file is displayed after installation of the package.
1.87 wiz 4607: Useful for things like legal notices on almost-free
4608: software and hints for updating config files after
4609: installing modules for apache, PHP etc.
4610: Please note that you can modify variables in it easily by using
4611: <code class="varname">MESSAGE_SUBST</code> in the package's
4612: <code class="filename">Makefile</code>:</p>
1.75 rillig 4613: <pre class="programlisting">
1.100 rillig 4614: MESSAGE_SUBST+= SOMEVAR="somevalue"
4615: </pre>
1.75 rillig 4616: <p>replaces "${SOMEVAR}" with “<span class="quote">somevalue</span>” in
1.87 wiz 4617: <code class="filename">MESSAGE</code>. By default, substitution is
4618: performed for <code class="varname">PKGNAME</code>,
4619: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4620: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4621: <code class="varname">X11BASE</code>,
4622: <code class="varname">PKG_SYSCONFDIR</code>,
4623: <code class="varname">ROOT_GROUP</code>, and
4624: <code class="varname">ROOT_GROUP</code>.</p>
4625: <p>You can display a different or additional files by
4626: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4627: default is <code class="filename">MESSAGE</code>, if the file
4628: exists.</p>
1.75 rillig 4629: </dd>
1.78 rillig 4630: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4631: <dd><p>FIXME: There is no documentation on the
4632: alternatives framework.</p></dd>
4633: </dl></div>
4634: </div>
4635: <div class="sect2" lang="en">
4636: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4637: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78 rillig 4638: <div class="variablelist"><dl>
4639: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4640: <dd><p>This file contains arbitrary things that could
4641: also go into a <code class="filename">Makefile</code>, but its purpose is
4642: to be used by more than one package. This file should only be
4643: used when the packages that will use the file are known in
4644: advance. For other purposes it is often better to write a
4645: <code class="filename">*.mk</code> file and give it a good name that
4646: describes what it does.</p></dd>
4647: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4648: <dd><p>This file contains the dependency information
1.110 hubertf 4649: for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78 rillig 4650: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4651: <dd><p>This file contains workarounds for compiler bugs
4652: and similar things. It is included automatically by the pkgsrc
4653: infrastructure, so you don't need an extra
4654: <code class="literal">.include</code> line for
4655: it.</p></dd>
4656: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4657: <dd><p>This file contains the code for the
1.110 hubertf 4658: package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78 rillig 4659: selected by the user. If a package has only one or two options,
4660: it is equally acceptable to put the code directly into the
4661: <code class="filename">Makefile</code>.</p></dd>
4662: </dl></div>
4663: </div>
4664: <div class="sect2" lang="en">
4665: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4666: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78 rillig 4667: <div class="variablelist"><dl>
4668: <dt><span class="term"><code class="filename">README*</code></span></dt>
4669: <dd><p>These files do not take place in the creation of
4670: a package and thus are purely informative to the package
4671: developer.</p></dd>
4672: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4673: <dd><p>This file contains things that need to be done
4674: to make the package even
4675: better.</p></dd>
1.75 rillig 4676: </dl></div>
4677: </div>
1.78 rillig 4678: </div>
1.75 rillig 4679: <div class="sect1" lang="en">
4680: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4681: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93 rillig 4682: </h2></div></div></div>
1.110 hubertf 4683: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87 wiz 4684: unpacked into the directory denoted by
4685: <code class="varname">WRKDIR</code>. It can be removed by running
1.110 hubertf 4686: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87 wiz 4687: directory is also used to keep various timestamp files.
4688: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4689: The default is <code class="filename">${.CURDIR}/work</code>
4690: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4691: if <code class="varname">OBJMACHINE</code> is set.</p>
1.75 rillig 4692: </div>
4693: <div class="sect1" lang="en">
4694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4695: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93 rillig 4696: </h2></div></div></div>
1.75 rillig 4697: <p>If you have any files that you wish to be placed in the package prior
1.87 wiz 4698: to configuration or building, you could place these files here and use
1.110 hubertf 4699: a <span class="command"><strong>${CP}</strong></span> command in the
1.87 wiz 4700: “<span class="quote">pre-configure</span>” target to achieve
4701: this. Alternatively, you could simply diff the file against
4702: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4703: the creation of this file.</p>
4704: <p>If you want to share files in this way with other
4705: packages, set the <code class="varname">FILESDIR</code> variable to point
4706: to the other package's <code class="filename">files</code> directory,
4707: e.g.:</p>
4708: <pre class="programlisting">
1.100 rillig 4709: FILESDIR=${.CURDIR}/../xemacs/files
4710: </pre>
1.75 rillig 4711: </div>
4712: </div>
4713: <div class="chapter" lang="en">
4714: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 4715: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75 rillig 4716: <div class="toc">
4717: <p><b>Table of Contents</b></p>
4718: <dl>
1.106 rillig 4719: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
4720: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
4721: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4722: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4723: <dd><dl>
4724: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4725: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4726: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4727: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4728: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75 rillig 4729: </dl></dd>
4730: </dl>
4731: </div>
1.76 rillig 4732: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75 rillig 4733: each of which forms a well-defined part of the pkgsrc system. Using
1.110 hubertf 4734: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75 rillig 4735: like pkgsrc requires some discipline to keep the code correct and
4736: understandable.</p>
1.76 rillig 4737: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75 rillig 4738: programming are variables (which are actually macros) and shell
4739: commands. Among these shell commands may even be more complex ones
1.110 hubertf 4740: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75 rillig 4741: as intended it is necessary to quote all variables correctly when they
4742: are used.</p>
4743: <p>This chapter describes some patterns, that appear quite often in
1.76 rillig 4744: <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75 rillig 4745: with them.</p>
4746: <div class="sect1" lang="en">
4747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4748: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97 rillig 4749: <div class="itemizedlist"><ul type="disc"><li>
4750: <p>When you are creating a file as a
4751: target of a rule, always write the data to a temporary file first
4752: and finally rename that file. Otherwise there might occur an error
4753: in the middle of generating the file, and when the user runs
1.110 hubertf 4754: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97 rillig 4755: regenerated properly. Example:</p>
4756: <pre class="programlisting">
1.100 rillig 4757: wrong:
4758: @echo "line 1" > ${.TARGET}
4759: @echo "line 2" >> ${.TARGET}
4760: @false
4761:
4762: correct:
4763: @echo "line 1" > ${.TARGET}.tmp
4764: @echo "line 2" >> ${.TARGET}.tmp
4765: @false
4766: @mv ${.TARGET}.tmp ${.TARGET}
1.97 rillig 4767: </pre>
1.110 hubertf 4768: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97 rillig 4769: <code class="filename">wrong</code> will exist, although there was an error
1.110 hubertf 4770: message in the first run. On the other hand, running <span class="command"><strong>make
1.97 rillig 4771: correct</strong></span> gives an error message twice, as expected.</p>
1.110 hubertf 4772: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97 rillig 4773: <code class="literal">${.TARGET}</code> in case of error, but this only
4774: happens when it is interrupted, for example by pressing
4775: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110 hubertf 4776: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97 rillig 4777: </li></ul></div>
4778: </div>
4779: <div class="sect1" lang="en">
4780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4781: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76 rillig 4782: <p><code class="filename">Makefile</code> variables contain strings that
1.75 rillig 4783: can be processed using the five operators ``='', ``+='', ``?='',
1.110 hubertf 4784: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75 rillig 4785: page.</p>
4786: <p>When a variable's value is parsed from a
1.76 rillig 4787: <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75 rillig 4788: backslash character ``\'' are handled specially. If a backslash is
4789: followed by a newline, any whitespace immediately in front of the
4790: backslash, the backslash, the newline, and any whitespace
4791: immediately behind the newline are replaced with a single space. A
4792: backslash character and an immediately following hash character are
4793: replaced with a single hash character. Otherwise, the backslash is
4794: passed as is. In a variable assignment, any hash character that is
4795: not preceded by a backslash starts a comment that continues upto the
4796: end of the logical line.</p>
4797: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4798: the only way to create a variable consisting of a single backslash
4799: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4800: <p>So far for defining variables. The other thing you can do with
4801: variables is evaluating them. A variable is evaluated when it is
4802: part of the right side of the ``:='' or the ``!='' operator, or
4803: directly before executing a shell command which the variable is part
1.110 hubertf 4804: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75 rillig 4805: is, variables are not evaluated until there's no other way. The
4806: ``modifiers'' mentioned in the man page also evaluate the
4807: variable.</p>
4808: <p>Some of the modifiers split the string into words and then
4809: operate on the words, others operate on the string as a whole. When
4810: a string is split into words, it is split as you would expect
1.110 hubertf 4811: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.112 ! weinem 4812: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.75 rillig 4813: loop does not follow the shell quoting rules but splits at sequences
4814: of whitespace.</p>
4815: <p>There are several types of variables that should be handled
4816: differently. Strings and two types of lists.</p>
4817: <div class="itemizedlist"><ul type="disc">
4818: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4819: characters. Nevertheless, you should restrict yourself to only
4820: using printable characters. Examples are
4821: <code class="varname">PREFIX</code> and
4822: <code class="varname">COMMENT</code>.</p></li>
4823: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4824: are never exported to any shell command. Their elements are
4825: separated by whitespace. Therefore, the elements themselves cannot
4826: have embedded whitespace. Any other characters are allowed.
1.110 hubertf 4827: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75 rillig 4828: Examples are <code class="varname">DEPENDS</code> and
4829: <code class="varname">BUILD_DEPENDS</code>.</p></li>
4830: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
4831: may be exported to a shell command. Their elements can contain any
4832: characters, including whitespace. That's why they cannot be used
1.110 hubertf 4833: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75 rillig 4834: <code class="varname">DISTFILES</code> and
4835: <code class="varname">MASTER_SITES</code>.</p></li>
4836: </ul></div>
4837: <div class="sect2" lang="en">
4838: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4839: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75 rillig 4840: <div class="itemizedlist"><ul type="disc">
4841: <li><p>All variable names starting with an underscore
4842: are reserved for use by the pkgsrc infrastructure. They shall
4843: not be used by package
1.76 rillig 4844: <code class="filename">Makefile</code>s.</p></li>
1.110 hubertf 4845: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75 rillig 4846: lowercase variable names for the iteration
4847: variables.</p></li>
4848: <li><p>All list variables should have a ``plural''
4849: name, e.g. <code class="varname">PKG_OPTIONS</code> or
4850: <code class="varname">DISTFILES</code>.</p></li>
4851: </ul></div>
4852: </div>
4853: </div>
4854: <div class="sect1" lang="en">
4855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 4856: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75 rillig 4857: <p>This section presents you with some code snippets you should
4858: use in your own code. If you don't find anything appropriate here,
4859: you should test your code and add it here.</p>
4860: <div class="sect2" lang="en">
4861: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4862: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75 rillig 4863: <pre class="programlisting">
1.100 rillig 4864: STRING= foo * bar `date`
4865: INT_LIST= # empty
4866: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4867: EXT_LIST= # empty
4868: ANOTHER_EXT_LIST= a=b c=d
4869:
4870: INT_LIST+= ${STRING} # 1
4871: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4872: EXT_LIST+= ${STRING:Q} # 3
4873: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
1.1 grant 4874: </pre>
1.75 rillig 4875: <p>When you add a string to an external list (example 3), it
4876: must be quoted. In all other cases, you must not add a quoting
4877: level. You must not merge internal and external lists, unless you
4878: are sure that all entries are correctly interpreted in both
4879: lists.</p>
4880: </div>
4881: <div class="sect2" lang="en">
4882: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4883: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75 rillig 4884: <pre class="programlisting">
1.100 rillig 4885: EXT_LIST= # empty
4886: .for i in ${INT_LIST}
4887: EXT_LIST+= ${i:Q}""
4888: .endfor
1.1 grant 4889: </pre>
1.75 rillig 4890: <p>This code converts the internal list
4891: <code class="varname">INT_LIST</code> into the external list
4892: <code class="varname">EXT_LIST</code>. As the elements of an internal list
4893: are unquoted they must be quoted here. The reason for appending
4894: <code class="varname">""</code> is explained below.</p>
4895: </div>
4896: <div class="sect2" lang="en">
4897: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4898: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79 rillig 4899: <p>Sometimes you may want to print an arbitrary string. There
4900: are many ways to get it wrong and only few that can handle every
4901: nastiness.</p>
1.75 rillig 4902: <pre class="programlisting">
1.100 rillig 4903: STRING= foo bar < > * `date` $$HOME ' "
4904: EXT_LIST= string=${STRING:Q} x=second\ item
1.1 grant 4905:
1.100 rillig 4906: all:
4907: echo ${STRING} # 1
4908: echo "${STRING}" # 2
4909: echo "${STRING:Q}" # 3
4910: echo ${STRING:Q} # 4
4911: echo x${STRING:Q} | sed 1s,.,, # 5
4912: printf "%s\\n" ${STRING:Q}"" # 6
4913: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1 grant 4914: </pre>
1.75 rillig 4915: <p>Example 1 leads to a syntax error in the shell, as the
4916: characters are just copied.</p>
4917: <p>Example 2 leads to a syntax error too, and if you leave out
4918: the last " character from <code class="varname">${STRING}</code>,
1.110 hubertf 4919: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75 rillig 4920: variable would be evaluated, too.</p>
4921: <p>Example 3 outputs each space character preceded by a
4922: backslash (or not), depending on the implementation of the
1.110 hubertf 4923: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75 rillig 4924: <p>Example 4 handles correctly every string that does not start
4925: with a dash. In that case, the result depends on the
1.110 hubertf 4926: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75 rillig 4927: guarantee that your input does not start with a dash, this form is
4928: appropriate.</p>
4929: <p>Example 5 handles even the case of a leading dash
4930: correctly.</p>
1.79 rillig 4931: <p>Example 6 also works with every string and is the
4932: light-weight solution, since it does not involve a pipe, which has
4933: its own problems.</p>
1.75 rillig 4934: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
4935: because the quoting has already been done when adding elements to
4936: the list.</p>
4937: <p>As internal lists shall not be passed to the shell, there is
4938: no example for it.</p>
4939: </div>
4940: <div class="sect2" lang="en">
4941: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 4942: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75 rillig 4943: <p>There are many possible sources of wrongly quoted variables.
4944: This section lists some of the commonly known ones.</p>
4945: <div class="itemizedlist"><ul type="disc">
4946: <li>
4947: <p>Whenever you use the value of a list, think
4948: about what happens to leading or trailing whitespace. If the
4949: list is a well-formed shell expression, you can apply the
4950: <code class="varname">:M*</code> modifier to strip leading and trailing
4951: whitespace from each word. The <code class="varname">:M</code> operator
4952: first splits its argument according to the rules of the shell,
4953: and then creates a new list consisting of all words that match
4954: the shell glob expression <code class="varname">*</code>, that is: all.
4955: One class of situations where this is needed is when adding a
4956: variable like <code class="varname">CPPFLAGS</code> to
4957: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
4958: invokes other configure scripts, it strips the leading and
4959: trailing whitespace from the variable and then passes it to the
4960: other configure scripts. But these configure scripts expect the
4961: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
4962: the parent <code class="varname">CPPFLAGS</code>. That's why we better
4963: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
4964: here is how we do it:</p>
4965: <pre class="programlisting">
1.100 rillig 4966: CPPFLAGS= # empty
4967: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4968: CPPFLAGS+= ${MY_CPPFLAGS}
4969:
4970: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4971:
4972: all:
4973: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4974: echo x${CONFIGURE_ARGS}x # properly trimmed
1.1 grant 4975: </pre>
1.75 rillig 4976: </li>
4977: <li><p>The example above contains one bug: The
4978: <code class="varname">${PREFIX}</code> is a properly quoted shell
4979: expression, but there is the C compiler after it, which also
4980: expects a properly quoted string (this time in C syntax). The
4981: version above is therefore only correct if
4982: <code class="varname">${PREFIX}</code> does not have embedded backslashes
4983: or double quotes. If you want to allow these, you have to add
4984: another layer of quoting to each variable that is used as a C
4985: string literal. You cannot use the <code class="varname">:Q</code>
4986: operator for it, as this operator only works for the
4987: shell.</p></li>
4988: <li>
4989: <p>Whenever a variable can be empty, the
4990: <code class="varname">:Q</code> operator can have surprising results. Here
4991: are two completely different cases which can be solved with the
4992: same trick.</p>
4993: <pre class="programlisting">
1.100 rillig 4994: EMPTY= # empty
4995: empty_test:
4996: for i in a ${EMPTY:Q} c; do \
4997: echo "$$i"; \
4998: done
4999:
5000: for_test:
5001: .for i in a:\ a:\test.txt
5002: echo ${i:Q}
5003: echo "foo"
5004: .endfor
1.1 grant 5005: </pre>
1.75 rillig 5006: <p>The first example will only print two of the three lines
5007: we might have expected. This is because
5008: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5009: the shell cannot see. The workaround is to write
5010: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5011: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5012: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5013: <p>The second example will only print three lines instead of
5014: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5015: This is because the backslash of the value
5016: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110 hubertf 5017: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
5018: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75 rillig 5019: <code class="varname">${i:Q}""</code>.</p>
5020: </li>
5021: </ul></div>
5022: </div>
5023: <div class="sect2" lang="en">
5024: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5025: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75 rillig 5026: <p>The pkgsrc bmake program does not handle the following
5027: assignment correctly. In case <code class="varname">_othervar_</code>
5028: contains a ``-'' character, one of the closing braces is included
5029: in <code class="varname">${VAR}</code> after this code executes.</p>
5030: <pre class="programlisting">
1.100 rillig 5031: VAR:= ${VAR:N${_othervar_:C/-//}}
1.1 grant 5032: </pre>
1.75 rillig 5033: <p>For a more complex code snippet and a workaround, see the
1.91 rillig 5034: 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 5035: <code class="varname">bug1</code>.</p>
5036: </div>
5037: </div>
5038: </div>
5039: <div class="chapter" lang="en">
5040: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5041: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75 rillig 5042: <div class="toc">
5043: <p><b>Table of Contents</b></p>
5044: <dl>
1.106 rillig 5045: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
5046: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
1.110 hubertf 5047: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
1.106 rillig 5048: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5049: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
5050: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5051: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5052: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75 rillig 5053: </dl>
5054: </div>
1.87 wiz 5055: <p>The <code class="filename">PLIST</code> file contains a package's
5056: “<span class="quote">packing list</span>”, i.e. a list of files that belong to
5057: the package (relative to the <code class="filename">${PREFIX}</code>
5058: directory it's been installed in) plus some additional statements
1.110 hubertf 5059: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87 wiz 5060: This chapter addresses some issues that need attention when
5061: dealing with the <code class="filename">PLIST</code> file (or files, see
5062: below!).</p>
1.75 rillig 5063: <div class="sect1" lang="en">
5064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5065: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87 wiz 5066: <p>Be sure to add a RCS ID line as the first thing in any
5067: <code class="filename">PLIST</code> file you write:</p>
1.75 rillig 5068: <pre class="programlisting">
1.100 rillig 5069: @comment $NetBSD$
1.87 wiz 5070: </pre>
1.75 rillig 5071: </div>
5072: <div class="sect1" lang="en">
5073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5074: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110 hubertf 5075: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87 wiz 5076: to output a PLIST that matches any new files since the package
1.110 hubertf 5077: was extracted. See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a> for
1.87 wiz 5078: more information on this target.</p>
1.75 rillig 5079: </div>
5080: <div class="sect1" lang="en">
5081: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110 hubertf 5082: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93 rillig 5083: </h2></div></div></div>
1.87 wiz 5084: <p>If you have used any of the *-dirs packages, as explained in
1.110 hubertf 5085: <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, “Sharing directories between packages”</a>, you may have noticed that
5086: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87 wiz 5087: <code class="varname">@comment</code>s instead of real
5088: <code class="varname">@dirrm</code> lines. You can also do this for
5089: specific directories and files, so that the results of that
5090: command are very close to reality. This helps <span class="emphasis"><em>a
5091: lot</em></span> during the update of packages.</p>
5092: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5093: of AWK patterns and actions that are used to filter the output of
5094: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5095: scripting you like to it, but be careful with quoting.</p>
5096: <p>For example, to get all files inside the
5097: <code class="filename">libdata/foo</code> directory removed from the
5098: resulting PLIST:</p>
5099: <pre class="programlisting">
1.100 rillig 5100: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.87 wiz 5101: </pre>
5102: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5103: to a specific (shared) directory converted to
5104: <code class="varname">@comment</code>s:</p>
1.75 rillig 5105: <pre class="programlisting">
1.100 rillig 5106: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87 wiz 5107: </pre>
1.75 rillig 5108: </div>
5109: <div class="sect1" lang="en">
5110: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5111: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87 wiz 5112: <p>A number of variables are substituted automatically in
5113: PLISTs when a package is installed on a system. This includes the
5114: following variables:</p>
1.75 rillig 5115: <div class="variablelist"><dl>
5116: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5117: <dd>
5118: <p>Some packages like emacs and perl embed information
1.87 wiz 5119: about which architecture they were built on into the
5120: pathnames where they install their files. To handle this
5121: case, PLIST will be preprocessed before actually used, and
5122: the symbol
5123: “<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>” will be
1.110 hubertf 5124: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87 wiz 5125: same is done if the string
5126: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5127: PLIST somewhere - use this on packages that have GNU
5128: autoconf-created configure scripts.</p>
1.75 rillig 5129: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
5130: <h3 class="title">Legacy note</h3>
5131: <p>There used to be a symbol
1.87 wiz 5132: “<span class="quote"><code class="varname">$ARCH</code></span>” that
1.110 hubertf 5133: was replaced by the output of <span class="command"><strong>uname
1.87 wiz 5134: -m</strong></span>, but that's no longer supported and has
5135: been removed.</p>
1.75 rillig 5136: </div>
5137: </dd>
5138: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5139: <dd>
5140: <p>Some packages want to embed the OS name and version
1.87 wiz 5141: into some paths. To do this, use these variables in the
5142: <code class="filename">PLIST</code>:
5143: </p>
1.75 rillig 5144: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 5145: <li><p><code class="varname">${OPSYS}</code> - output of “<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</p></li>
1.75 rillig 5146: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. “<span class="quote">solaris</span>”)</p></li>
1.110 hubertf 5147: <li><p><code class="varname">${OS_VERSION}</code> - “<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</p></li>
1.75 rillig 5148: </ul></div>
5149: </dd>
5150: </dl></div>
1.87 wiz 5151: <p>For a complete list of values which are replaced by
5152: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5153: search for <code class="varname">PLIST_SUBST</code>).</p>
5154: <p>If you want to change other variables not listed above, you
5155: can add variables and their expansions to this variable in the
1.110 hubertf 5156: following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, “Optional files”</a>):</p>
1.75 rillig 5157: <pre class="programlisting">
1.100 rillig 5158: PLIST_SUBST+= SOMEVAR="somevalue"
1.87 wiz 5159: </pre>
1.75 rillig 5160: <p>This replaces all occurrences of “<span class="quote">${SOMEVAR}</span>”
1.87 wiz 5161: in the <code class="filename">PLIST</code> with
5162: “<span class="quote">somevalue</span>”.</p>
1.75 rillig 5163: </div>
5164: <div class="sect1" lang="en">
5165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5166: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75 rillig 5167: <p>Man pages should be installed in compressed form if
1.87 wiz 5168: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5169: and uncompressed otherwise. To handle this in the
5170: <code class="filename">PLIST</code> file, the suffix “<span class="quote">.gz</span>” is
5171: appended/removed automatically for man pages according to
5172: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5173: or not, see above for details. This modification of the
5174: <code class="filename">PLIST</code> file is done on a copy of it, not
5175: <code class="filename">PLIST</code> itself.</p>
1.75 rillig 5176: </div>
5177: <div class="sect1" lang="en">
5178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5179: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93 rillig 5180: </h2></div></div></div>
1.76 rillig 5181: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87 wiz 5182: in generating the binary package, set the variable
5183: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110 hubertf 5184: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87 wiz 5185: important. The default for <code class="varname">PLIST_SRC</code> is
5186: <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75 rillig 5187: </div>
5188: <div class="sect1" lang="en">
5189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5190: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75 rillig 5191: <p>Some packages decide to install a different set of files based on
1.87 wiz 5192: the operating system being used. These differences can be
5193: automatically handled by using the following files:</p>
1.75 rillig 5194: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5195: <li><p><code class="filename">PLIST.common</code></p></li>
5196: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5197: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5198: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5199: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75 rillig 5200: </ul></div>
5201: </div>
5202: <div class="sect1" lang="en">
5203: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5204: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87 wiz 5205: <p>A “<span class="quote">shared directory</span>” is a directory where
5206: multiple (and unrelated) packages install files. These
5207: directories are problematic because you have to add special tricks
5208: in the PLIST to conditionally remove them, or have some
5209: centralized package handle them.</p>
5210: <p>Within pkgsrc, you'll find both approaches. If a directory
5211: is shared by a few unrelated packages, it's often not worth to add
5212: an extra package to remove it. Therefore, one simply does:</p>
5213: <pre class="programlisting">
1.100 rillig 5214: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
1.87 wiz 5215: </pre>
5216: <p>in the PLISTs of all affected packages, instead of the
5217: regular "@dirrm" line.</p>
5218: <p>However, if the directory is shared across many packages, two
5219: different solutions are available:</p>
1.75 rillig 5220: <div class="orderedlist"><ol type="1">
1.87 wiz 5221: <li><p>If the packages have a common dependency, the directory
5222: can be removed in that. For example, see
1.91 rillig 5223: <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 5224: removes the shared directory
5225: <code class="filename">share/omf</code>.</p></li>
5226: <li><p>If the packages using the directory are not related at
5227: all (they have no common dependencies), a *-dirs package is
5228: used.</p></li>
1.75 rillig 5229: </ol></div>
1.87 wiz 5230: <p>From now on, we'll discuss the second solution. To get an
5231: idea of the *-dirs packages available, issue:</p>
1.75 rillig 5232: <pre class="programlisting">
1.100 rillig 5233: <code class="prompt">%</code> cd .../pkgsrc
5234: <code class="prompt">%</code> ls -d */*-dirs
1.87 wiz 5235: </pre>
5236: <p>Their use from other packages is very simple. The
5237: <code class="varname">USE_DIRS</code> variable takes a list of package names
5238: (without the “<span class="quote">-dirs</span>” part) together with the required
5239: version number (always pick the latest one when writing new
5240: packages).</p>
5241: <p>For example, if a package installs files under
5242: <code class="filename">share/applications</code>, it should have the
5243: following line in it:</p>
5244: <pre class="programlisting">
1.100 rillig 5245: USE_DIRS+= xdg-1.1
1.87 wiz 5246: </pre>
1.110 hubertf 5247: <p>After regenerating the PLIST using <span class="command"><strong>make
1.87 wiz 5248: print-PLIST</strong></span>, you should get the right (commented out)
5249: lines.</p>
5250: <p>Note that even if your package is using
5251: <code class="filename">$X11BASE</code>, it must not depend on the
5252: *-x11-dirs packages. Just specify the name without that part and
5253: pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
5254: care of it.</p>
1.75 rillig 5255: </div>
5256: </div>
5257: <div class="chapter" lang="en">
5258: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5259: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75 rillig 5260: <div class="toc">
5261: <p><b>Table of Contents</b></p>
5262: <dl>
1.106 rillig 5263: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
5264: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5265: <dd><dl>
1.106 rillig 5266: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5267: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75 rillig 5268: </dl></dd>
1.106 rillig 5269: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75 rillig 5270: <dd><dl>
1.106 rillig 5271: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
5272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75 rillig 5273: </dl></dd>
5274: </dl>
5275: </div>
5276: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87 wiz 5277: are seen by a package's configure and build processes. This is implemented
5278: in a two step process:</p>
1.75 rillig 5279: <div class="orderedlist"><ol type="1">
5280: <li><p>Symlink headers and libraries for dependencies into
1.87 wiz 5281: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5282: of <code class="varname">WRKDIR</code>.</p></li>
1.75 rillig 5283: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87 wiz 5284: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5285: <code class="option">-L${LOCALBASE}/lib</code> into references to
5286: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5287: native compiler on some operating systems look like GCC, so that
5288: packages that expect GCC won't require modifications to build with
5289: those native compilers.</p></li>
1.75 rillig 5290: </ol></div>
5291: <p>This normalizes the environment in which a package is built so that the
1.87 wiz 5292: package may be built consistently despite what other software may be
5293: installed. Please note that the normal system header and library paths,
5294: e.g. <code class="filename">/usr/include</code>,
5295: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5296: designed to insulate the package build from non-system-supplied
5297: software.</p>
1.75 rillig 5298: <div class="sect1" lang="en">
5299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5300: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75 rillig 5301: <p>The process of converting packages to use the buildlink3
1.87 wiz 5302: framework (“<span class="quote">bl3ifying</span>”) is fairly straightforward.
5303: The things to keep in mind are:</p>
1.75 rillig 5304: <div class="orderedlist"><ol type="1">
1.87 wiz 5305: <li><p>Ensure that the build always calls the wrapper scripts
5306: instead of the actual toolchain. Some packages are tricky,
5307: and the only way to know for sure is the check
5308: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5309: wrappers are being invoked.</p></li>
5310: <li><p>Don't override <code class="varname">PREFIX</code> from within
5311: the package Makefile, e.g. Java VMs, standalone shells,
5312: etc., because the code to symlink files into
5313: <code class="filename">${BUILDLINK_DIR}</code> looks for files
5314: relative to “<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”.
5315: </p></li>
5316: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
5317: <code class="filename">buildlink3.mk</code> files that you list in a
5318: package's Makefile are added as dependencies for that package.
5319: </p></li>
1.75 rillig 5320: </ol></div>
1.87 wiz 5321: <p>If a dependency on a particular package is required for its libraries and
5322: headers, then we replace:</p>
1.75 rillig 5323: <pre class="programlisting">
1.100 rillig 5324: DEPENDS+= foo>=1.1.0:../../category/foo
5325: </pre>
1.75 rillig 5326: <p>with</p>
5327: <pre class="programlisting">
1.100 rillig 5328: .include "../../category/foo/buildlink3.mk"
5329: </pre>
1.75 rillig 5330: <p>The buildlink3.mk files usually define the required dependencies.
5331: If you need a newer version of the dependency when using buildlink3.mk
1.87 wiz 5332: files, then you can define it in your Makefile; for example:</p>
1.75 rillig 5333: <pre class="programlisting">
1.100 rillig 5334: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5335: .include "../../category/foo/buildlink3.mk"
5336: </pre>
1.76 rillig 5337: <p>There are several <code class="filename">buildlink3.mk</code>
1.87 wiz 5338: files in <code class="filename">pkgsrc/mk</code>
5339: that handle special package issues:</p>
1.75 rillig 5340: <div class="itemizedlist"><ul type="disc">
1.76 rillig 5341: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87 wiz 5342: the native or a pkgsrc Berkeley DB implementation based on
5343: the values of <code class="varname">BDB_ACCEPTED</code> and
5344: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76 rillig 5345: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87 wiz 5346: comes with neither Curses nor NCurses, this will take care
1.91 rillig 5347: 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 5348: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87 wiz 5349: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5350: adding a dependency on Heimdal or MIT-krb5 for packages that
5351: require a Kerberos 5 implementation.</p></li>
1.88 wiz 5352: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
5353: system-provided Motif installation or adds a dependency on
1.91 rillig 5354: <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 5355: <code class="varname">MOTIF_TYPE</code> to “<span class="quote">dt</span>”,
5356: “<span class="quote">lesstif</span>”, or “<span class="quote">openmotif</span>” to choose
5357: which Motif version will be used.</p></li>
1.76 rillig 5358: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87 wiz 5359: variables that may be used by packages that use the
5360: Open Sound System (OSS) API.</p></li>
1.76 rillig 5361: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93 rillig 5362: either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87 wiz 5363: the file for more information.</p></li>
1.76 rillig 5364: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87 wiz 5365: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91 rillig 5366: 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 5367: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87 wiz 5368: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5369: library.</p></li>
1.75 rillig 5370: </ul></div>
1.76 rillig 5371: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87 wiz 5372: files provide a more complete
5373: description of how to use them properly.</p>
1.75 rillig 5374: </div>
5375: <div class="sect1" lang="en">
5376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5377: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107 rillig 5378: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87 wiz 5379: included by Makefiles to indicate the need to compile and link
5380: against header files and libraries provided by the package. A
5381: <code class="filename">buildlink3.mk</code> file should always provide
5382: enough information to add the correct type of dependency
5383: relationship and include any other
5384: <code class="filename">buildlink3.mk</code> files that it needs to find
5385: headers and libraries that it needs in turn.</p>
5386: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91 rillig 5387: 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 5388: package is highly recommended. For most packages, the following
5389: command will generate a good starting point for
5390: <code class="filename">buildlink3.mk</code> files:</p>
5391: <pre class="screen">
5392: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5393: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5394: </pre>
1.75 rillig 5395: <div class="sect2" lang="en">
5396: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5397: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75 rillig 5398: <p>The following real-life example
1.87 wiz 5399: <code class="filename">buildlink3.mk</code> is taken
5400: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75 rillig 5401: <pre class="programlisting">
1.100 rillig 5402: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 grant 5403:
1.100 rillig 5404: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
5405: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
1.1 grant 5406:
1.100 rillig 5407: .if ${BUILDLINK_DEPTH} == "+"
5408: BUILDLINK_DEPENDS+= tiff
5409: .endif
1.87 wiz 5410:
1.100 rillig 5411: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
5412: BUILDLINK_PACKAGES+= tiff
1.87 wiz 5413:
1.100 rillig 5414: .if ${TIFF_BUILDLINK3_MK} == "+"
5415: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5416: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
5417: .endif # TIFF_BUILDLINK3_MK
1.87 wiz 5418:
1.100 rillig 5419: .include "../../devel/zlib/buildlink3.mk"
5420: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 5421:
1.100 rillig 5422: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
5423: </pre>
1.87 wiz 5424: <p>The header and footer manipulate
5425: <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
5426: <code class="filename">buildlink3.mk</code> files and is used to track
5427: at what depth we are including
5428: <code class="filename">buildlink3.mk</code> files.</p>
5429: <p>The first section controls if the dependency on
5430: <em class="replaceable"><code>pkg</code></em> is added.
5431: <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
5432: packages for which dependencies are added by
5433: buildlink3.</p>
5434: <p>The second section advises pkgsrc that the
5435: <code class="filename">buildlink3.mk</code> file for
5436: <em class="replaceable"><code>pkg</code></em> has been included at some point.
5437: <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
5438: packages for which <code class="filename">buildlink3.mk</code> files
5439: have been included. It must <span class="emphasis"><em>always</em></span> be
5440: appended to within a <code class="filename">buildlink3.mk</code>
5441: file.</p>
5442: <p>The third section is protected from multiple inclusion
5443: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5444: added. Several important variables are set in the section:</p>
5445: <div class="itemizedlist"><ul type="disc">
5446: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5447: is the actual dependency recorded in the installed
5448: package; this should always be set using
1.110 hubertf 5449: <span class="command"><strong>+=</strong></span> to ensure that
1.87 wiz 5450: we're appending to any pre-existing list of values. This
5451: variable should be set to the first version of the
5452: package that had an API change.
5453: </p></li>
5454: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5455: is the location of the <em class="replaceable"><code>pkg</code></em>
5456: pkgsrc directory.</p></li>
5457: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5458: (not shown above) controls whether we use
5459: <code class="varname">BUILD_DEPENDS</code> or
5460: <code class="varname">DEPENDS</code> to add the dependency on
5461: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5462: selected by setting
5463: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5464: to “<span class="quote">build</span>”. By default, the full dependency is
5465: used.</p></li>
5466: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5467: and
5468: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5469: (not shown above) are lists of subdirectories of
1.76 rillig 5470: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5471: to add to the header and library search paths. These
5472: default to “<span class="quote">include</span>” and “<span class="quote">lib</span>”
1.87 wiz 5473: respectively.</p></li>
5474: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5475: (not shown above) is the list of preprocessor flags to add
5476: to <code class="varname">CPPFLAGS</code>, which are passed on to the
5477: configure and build phases. The “<span class="quote">-I</span>” option
5478: should be avoided and instead be handled using
5479: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87 wiz 5480: above.</p></li>
1.75 rillig 5481: </ul></div>
1.87 wiz 5482: <p>The following variables are all optionally defined within
5483: this second section (protected against multiple inclusion) and
5484: control which package files are symlinked into
5485: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5486: transformed during the symlinking:</p>
1.75 rillig 5487: <div class="itemizedlist"><ul type="disc">
1.87 wiz 5488: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5489: (not shown above) is a shell glob pattern relative to
1.76 rillig 5490: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5491: to be symlinked into
1.76 rillig 5492: <code class="filename">${BUILDLINK_DIR}</code>,
1.87 wiz 5493: e.g. <code class="filename">include/*.h</code>.</p></li>
5494: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5495: (not shown above) is a shell pipeline that
5496: outputs to stdout a list of files relative to
5497: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5498: The resulting files are to be symlinked
5499: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5500: this takes the <code class="filename">+CONTENTS</code> of a
5501: <em class="replaceable"><code>pkg</code></em> and filters it through
5502: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5503: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5504: (not shown above) is a filter command that filters
1.76 rillig 5505: <code class="filename">+CONTENTS</code> input into a list of files
1.75 rillig 5506: relative to
1.76 rillig 5507: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75 rillig 5508: on stdout. By default for overwrite packages,
5509: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76 rillig 5510: outputs the contents of the <code class="filename">include</code>
5511: and <code class="filename">lib</code> directories in the package
5512: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75 rillig 5513: it outputs any libtool archives in
1.87 wiz 5514: <code class="filename">lib</code> directories.</p></li>
1.95 tron 5515: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5516: (not shown above) is a list of sed arguments used to
5517: transform the name of the source filename into a
1.110 hubertf 5518: destination filename, e.g. <span class="command"><strong>-e
1.87 wiz 5519: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75 rillig 5520: </ul></div>
1.87 wiz 5521: <p>The last section includes any
5522: <code class="filename">buildlink3.mk</code> needed for
5523: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5524: Including these <code class="filename">buildlink3.mk</code> files
5525: means that the headers and libraries for these
5526: dependencies are also symlinked into
5527: <code class="filename">${BUILDLINK_DIR}</code>
5528: whenever the <em class="replaceable"><code>pkg</code></em>
5529: <code class="filename">buildlink3.mk</code>
5530: file is included.</p>
1.75 rillig 5531: </div>
5532: <div class="sect2" lang="en">
5533: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5534: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87 wiz 5535: <p>The situation that requires increasing the dependency listed in
1.75 rillig 5536: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5537: after a package update is when the API or interface to the
1.87 wiz 5538: header files change.</p>
5539: <p>In this case,
5540: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5541: should be adjusted to require at least the new package
5542: version. In some cases, the packages that depend on this new
5543: version may need their <code class="varname">PKGREVISION</code>s
5544: increased and, if they have <code class="filename">buildlink3.mk</code>
5545: files, their
5546: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5547: adjusted, too. This is needed so pkgsrc will require the
5548: correct package dependency and not settle for an older one
5549: when building the source.</p>
5550: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75 rillig 5551: should be increased when the binary interface or sonames
5552: (major number of the library version) of any installed
5553: shared libraries change. This is needed so that binary
5554: packages made using it will require the correct package
5555: dependency and not settle for an older one which will not
1.87 wiz 5556: contain the necessary shared libraries.</p>
1.110 hubertf 5557: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.75 rillig 5558: more information about dependencies on other packages,
5559: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87 wiz 5560: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5561: <p>Please take careful consideration before adjusting
5562: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5563: or
5564: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5565: as we don't want to cause unneeded package deletions and
5566: rebuilds. In many cases, new versions of packages work just
5567: fine with older dependencies.</p>
5568: <p>Also it is not needed to set
1.75 rillig 5569: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5570: when it is identical to
1.87 wiz 5571: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
1.75 rillig 5572: </div>
5573: </div>
5574: <div class="sect1" lang="en">
5575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5576: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87 wiz 5577: <p>Some packages in pkgsrc install headers and libraries that
1.75 rillig 5578: coincide with headers and libraries present in the base system.
1.76 rillig 5579: Aside from a <code class="filename">buildlink3.mk</code> file, these
5580: packages should also include a <code class="filename">builtin.mk</code>
1.75 rillig 5581: file that includes the necessary checks to decide whether using
5582: the built-in software or the pkgsrc software is
1.87 wiz 5583: appropriate.</p>
5584: <p>The only requirements of a builtin.mk file for
5585: <em class="replaceable"><code>pkg</code></em> are:</p>
1.75 rillig 5586: <div class="orderedlist"><ol type="1">
1.87 wiz 5587: <li><p>It should set
5588: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5589: to either “<span class="quote">yes</span>” or “<span class="quote">no</span>”
5590: after it is included.</p></li>
5591: <li><p>It should <span class="emphasis"><em>not</em></span> override any
5592: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5593: which is already set before the
5594: <code class="filename">builtin.mk</code> file is included.</p></li>
5595: <li><p>It should be written to allow multiple inclusion. This
5596: is <span class="emphasis"><em>very</em></span> important and takes careful
5597: attention to <code class="filename">Makefile</code> coding.</p></li>
1.75 rillig 5598: </ol></div>
5599: <div class="sect2" lang="en">
5600: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5601: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75 rillig 5602: <p>The following is the recommended template for builtin.mk
1.87 wiz 5603: files:</p>
1.75 rillig 5604: <pre class="programlisting">
1.100 rillig 5605: .if !defined(IS_BUILTIN.foo)
5606: #
5607: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5608: # genuinely exists in the system or not.
5609: #
5610: IS_BUILTIN.foo?= no
5611:
5612: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5613: # version can be determined.
5614: #
5615: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5616: BUILTIN_PKG.foo?= foo-1.0
5617: . endif
5618: .endif # IS_BUILTIN.foo
5619:
5620: .if !defined(USE_BUILTIN.foo)
5621: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5622: . if defined(BUILTIN_PKG.foo)
5623: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5624: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5625: USE_BUILTIN.foo!= \
5626: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5627: && ${ECHO} "yes" || ${ECHO} "no"
5628: . endif
5629: . endfor
5630: . endif
5631: .endif # USE_BUILTIN.foo
5632:
5633: CHECK_BUILTIN.foo?= no
5634: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5635: #
5636: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5637: # "yes" or "no".
5638: #
5639: .endif # CHECK_BUILTIN.foo
5640: </pre>
1.87 wiz 5641: <p>The first section sets
5642: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5643: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5644: in the base system. This should not be a base system software
5645: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5646: it should only be “<span class="quote">yes</span>” if the actual package is
5647: included as part of the base system. This variable is only
5648: used internally within the <code class="filename">builtin.mk</code>
5649: file.</p>
5650: <p>The second section sets
5651: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5652: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5653: system if it exists (if
5654: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5655: is “<span class="quote">yes</span>”). This variable is only used internally
5656: within the <code class="filename">builtin.mk</code> file.</p>
5657: <p>The third section sets
5658: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5659: and is <span class="emphasis"><em>required</em></span> in all
5660: <code class="filename">builtin.mk</code> files. The code in this
5661: section must make the determination whether the built-in
5662: software is adequate to satisfy the dependencies listed in
5663: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5664: This is typically done by comparing
5665: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5666: against each of the dependencies in
5667: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5668: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5669: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5670: end of the <code class="filename">builtin.mk</code> file. Note that
5671: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5672: may be “<span class="quote">yes</span>” even if
5673: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5674: is “<span class="quote">no</span>” because we may make the determination
5675: that the built-in version of the software is similar enough to
5676: be used as a replacement.</p>
5677: <p>The last section is guarded by
5678: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5679: and includes code that uses the value of
5680: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5681: set in the previous section. This typically includes, e.g.,
5682: adding additional dependency restrictions and listing additional
5683: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5684: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75 rillig 5685: </div>
5686: <div class="sect2" lang="en">
5687: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5688: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87 wiz 5689: <p>When building packages, it's possible to choose whether to set
5690: a global preference for using either the built-in (native)
5691: version or the pkgsrc version of software to satisfy a
5692: dependency. This is controlled by setting
5693: <code class="varname">PREFER_PKGSRC</code> and
5694: <code class="varname">PREFER_NATIVE</code>. These variables take values
5695: of either “<span class="quote">yes</span>”, “<span class="quote">no</span>”, or a list of
5696: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5697: use the pkgsrc versions of software, while
5698: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5699: built-in versions. Preferences are determined by the most
5700: specific instance of the package in either
5701: <code class="varname">PREFER_PKGSRC</code> or
5702: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5703: in neither or in both variables, then
5704: <code class="varname">PREFER_PKGSRC</code> has precedence over
5705: <code class="varname">PREFER_NATIVE</code>. For example, to require
5706: using pkgsrc versions of software for all but the most basic
5707: bits on a NetBSD system, you can set:</p>
5708: <pre class="programlisting">
1.100 rillig 5709: PREFER_PKGSRC= yes
5710: PREFER_NATIVE= getopt skey tcp_wrappers
5711: </pre>
1.87 wiz 5712: <p>A package <span class="emphasis"><em>must</em></span> have a
5713: <code class="filename">builtin.mk</code>
5714: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5715: otherwise it is simply ignored in that list.</p>
1.75 rillig 5716: </div>
5717: </div>
5718: </div>
5719: <div class="chapter" lang="en">
5720: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 5721: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75 rillig 5722: <div class="toc">
5723: <p><b>Table of Contents</b></p>
5724: <dl>
1.106 rillig 5725: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75 rillig 5726: <dd><dl>
1.106 rillig 5727: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5728: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75 rillig 5729: </dl></dd>
1.106 rillig 5730: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75 rillig 5731: <dd><dl>
1.106 rillig 5732: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5733: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5734: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5735: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5736: </dl></dd>
5737: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5738: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
5739: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5740: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5741: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5742: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5743: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75 rillig 5744: </dl>
5745: </div>
5746: <p>This chapter describes the framework known as
5747: <code class="literal">pkginstall</code>, whose key features are:</p>
5748: <div class="itemizedlist"><ul type="disc">
5749: <li><p>Generic installation and manipulation of directories and files
5750: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5751: <li><p>Automatic handling of configuration files during installation,
5752: provided that packages are correctly designed.</p></li>
5753: <li><p>Generation and installation of system startup scripts.</p></li>
5754: <li><p>Registration of system users and groups.</p></li>
5755: <li><p>Registration of system shells.</p></li>
5756: <li><p>Automatic updating of fonts databases.</p></li>
5757: </ul></div>
5758: <p>The following sections inspect each of the above points in detail.</p>
5759: <p>You may be thinking that many of the things described here could be
5760: easily done with simple code in the package's post-installation target
5761: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5762: as the code in them is only executed when building from source. Machines
5763: using binary packages could not benefit from it at all (as the code itself
5764: could be unavailable). Therefore, the only way to achieve any of the items
5765: described above is by means of the installation scripts, which are
5766: automatically generated by pkginstall.</p>
5767: <div class="sect1" lang="en">
5768: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5769: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76 rillig 5770: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75 rillig 5771: of files and directories that belong to a package. The names used in it
1.76 rillig 5772: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75 rillig 5773: which means that it cannot register files outside this directory (absolute
5774: path names are not allowed). Despite this restriction, some packages need
5775: to install files outside this location; e.g., under
1.76 rillig 5776: <code class="filename">${VARBASE}</code> or
1.87 wiz 5777: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5778: is to create such files during installation time by using
5779: installation scripts.</p>
5780: <p>The generic installation scripts are shell scripts that can
5781: contain arbitrary code. The list of scripts to execute is taken from
5782: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5783: <code class="filename">INSTALL</code>. A similar variable exists for package
5784: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5785: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
5786: commands, so they have the potential to create and manage files
5787: anywhere in the file system.</p>
5788: <p>Using these general installation files is not recommended, but
5789: may be needed in some special cases. One reason for avoiding them is
5790: that the user has to trust the packager that there is no unwanted or
5791: simply erroneous code included in the installation script. Also,
5792: previously there were many similar scripts for the same functionality,
5793: and fixing a common error involved finding and changing all of
5794: them.</p>
5795: <p>The pkginstall framework offers another, standardized way. It
5796: provides generic scripts to abstract the manipulation of such files
5797: and directories based on variables set in the package's
5798: <code class="filename">Makefile</code>. The rest of this section describes
5799: these variables.</p>
1.75 rillig 5800: <div class="sect2" lang="en">
5801: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5802: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75 rillig 5803: <p>The following variables can be set to request the creation of
5804: directories anywhere in the file system:</p>
5805: <div class="itemizedlist"><ul type="disc">
5806: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5807: contain a list of directories that should be created and should attempt
5808: to be destroyed by the installation scripts. The difference between
5809: the two is that the latter prompts the administrator to remove any
5810: directories that may be left after deinstallation (because they were
5811: not empty), while the former does not.</p></li>
5812: <li>
5813: <p><code class="varname">MAKE_DIRS_PERMS</code> and
5814: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5815: which directories should be created and should attempt to be destroyed
5816: by the installation scripts. Each tuple holds the following values,
5817: separated by spaces: the directory name, its owner, its group and its
5818: numerical mode. For example:</p>
5819: <pre class="programlisting">
1.100 rillig 5820: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5821: </pre>
1.75 rillig 5822: <p>The difference between the two is exactly the same as their
5823: non-<code class="varname">PERMS</code> counterparts.</p>
5824: </li>
5825: </ul></div>
5826: </div>
5827: <div class="sect2" lang="en">
5828: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5829: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75 rillig 5830: <p>Creating non-empty files outside the installation prefix is tricky
1.76 rillig 5831: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75 rillig 5832: To overcome this problem, the only solution is to extract the file in the
5833: known place (i.e., inside the installation prefix) and copy it to the
5834: appropriate location during installation (done by the installation scripts
5835: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
5836: file</em></span> in the following paragraphs, which describe the variables
5837: that can be used to automatically and consistently handle files outside the
5838: installation prefix:</p>
5839: <div class="itemizedlist"><ul type="disc">
5840: <li>
5841: <p><code class="varname">CONF_FILES</code> and
5842: <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5843: During installation time, the master file is copied to the target one
5844: if and only if the latter does not exist. Upon deinstallation, the
5845: target file is removed provided that it was not modified by the
5846: installation.</p>
5847: <p>The difference between the two is that the latter prompts the
5848: administrator to remove any files that may be left after
5849: deinstallation (because they were not empty), while the former does
5850: not.</p>
5851: </li>
5852: <li>
5853: <p><code class="varname">CONF_FILES_PERMS</code> and
5854: <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5855: files as well as their target locations. For each of them, it also
5856: specifies their owner, their group and their numeric permissions, in
5857: this order. For example:</p>
5858: <pre class="programlisting">
1.100 rillig 5859: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 grant 5860: </pre>
1.75 rillig 5861: <p>The difference between the two is exactly the same as their
5862: non-<code class="varname">PERMS</code> counterparts.</p>
5863: </li>
5864: </ul></div>
5865: </div>
5866: </div>
5867: <div class="sect1" lang="en">
5868: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5869: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75 rillig 5870: <p>Configuration files are special in the sense that they are installed
5871: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5872: need special treatment during installation (most of which is automated by
5873: pkginstall). The main concept you must bear in mind is that files marked
5874: as configuration files are automatically copied to the right place (somewhere
5875: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5876: and only if</em></span> they didn't exist before. Similarly, they will not
5877: be removed if they have local modifications. This ensures that
5878: administrators never lose any custom changes they may have made.</p>
5879: <div class="sect2" lang="en">
5880: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5881: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75 rillig 5882: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5883: specifies where configuration files shall be installed. Its contents are
5884: set based upon the following variables:</p>
5885: <div class="itemizedlist"><ul type="disc">
5886: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76 rillig 5887: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75 rillig 5888: be overridden by the user to point to his preferred location (e.g.,
1.76 rillig 5889: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75 rillig 5890: Packages must not use it directly.</p></li>
5891: <li>
5892: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5893: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5894: for the package being built shall be installed. The definition of this
5895: variable only makes sense in the package's
1.76 rillig 5896: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75 rillig 5897: <p>As an example, consider the Apache package,
1.91 rillig 5898: <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 5899: configuration files under the
1.76 rillig 5900: <code class="filename">httpd/</code> subdirectory of
1.75 rillig 5901: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
5902: Makefile.</p>
5903: </li>
5904: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5905: variable that holds this package's configuration directory (if
5906: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
5907: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5908: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5909: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5910: directory where the configuration files for the package identified by
5911: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5912: </ul></div>
5913: <p>Based on the above variables, pkginstall determines the value of
5914: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5915: variable that can be used within a package to refer to its configuration
5916: directory. The algorithm used to set its value is basically the
5917: following:</p>
5918: <div class="orderedlist"><ol type="1">
5919: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5920: its value is used.</p></li>
5921: <li><p>If the previous variable is not defined but
5922: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76 rillig 5923: <code class="filename">Makefile</code>, the resulting value is
5924: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75 rillig 5925: <li><p>Otherwise, it is set to
1.76 rillig 5926: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75 rillig 5927: </ol></div>
1.76 rillig 5928: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.110 hubertf 5929: automatically added to <code class="filename">OWN_DIRS</code>. See <a class="xref" href="#dirs-outside-prefix" title="15.1.1. Directory manipulation">Section 15.1.1, “Directory manipulation”</a> what this means.</p>
1.75 rillig 5930: </div>
5931: <div class="sect2" lang="en">
5932: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5933: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75 rillig 5934: <p>Given that pkgsrc (and users!) expect configuration files to be in a
5935: known place, you need to teach each package where it shall install its
5936: files. In some cases you will have to patch the package Makefiles to
5937: achieve it. If you are lucky, though, it may be as easy as passing an
5938: extra flag to the configuration script; this is the case of GNU Autoconf-
5939: generated files:</p>
5940: <pre class="programlisting">
1.100 rillig 5941: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 grant 5942: </pre>
1.75 rillig 5943: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5944: for</em></span> its configuration files, not where they will be originally
5945: installed (although the difference is never explicit,
5946: unfortunately).</p>
5947: </div>
5948: <div class="sect2" lang="en">
5949: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5950: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75 rillig 5951: <p>As said before, pkginstall automatically handles configuration files.
5952: This means that <span class="strong"><strong>the packages themselves must not
1.76 rillig 5953: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75 rillig 5954: directly</strong></span>. Bad news is that many software installation scripts
5955: will, out of the box, mess with the contents of that directory. So what is
5956: the correct procedure to fix this issue?</p>
5957: <p>You must teach the package (usually by manually patching it) to
5958: install any configuration files under the examples hierarchy,
1.76 rillig 5959: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
5960: <code class="filename">PLIST</code> registers them and the administrator always
1.75 rillig 5961: has the original copies available.</p>
5962: <p>Once the required configuration files are in place (i.e., under the
5963: examples hierarchy), the pkginstall framework can use them as master copies
5964: during the package installation to update what is in
1.76 rillig 5965: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
1.75 rillig 5966: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110 hubertf 5967: used. Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, “File manipulation”</a> for information
1.75 rillig 5968: about their syntax and their purpose. Here is an example, taken from the
1.91 rillig 5969: <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 5970: <pre class="programlisting">
1.100 rillig 5971: EGDIR= ${PREFIX}/share/doc/mutt/samples
5972: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1 grant 5973: </pre>
1.75 rillig 5974: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
5975: package and has no meaning outside it.</p>
5976: </div>
5977: <div class="sect2" lang="en">
5978: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 5979: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75 rillig 5980: <p>The automatic copying of config files can be toggled by setting the
5981: environment variable <code class="varname">PKG_CONFIG</code> prior to package
5982: installation.</p>
5983: </div>
5984: </div>
5985: <div class="sect1" lang="en">
5986: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 5987: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75 rillig 5988: <p>System startup scripts are special files because they must be
5989: installed in a place known by the underlying OS, usually outside the
1.110 hubertf 5990: installation prefix. Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, “Files and directories outside the installation prefix”</a> apply, and the same solutions
1.75 rillig 5991: can be used. However, pkginstall provides a special mechanism to handle
5992: these files.</p>
5993: <p>In order to provide system startup scripts, the package has
5994: to:</p>
5995: <div class="orderedlist"><ol type="1">
1.76 rillig 5996: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75 rillig 5997: the <code class="literal">.sh</code> suffix appended. Considering the
1.91 rillig 5998: <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 5999: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75 rillig 6000: <li>
6001: <p>Tell pkginstall to handle it, appending the name of the script,
6002: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6003: Continuing the previous example:</p>
6004: <pre class="programlisting">
1.100 rillig 6005: RCD_SCRIPTS+= cupsd
1.1 grant 6006: </pre>
1.75 rillig 6007: </li>
6008: </ol></div>
6009: <p>Once this is done, pkginstall will do the following steps for each
6010: script in an automated fashion:</p>
6011: <div class="orderedlist"><ol type="1">
6012: <li><p>Process the file found in the files directory applying all the
1.76 rillig 6013: substitutions described in the <code class="filename">FILES_SUBST</code>
1.75 rillig 6014: variable.</p></li>
6015: <li><p>Copy the script from the files directory to the examples
1.76 rillig 6016: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
1.75 rillig 6017: that this master file must be explicitly registered in the
1.76 rillig 6018: <code class="filename">PLIST</code>.</p></li>
1.75 rillig 6019: <li><p>Add code to the installation scripts to copy the startup script
6020: from the examples hierarchy into the system-wide startup scripts
6021: directory.</p></li>
6022: </ol></div>
6023: <div class="sect2" lang="en">
6024: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6025: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75 rillig 6026: <p>The automatic copying of config files can be toggled by setting the
6027: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6028: installation. Note that the scripts will be always copied inside the
1.76 rillig 6029: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75 rillig 6030: matter what the value of this variable is.</p>
6031: </div>
6032: </div>
6033: <div class="sect1" lang="en">
6034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6035: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75 rillig 6036: <p>If a package needs to create special users and/or groups during
6037: installation, it can do so by using the pkginstall framework.</p>
6038: <p>Users can be created by adding entries to the
6039: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6040: syntax:</p>
6041: <pre class="programlisting">
1.100 rillig 6042: user:group
1.1 grant 6043: </pre>
1.87 wiz 6044: <p>Further specification of user details may be done by setting
6045: per-user variables.
6046: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6047: numeric UID for the user.
6048: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6049: user's description or comment.
6050: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6051: user's home directory, and defaults to
6052: <code class="filename">/nonexistent</code> if not specified.
6053: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94 dmcmahil 6054: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87 wiz 6055: not specified.</p>
1.75 rillig 6056: <p>Similarly, groups can be created by adding entries to the
6057: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6058: <pre class="programlisting">
1.100 rillig 6059: group
1.1 grant 6060: </pre>
1.93 rillig 6061: <p>The numeric GID of the group may be set by defining
1.75 rillig 6062: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6063: <p>If a package needs to create the users and groups at an earlier
6064: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6065: either <code class="literal">configure</code> or <code class="literal">build</code> to
6066: indicate the phase before which the users and groups are created. In
6067: this case, the numeric UIDs and GIDs of the created users and groups
6068: are automatically hardcoded into the final installation scripts.</p>
6069: </div>
6070: <div class="sect1" lang="en">
6071: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6072: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75 rillig 6073: <p>Packages that install system shells should register them in the shell
1.76 rillig 6074: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75 rillig 6075: administrator. This must be done from the installation scripts to keep
6076: binary packages working on any system. pkginstall provides an easy way to
6077: accomplish this task.</p>
6078: <p>When a package provides a shell interpreter, it has to set the
6079: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6080: add some hooks to the installation scripts to handle it. Consider the
1.91 rillig 6081: 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 6082: <pre class="programlisting">
1.100 rillig 6083: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 grant 6084: </pre>
1.75 rillig 6085: <div class="sect2" lang="en">
6086: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6087: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75 rillig 6088: <p>The automatic registration of shell interpreters can be disabled by
1.76 rillig 6089: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75 rillig 6090: environment variable to <code class="literal">NO</code>.</p>
6091: </div>
6092: </div>
6093: <div class="sect1" lang="en">
6094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6095: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75 rillig 6096: <p>Packages that install X11 fonts should update the database files
6097: that index the fonts within each fonts directory. This can easily be
6098: accomplished within the pkginstall framework.</p>
6099: <p>When a package installs X11 fonts, it must list the directories in
6100: which fonts are installed in the
6101: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6102: where <em class="replaceable"><code>type</code></em> can be one of “<span class="quote">ttf</span>”,
6103: “<span class="quote">type1</span>” or “<span class="quote">x11</span>”. This will add hooks to the
6104: installation scripts to run the appropriate commands to update the fonts
6105: database files within each of those directories. For convenience, if the
6106: directory path is relative, it is taken to be relative to the package's
1.91 rillig 6107: 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 6108: <pre class="programlisting">
1.100 rillig 6109: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1 grant 6110: </pre>
1.75 rillig 6111: <div class="sect2" lang="en">
6112: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6113: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75 rillig 6114: <p>The automatic update of fonts databases can be disabled by
1.76 rillig 6115: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75 rillig 6116: environment variable to <code class="literal">NO</code>.</p>
6117: </div>
6118: </div>
6119: </div>
6120: <div class="chapter" lang="en">
6121: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6122: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75 rillig 6123: <div class="toc">
6124: <p><b>Table of Contents</b></p>
6125: <dl>
1.106 rillig 6126: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
6127: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
6128: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107 rillig 6129: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75 rillig 6130: </dl>
6131: </div>
6132: <p>Many packages have the ability to be built to support different
1.76 rillig 6133: sets of features. <code class="filename">bsd.options.mk</code> is a framework
1.75 rillig 6134: in pkgsrc that provides generic handling of those options that
6135: determine different ways in which the packages can be built. It's
6136: possible for the user to specify exactly which sets of options will be
6137: built into a package or to allow a set of global default options
6138: apply.</p>
1.107 rillig 6139: <p>There are two broad classes of behaviors that one might want to
6140: control via options. One is whether some particular feature is
6141: enabled in a program that will be built anyway, often by including or
6142: not including a dependency on some other package. The other is
6143: whether or not an additional program will be built as part of the
6144: package. Generally, it is better to make a split package for such
6145: additional programs instead of using options, because it enables
6146: binary packages to be built which can then be added separately. For
6147: example, the foo package might have minimal dependencies (those
6148: packages without which foo doesn't make sense), and then the foo-gfoo
6149: package might include the GTK frontend program gfoo. This is better
6150: than including a gtk option to foo that adds gfoo, because either that
6151: option is default, in which case binary users can't get foo without
6152: gfoo, or not default, in which case they can't get gfoo. With split
6153: packages, they can install foo without having GTK, and later decide to
6154: install gfoo (pulling in GTK at that time). This is an advantage to
6155: source users too, avoiding the need for rebuilds.</p>
6156: <p>Plugins with widely varying dependencies should usually be split
6157: instead of options.</p>
6158: <p>It is often more work to maintain split packages, especially if
6159: the upstream package does not support this. The decision of split
6160: vs. option should be made based on the likelihood that users will want
6161: or object to the various pieces, the size of the dependencies that are
6162: included, and the amount of work.</p>
6163: <p>A further consideration is licensing. Non-free parts, or parts
6164: that depend on non-free dependencies (especially plugins) should
6165: almost always be split if feasible.</p>
1.75 rillig 6166: <div class="sect1" lang="en">
6167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6168: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75 rillig 6169: <p>Global default options are listed in
6170: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6171: that should be built into every package if that option is supported.
1.110 hubertf 6172: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75 rillig 6173: </div>
6174: <div class="sect1" lang="en">
6175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6176: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93 rillig 6177: </h2></div></div></div>
1.75 rillig 6178: <p>The following example shows how
1.76 rillig 6179: <code class="filename">bsd.options.mk</code> should be used
1.75 rillig 6180: by the hypothetical ``wibble'' package, either in the package
1.76 rillig 6181: <code class="filename">Makefile</code>, or in a file,
6182: e.g. <code class="filename">options.mk</code>, that is included by the
6183: main package <code class="filename">Makefile</code>.</p>
1.75 rillig 6184: <pre class="programlisting">
1.100 rillig 6185: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6186: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6187: PKG_OPTIONS_OPTIONAL_GROUPS= database
6188: PKG_OPTIONS_GROUP.database= mysql pgsql
6189: PKG_SUGGESTED_OPTIONS= wibble-foo
6190: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6191: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6192:
6193: .include "../../mk/bsd.prefs.mk"
6194:
6195: # this package was previously named wibble2
6196: .if defined(PKG_OPTIONS.wibble2)
6197: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6198: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6199: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6200: .endif
6201:
6202: .include "../../mk/bsd.options.mk"
6203:
6204: # Package-specific option-handling
6205:
6206: ###
6207: ### FOO support
6208: ###
6209: .if !empty(PKG_OPTIONS:Mwibble-foo)
6210: CONFIGURE_ARGS+= --enable-foo
6211: .endif
6212:
6213: ###
6214: ### LDAP support
6215: ###
6216: .if !empty(PKG_OPTIONS:Mldap)
6217: . include "../../databases/openldap-client/buildlink3.mk"
6218: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6219: .endif
6220:
6221: ###
6222: ### database support
6223: ###
6224: .if !empty(PKG_OPTIONS:Mmysql)
6225: . include "../../mk/mysql.buildlink3.mk"
6226: .endif
6227: .if !empty(PKG_OPTIONS:Mpgsql)
6228: . include "../../mk/pgsql.buildlink3.mk"
6229: .endif
1.75 rillig 6230: </pre>
6231: <p>The first section contains the information about which build
6232: options are supported by the package, and any default options settings
6233: if needed.</p>
6234: <div class="orderedlist"><ol type="1">
6235: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110 hubertf 6236: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75 rillig 6237: options. It should be set to
1.78 rillig 6238: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6239: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6240: at the point where the options are processed.</p></li>
1.75 rillig 6241: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6242: build options supported by the package.</p></li>
6243: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6244: list of names of groups of mutually exclusive options. The options in
6245: each group are listed in
6246: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6247: The most specific setting of any option from the group takes
6248: precedence over all other options in the group. Options from the
6249: groups will be automatically added to
6250: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6251: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6252: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6253: packages will fail if no option from the group is
6254: selected.</p></li>
6255: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6256: of names of sets of options. At least one option from each set must
6257: be selected. The options in each set are listed in
6258: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6259: Options from the sets will be automatically added to
6260: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6261: fail if no option from the set is selected.</p></li>
6262: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6263: build options which are enabled by default.</p></li>
6264: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6265: of
6266: “<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”
1.110 hubertf 6267: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75 rillig 6268: their option counterparts. Pairs should be added with
6269: “<span class="quote">+=</span>” to keep the listing of global legacy variables. A
6270: warning will be issued if the user uses a legacy
6271: variable.</p></li>
6272: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6273: of
6274: “<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”
6275: pairs that map options that have been renamed to their new
6276: counterparts. Pairs should be added with “<span class="quote">+=</span>” to keep
6277: the listing of global legacy options. A warning will be issued if
6278: the user uses a legacy option.</p></li>
6279: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6280: options implied by deprecated variables used. This can be used for
6281: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6282: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6283: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6284: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6285: a list of warnings about deprecated variables or options used, and
6286: what to use instead.</p></li>
6287: </ol></div>
6288: <p>A package should never modify
6289: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6290: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6291: To suggest a default set of options, use
6292: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6293: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76 rillig 6294: including <code class="filename">bsd.options.mk</code>. If none of
1.75 rillig 6295: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6296: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6297: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6298: happen with platform-specific options if none of them is supported on
6299: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6300: empty list and the package is otherwise treated as not using the
6301: options framework.</p>
1.76 rillig 6302: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75 rillig 6303: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6304: build options, properly filtered to remove unsupported and duplicate
6305: options.</p>
6306: <p>The remaining sections contain the logic that is specific to
6307: each option. The correct way to check for an option is to check
6308: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6309: <pre class="programlisting">
1.100 rillig 6310: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75 rillig 6311: </pre>
6312: </div>
6313: <div class="sect1" lang="en">
6314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6315: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75 rillig 6316: <p>Options that enable similar features in different packages (like
6317: optional support for a library) should use a common name in all
6318: packages that support it (like the name of the library). If another
6319: package already has an option with the same meaning, use the same
6320: name.</p>
6321: <p>Options that enable features specific to one package, where it's
6322: unlikely that another (unrelated) package has the same (or a similar)
6323: optional feature, should use a name prefixed with
6324: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6325: <p>If a group of related packages share an optional feature
6326: specific to that group, prefix it with the name of the
6327: “<span class="quote">main</span>” package
6328: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6329: <p>For new options, add a line to
1.76 rillig 6330: <code class="filename">mk/defaults/options.description</code>. Lines have two
1.75 rillig 6331: fields, separated by tab. The first field is the option name, the
6332: second its description. The description should be a whole sentence
6333: (starting with an uppercase letter and ending with a period) that
6334: describes what enabling the option does. E. g. “<span class="quote">Enable ispell
6335: support.</span>” The file is sorted by option names.</p>
6336: </div>
1.107 rillig 6337: <div class="sect1" lang="en">
6338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6339: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110 hubertf 6340: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107 rillig 6341: different dependencies based on the options with which the package was
6342: built. For querying these options, the file
6343: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6344: typical example looks like this:</p>
6345: <pre class="programlisting">
6346: pkgbase := libpurple
6347: .include "../../mk/pkg-build-options.mk"
6348:
6349: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6350: ...
6351: .endif
6352: </pre>
6353: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6354: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6355: options of the libpurple package, which can then be queried like
6356: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6357: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6358: details.</p>
6359: </div>
1.75 rillig 6360: </div>
6361: <div class="chapter" lang="en">
6362: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 6363: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75 rillig 6364: <div class="toc">
6365: <p><b>Table of Contents</b></p>
6366: <dl>
1.106 rillig 6367: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6368: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6369: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6370: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
6371: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6372: <dd><dl>
6373: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6374: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6375: </dl></dd>
6376: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6377: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6378: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6379: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6380: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6381: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6382: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6383: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6384: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6385: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6386: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6387: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75 rillig 6388: </dl>
6389: </div>
6390: <div class="sect1" lang="en">
6391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6392: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75 rillig 6393: <p>This chapter gives a detailed description on how a package is
1.87 wiz 6394: built. Building a package is separated into different
6395: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6396: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6397: described in the following sections. Each phase is splitted into
6398: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6399: containing phase, prefixed by one of <code class="varname">pre-</code>,
6400: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6401: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6402: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97 rillig 6403: <p>Never override the regular targets (like
6404: <code class="varname">fetch</code>), if you have to, override the
6405: <code class="varname">do-*</code> ones instead.</p>
1.75 rillig 6406: <p>The basic steps for building a program are always the same. First
1.87 wiz 6407: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6408: the local system and then extracted. After any pkgsrc-specific patches
6409: to compile properly are applied, the software can be configured, then
6410: built (usually by compiling), and finally the generated binaries, etc.
6411: can be put into place on the system.</p>
1.97 rillig 6412: <p>To get more details about what is happening at each step,
6413: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6414: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6415: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75 rillig 6416: </div>
6417: <div class="sect1" lang="en">
6418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6419: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75 rillig 6420: <p>Before outlining the process performed by the NetBSD package system in
1.87 wiz 6421: the next section, here's a brief discussion on where programs are
6422: installed, and which variables influence this.</p>
1.75 rillig 6423: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87 wiz 6424: where all files of the final program shall be installed. It is
6425: usually set to <code class="varname">LOCALBASE</code>
6426: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88 wiz 6427: for pkgs in the <code class="filename">cross</code> category. The value of
1.87 wiz 6428: <code class="varname">PREFIX</code> needs to be put
6429: into the various places in the program's source where paths to
1.110 hubertf 6430: these files are encoded. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, “Shared libraries - libtool”</a> for more details.</p>
1.75 rillig 6431: <p>When choosing which of these variables to use,
1.87 wiz 6432: follow the following rules:</p>
1.75 rillig 6433: <div class="itemizedlist"><ul type="disc">
1.88 wiz 6434: <li><p><code class="varname">PREFIX</code> always points to the location
6435: where the current pkg will be installed. When referring to a
6436: pkg's own installation path, use
6437: “<span class="quote">${PREFIX}</span>”.</p></li>
6438: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6439: are installed. If you need to construct a -I or -L argument
6440: to the compiler to find includes and libraries installed by
6441: another non-X11 pkg, use “<span class="quote">${LOCALBASE}</span>”. The name
1.87 wiz 6442: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6443: installed all packages in <code class="filename">/usr/local</code>. As
6444: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6445: administrator, this variable is a misnomer.</p></li>
1.88 wiz 6446: <li><p><code class="varname">X11BASE</code> is where the actual X11
6447: distribution (from xsrc, etc.) is installed. When looking for
6448: <span class="emphasis"><em>standard</em></span> X11 includes (not those
6449: installed by a package), use “<span class="quote">${X11BASE}</span>”.</p></li>
6450: <li>
6451: <p>X11-based packages are special in that they may be
6452: installed in either <code class="varname">X11BASE</code> or
6453: <code class="varname">LOCALBASE</code>.</p>
1.75 rillig 6454: <p>Usually, X11 packages should be installed under
1.88 wiz 6455: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6456: will need to include
6457: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6458: request the presence of X11 and to get the right compilation
6459: flags.</p>
1.75 rillig 6460: <p>Even though, there are some packages that cannot be installed
1.87 wiz 6461: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6462: files. These packages are special and they must be placed under
6463: <code class="varname">X11BASE</code>. To accomplish this, set either
6464: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6465: your package.</p>
1.75 rillig 6466: <p>Some notes: If you need
1.87 wiz 6467: to find includes or libraries installed by a pkg that has
6468: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6469: its pkg <code class="filename">Makefile</code>, you need to look in
6470: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6471: <code class="filename">${LOCALBASE}</code>. To force installation of
6472: all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91 rillig 6473: <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 6474: is enabled by default.</p>
1.75 rillig 6475: </li>
1.88 wiz 6476: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
6477: the installed location of an X11
6478: package. <code class="varname">X11PREFIX</code> will be set to
6479: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6480: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6481: installed.</p></li>
6482: <li>
6483: <p>If xpkgwedge is installed, it is possible to have some
6484: packages installed in <code class="varname">X11BASE</code> and some in
6485: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6486: installed package, the <code class="varname">EVAL_PREFIX</code>
6487: definition can be used. It takes pairs in the format
1.110 hubertf 6488: “<span class="quote">DIRNAME=<package></span>”, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88 wiz 6489: variable <code class="varname">DIRNAME</code> will be set to the prefix
6490: of the installed package <package>, or
6491: “<span class="quote">${X11PREFIX}</span>” if the package is not
6492: installed.</p>
1.75 rillig 6493: <p>This is best illustrated by example.</p>
6494: <p>The following lines are taken from
1.87 wiz 6495: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75 rillig 6496: <pre class="programlisting">
1.100 rillig 6497: EVAL_PREFIX+= GTKDIR=gtk+
6498: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6499: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6500: CONFIGURE_ARGS+= --enable-multibyte
6501: </pre>
1.88 wiz 6502: <p>Specific defaults can be defined for the packages
6503: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6504: definition of the form:</p>
1.75 rillig 6505: <pre class="programlisting">
1.100 rillig 6506: GTKDIR_DEFAULT= ${LOCALBASE}
6507: </pre>
1.75 rillig 6508: <p>where <code class="varname">GTKDIR</code> corresponds
1.87 wiz 6509: to the first definition in
6510: the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75 rillig 6511: </li>
1.76 rillig 6512: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110 hubertf 6513: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87 wiz 6514: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6515: <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75 rillig 6516: </ul></div>
6517: </div>
6518: <div class="sect1" lang="en">
6519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6520: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.75 rillig 6521: <p>When building a package, a number of directories is used to store
1.87 wiz 6522: source files, temporary files, pkgsrc-internal files, and so on. These
6523: directories are explained here.</p>
1.75 rillig 6524: <p>Some of the directory variables contain relative pathnames. There
1.87 wiz 6525: are two common base directories for these relative directories:
6526: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6527: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6528: inside the package itself.</p>
1.75 rillig 6529: <div class="variablelist"><dl>
6530: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6531: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87 wiz 6532: root directory. Generally, you don't need
6533: it.</p></dd>
1.97 rillig 6534: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6535: <dd><p>This is an absolute pathname that points to the
6536: current package.</p></dd>
1.75 rillig 6537: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6538: <dd><p>This is a pathname relative to
1.87 wiz 6539: <code class="varname">PKGSRCDIR</code> that points to the current
6540: package.</p></dd>
1.75 rillig 6541: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6542: <dd><p>This is an absolute pathname pointing to the directory
1.93 rillig 6543: where all work takes place. The distfiles are extracted to this
1.87 wiz 6544: directory. It also contains temporary directories and log files used by
6545: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6546: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75 rillig 6547: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6548: <dd><p>This is an absolute pathname pointing to the directory
1.87 wiz 6549: where the distfiles are extracted. It is usually a direct subdirectory
6550: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6551: that isn't hidden. This variable may be changed by a package
6552: <code class="filename">Makefile</code>.</p></dd>
1.75 rillig 6553: </dl></div>
6554: </div>
6555: <div class="sect1" lang="en">
6556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6557: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110 hubertf 6558: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87 wiz 6559: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6560: phase. This will automatically run all phases that are required for this
6561: phase. The default phase is <code class="varname">build</code>, that is, when you
1.110 hubertf 6562: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87 wiz 6563: the package will be built, but not installed.</p>
1.75 rillig 6564: </div>
6565: <div class="sect1" lang="en">
6566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6567: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81 rillig 6568: <p>The first step in building a package is to fetch the
1.88 wiz 6569: distribution files (distfiles) from the sites that are providing
6570: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6571: phase.</p>
1.81 rillig 6572: <div class="sect2" lang="en">
6573: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6574: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88 wiz 6575: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6576: defines all URLs from where the distfile, whose name is
6577: derived from the <code class="varname">DISTNAME</code> variable, is
6578: fetched. The more complicated cases are described
6579: below.</p>
6580: <p>The variable <code class="varname">DISTFILES</code> specifies
6581: the list of distfiles that have to be fetched. Its value
6582: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6583: so that most packages don't need to define it at all.
6584: <code class="varname">EXTRACT_SUFX</code> is
6585: <code class="literal">.tar.gz</code> by default, but can be changed
6586: freely. Note that if your package requires additional
6587: distfiles to the default one, you cannot just append the
6588: additional filenames using the <code class="literal">+=</code>
6589: operator, but you have write for example:</p>
1.81 rillig 6590: <pre class="programlisting">
1.100 rillig 6591: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6592: </pre>
1.88 wiz 6593: <p>Each distfile is fetched from a list of sites, usually
6594: <code class="varname">MASTER_SITES</code>. If the package has multiple
6595: <code class="varname">DISTFILES</code> or multiple
6596: <code class="varname">PATCHFILES</code> from different sites, you can
6597: set
6598: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6599: to the list of URLs where the file
6600: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6601: (including the suffix) can be found.</p>
6602: <pre class="programlisting">
1.100 rillig 6603: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6604: DISTFILES+= foo-file.tar.gz
6605: SITES.foo-file.tar.gz= \
6606: http://www.somewhere.com/somehow/ \
6607: http://www.somewhereelse.com/mirror/somehow/
6608: </pre>
1.81 rillig 6609: <p>When actually fetching the distfiles, each item from
1.88 wiz 6610: <code class="varname">MASTER_SITES</code> or
6611: <code class="varname">SITES.*</code> gets the name of each distfile
6612: appended to it, without an intermediate slash. Therefore,
6613: all site values have to end with a slash or other separator
6614: character. This allows for example to set
6615: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6616: that gets the name of the distfile as a parameter. In this
6617: case, the definition would look like:</p>
1.81 rillig 6618: <pre class="programlisting">
1.100 rillig 6619: MASTER_SITES= http://www.example.com/download.cgi?file=
6620: </pre>
1.81 rillig 6621: <p>There are some predefined values for
1.88 wiz 6622: <code class="varname">MASTER_SITES</code>, which can be used in
6623: packages. The names of the variables should speak for
6624: themselves.</p>
6625: <pre class="programlisting">
1.100 rillig 6626: ${MASTER_SITE_APACHE}
6627: ${MASTER_SITE_BACKUP}
6628: ${MASTER_SITE_CYGWIN}
6629: ${MASTER_SITE_DEBIAN}
6630: ${MASTER_SITE_FREEBSD}
6631: ${MASTER_SITE_FREEBSD_LOCAL}
6632: ${MASTER_SITE_GENTOO}
6633: ${MASTER_SITE_GNOME}
6634: ${MASTER_SITE_GNU}
6635: ${MASTER_SITE_GNUSTEP}
6636: ${MASTER_SITE_IFARCHIVE}
6637: ${MASTER_SITE_KDE}
6638: ${MASTER_SITE_MOZILLA}
6639: ${MASTER_SITE_MYSQL}
6640: ${MASTER_SITE_OPENOFFICE}
6641: ${MASTER_SITE_PERL_CPAN}
6642: ${MASTER_SITE_PGSQL}
6643: ${MASTER_SITE_R_CRAN}
6644: ${MASTER_SITE_SOURCEFORGE}
6645: ${MASTER_SITE_SOURCEFORGE_JP}
6646: ${MASTER_SITE_SUNSITE}
6647: ${MASTER_SITE_SUSE}
6648: ${MASTER_SITE_TEX_CTAN}
6649: ${MASTER_SITE_XCONTRIB}
6650: ${MASTER_SITE_XEMACS}
6651: </pre>
1.88 wiz 6652: <p>Some explanations for the less self-explaining ones:
6653: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110 hubertf 6654: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
6655: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88 wiz 6656: <p>If you choose one of these predefined sites, you may
6657: want to specify a subdirectory of that site. Since these
6658: macros may expand to more than one actual site, you
6659: <span class="emphasis"><em>must</em></span> use the following construct to
6660: specify a subdirectory:</p>
1.81 rillig 6661: <pre class="programlisting">
1.100 rillig 6662: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6663: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6664: </pre>
1.81 rillig 6665: <p>Note the trailing slash after the subdirectory
1.88 wiz 6666: name.</p>
1.81 rillig 6667: </div>
6668: <div class="sect2" lang="en">
6669: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 6670: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88 wiz 6671: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6672: all the distfiles exist in a local directory
1.93 rillig 6673: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88 wiz 6674: user). If the files do not exist, they are fetched using
6675: commands of the form</p>
1.75 rillig 6676: <pre class="programlisting">
1.100 rillig 6677: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6678: </pre>
1.88 wiz 6679: <p>where <code class="literal">${site}</code> varies through
6680: several possibilities in turn: first,
6681: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6682: sites specified in either <code class="varname">SITES.file</code> if
6683: defined, else <code class="varname">MASTER_SITES</code> or
6684: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6685: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91 rillig 6686: all except the first and the last can be optionally sorted
6687: by the user, via setting either
6688: <code class="varname">MASTER_SORT_RANDOM</code>, and
6689: <code class="varname">MASTER_SORT_AWK</code> or
1.88 wiz 6690: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.97 rillig 6691: <p>The distfiles mirror run by the NetBSD Foundation uses the
6692: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6693: distfiles, if they are freely distributable. Packages setting
6694: <code class="varname">NO_SRC_ON_FTP</code> (usually to
6695: “<span class="quote">${RESTRICTED}</span>”) will not have their distfiles
6696: mirrored.</p>
1.81 rillig 6697: </div>
1.75 rillig 6698: </div>
6699: <div class="sect1" lang="en">
6700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6701: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88 wiz 6702: <p>After the distfile(s) are fetched, their checksum is
6703: generated and compared with the checksums stored in the
6704: distinfo file. If the checksums don't match, the build is
6705: aborted. This is to ensure the same distfile is used for
6706: building, and that the distfile wasn't changed, e.g. by some
6707: malign force, deliberately changed distfiles on the master
6708: distribution site or network lossage.</p>
1.75 rillig 6709: </div>
6710: <div class="sect1" lang="en">
6711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6712: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75 rillig 6713: <p>When the distfiles are present on the local system, they
1.88 wiz 6714: need to be extracted, as they usually come in the form of some
6715: compressed archive format.</p>
1.75 rillig 6716: <p>By default, all <code class="varname">DISTFILES</code> are
1.88 wiz 6717: extracted. If you only need some of them, you can set the
6718: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6719: files.</p>
6720: <p>Extracting the files is usually done by a little
1.93 rillig 6721: program, <code class="filename">mk/extract/extract</code>, which
1.88 wiz 6722: already knows how to extract various archive formats, so most
6723: likely you will not need to change anything here. But if you
6724: need, the following variables may help you:</p>
1.75 rillig 6725: <div class="variablelist"><dl>
6726: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6727: <dd><p>Use these variables to override the default
1.88 wiz 6728: options for an extract command, which are defined in
1.93 rillig 6729: <code class="filename">mk/extract/extract</code>.</p></dd>
1.75 rillig 6730: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6731: <dd><p>This variable can be set to
1.93 rillig 6732: <code class="literal">gtar</code>, <code class="literal">nbtar</code> (which is the
6733: default value), <code class="literal">pax</code>, or an
1.88 wiz 6734: absolute pathname pointing to the command with which tar
6735: archives should be
6736: extracted.</p></dd>
1.75 rillig 6737: </dl></div>
1.88 wiz 6738: <p>If the <code class="filename">extract</code> program doesn't
6739: serve your needs, you can also override the
6740: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6741: command used for extracting the files. This command is
6742: executed in the <code class="filename">${WRKSRC}</code>
6743: directory. During execution of this command, the shell
6744: variable <code class="varname">extract_file</code> holds the absolute
6745: pathname of the file that is going to be extracted.</p>
1.75 rillig 6746: <p>And if that still does not suffice, you can override the
1.88 wiz 6747: <code class="varname">do-extract</code> target in the package
6748: Makefile.</p>
1.75 rillig 6749: </div>
6750: <div class="sect1" lang="en">
6751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6752: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75 rillig 6753: <p>After extraction, all the patches named by the
1.88 wiz 6754: <code class="varname">PATCHFILES</code>, those present in the patches
6755: subdirectory of the package as well as in
6756: $LOCALPATCHES/$PKGPATH (e.g.
6757: <code class="filename">/usr/local/patches/graphics/png</code>) are
6758: applied. Patchfiles ending in <code class="filename">.Z</code> or
6759: <code class="filename">.gz</code> are uncompressed before they are
6760: applied, files ending in <code class="filename">.orig</code> or
6761: <code class="filename">.rej</code> are ignored. Any special options to
1.110 hubertf 6762: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
6763: <code class="varname">PATCH_DIST_ARGS</code>. See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more details.</p>
6764: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88 wiz 6765: it fail if the patches apply with some lines of fuzz. Please
6766: fix (regen) the patches so that they apply cleanly. The
6767: rationale behind this is that patches that don't apply cleanly
6768: may end up being applied in the wrong place, and cause severe
6769: harm there.</p>
1.75 rillig 6770: </div>
6771: <div class="sect1" lang="en">
6772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6773: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110 hubertf 6774: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88 wiz 6775: </p>
1.75 rillig 6776: </div>
6777: <div class="sect1" lang="en">
6778: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6779: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75 rillig 6780: <p>This phase creates wrapper programs for the compilers and
1.88 wiz 6781: linkers. The following variables can be used to tweak the
6782: wrappers.</p>
1.75 rillig 6783: <div class="variablelist"><dl>
6784: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6785: <dd><p>The command used to print progress
1.88 wiz 6786: messages. Does nothing by default. Set to
6787: <code class="literal">${ECHO}</code> to see the progress
6788: messages.</p></dd>
1.75 rillig 6789: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6790: <dd><p>This variable can be set to
1.88 wiz 6791: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6792: depending on whether you want additional information in the
6793: wrapper log file.</p></dd>
1.75 rillig 6794: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6795: <dd><p>This variable can be set to
1.88 wiz 6796: <code class="literal">yes</code> or <code class="literal">no</code>, depending
6797: on whether the wrapper should use its cache, which will
6798: improve the speed. The default value is
6799: <code class="literal">yes</code>, but is forced to
6800: <code class="literal">no</code> if the platform does not support
6801: it.</p></dd>
1.75 rillig 6802: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88 wiz 6803: <dd><p>A list of reordering commands. A reordering
6804: command has the form
6805: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6806: It ensures that that
6807: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6808: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6809: </p></dd>
1.75 rillig 6810: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6811: <dd><p>A list of transformation commands. [TODO:
1.88 wiz 6812: investigate further]</p></dd>
1.75 rillig 6813: </dl></div>
6814: </div>
6815: <div class="sect1" lang="en">
6816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6817: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88 wiz 6818: <p>Most pieces of software need information on the header
6819: files, system calls, and library routines which are available
6820: on the platform they run on. The process of determining this
6821: information is known as configuration, and is usually
6822: automated. In most cases, a script is supplied with the
6823: distfiles, and its invocation results in generation of header
6824: files, Makefiles, etc.</p>
6825: <p>If the package contains a configure script, this can be
6826: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6827: “<span class="quote">yes</span>”. If the configure script is a GNU autoconf
6828: script, you should set <code class="varname">GNU_CONFIGURE</code> to
6829: “<span class="quote">yes</span>” instead. What happens in the
6830: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6831: <pre class="programlisting">
1.100 rillig 6832: .for d in ${CONFIGURE_DIRS}
6833: cd ${WRKSRC} \
6834: && cd ${d} \
6835: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6836: .endfor
6837: </pre>
1.88 wiz 6838: <p><code class="varname">CONFIGURE_DIRS</code> (default:
6839: “<span class="quote">.</span>”) is a list of pathnames relative to
6840: <code class="varname">WRKSRC</code>. In each of these directories, the
6841: configure script is run with the environment
6842: <code class="varname">CONFIGURE_ENV</code> and arguments
6843: <code class="varname">CONFIGURE_ARGS</code>. The variables
6844: <code class="varname">CONFIGURE_ENV</code>,
6845: <code class="varname">CONFIGURE_SCRIPT</code> (default:
6846: “<span class="quote">./configure</span>”) and
6847: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6848: package.</p>
6849: <p>If the program uses an <code class="filename">Imakefile</code>
6850: for configuration, the appropriate steps can be invoked by
6851: setting <code class="varname">USE_IMAKE</code> to
6852: “<span class="quote">yes</span>”. (If you only want the package installed in
6853: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97 rillig 6854: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
6855: xmkmf's environment by adding them to the
6856: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111 rillig 6857: <p>If the program uses <code class="filename">cmake</code>
6858: for configuration, the appropriate steps can be invoked by
6859: setting <code class="varname">USE_CMAKE</code> to “<span class="quote">yes</span>”.
6860: You can add variables to cmake's environment by adding them to the
6861: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6862: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6863: The top directory argument is given by the
6864: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
6865: “<span class="quote">.</span>” (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97 rillig 6866: <p>If there is no configure step at all, set
6867: <code class="varname">NO_CONFIGURE</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6868: </div>
6869: <div class="sect1" lang="en">
6870: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6871: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88 wiz 6872: <p>For building a package, a rough equivalent of the
6873: following code is executed.</p>
1.75 rillig 6874: <pre class="programlisting">
1.100 rillig 6875: .for d in ${BUILD_DIRS}
6876: cd ${WRKSRC} \
6877: && cd ${d} \
6878: && env ${MAKE_ENV} \
6879: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6880: -f ${MAKE_FILE} \
6881: ${BUILD_TARGET}
6882: .endfor
6883: </pre>
1.88 wiz 6884: <p><code class="varname">BUILD_DIRS</code> (default:
6885: “<span class="quote">.</span>”) is a list of pathnames relative to
6886: <code class="varname">WRKSRC</code>. In each of these directories,
6887: <code class="varname">MAKE_PROGRAM</code> is run with the environment
6888: <code class="varname">MAKE_ENV</code> and arguments
6889: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6890: <code class="varname">MAKE_ENV</code>,
6891: <code class="varname">BUILD_MAKE_FLAGS</code>,
6892: <code class="varname">MAKE_FILE</code> and
6893: <code class="varname">BUILD_TARGET</code> may all be changed by the
6894: package.</p>
1.75 rillig 6895: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88 wiz 6896: “<span class="quote">gmake</span>” if <code class="varname">USE_TOOLS</code> contains
6897: “<span class="quote">gmake</span>”, “<span class="quote">make</span>” otherwise. The
6898: default value of <code class="varname">MAKE_FILE</code> is
6899: “<span class="quote">Makefile</span>”, and <code class="varname">BUILD_TARGET</code>
6900: defaults to “<span class="quote">all</span>”.</p>
1.97 rillig 6901: <p>If there is no build step at all, set
6902: <code class="varname">NO_BUILD</code> to “<span class="quote">yes</span>”.</p>
1.75 rillig 6903: </div>
6904: <div class="sect1" lang="en">
6905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6906: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75 rillig 6907: <p>[TODO]</p>
6908: </div>
6909: <div class="sect1" lang="en">
6910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6911: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 6912: <p>Once the build stage has completed, the final step is to
1.88 wiz 6913: install the software in public directories, so users can
6914: access the programs and files.</p>
1.75 rillig 6915: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88 wiz 6916: equivalent of the following code is executed. Additionally,
6917: before and after this code, much magic is performed to do
6918: consistency checks, registering the package, and so on.</p>
6919: <pre class="programlisting">
1.100 rillig 6920: .for d in ${INSTALL_DIRS}
6921: cd ${WRKSRC} \
6922: && cd ${d} \
6923: && env ${MAKE_ENV} \
6924: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6925: -f ${MAKE_FILE} \
6926: ${INSTALL_TARGET}
6927: .endfor
6928: </pre>
1.75 rillig 6929: <p>The variable's meanings are analogous to the ones in the
1.88 wiz 6930: <span class="emphasis"><em>build</em></span> phase.
6931: <code class="varname">INSTALL_DIRS</code> defaults to
6932: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
6933: is “<span class="quote">install</span>” by default, plus
6934: “<span class="quote">install.man</span>” if <code class="varname">USE_IMAKE</code> is
6935: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
6936: defined.</p>
1.75 rillig 6937: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88 wiz 6938: variables are useful. They are all variations of the
1.110 hubertf 6939: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88 wiz 6940: permissions preset. <code class="varname">INSTALL</code> is the plain
6941: install command. The specialized variants, together with their
6942: intended use, are:</p>
1.75 rillig 6943: <div class="variablelist"><dl>
6944: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88 wiz 6945: <dd><p>directories that contain
6946: binaries</p></dd>
1.75 rillig 6947: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88 wiz 6948: <dd><p>directories that contain
6949: scripts</p></dd>
1.75 rillig 6950: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88 wiz 6951: <dd><p>directories that contain shared and static
6952: libraries</p></dd>
1.75 rillig 6953: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88 wiz 6954: <dd><p>directories that contain data
6955: files</p></dd>
1.75 rillig 6956: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88 wiz 6957: <dd><p>directories that contain man
6958: pages</p></dd>
1.75 rillig 6959: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88 wiz 6960: <dd><p>binaries that can be stripped from debugging
6961: symbols</p></dd>
1.75 rillig 6962: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88 wiz 6963: <dd><p>binaries that cannot be
6964: stripped</p></dd>
1.75 rillig 6965: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88 wiz 6966: <dd><p>game
6967: binaries</p></dd>
1.75 rillig 6968: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88 wiz 6969: <dd><p>shared and static
6970: libraries</p></dd>
1.75 rillig 6971: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
6972: <dd><p>data files</p></dd>
6973: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88 wiz 6974: <dd><p>data files for
6975: games</p></dd>
1.75 rillig 6976: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
6977: <dd><p>man pages</p></dd>
6978: </dl></div>
6979: <p>Some other variables are:</p>
6980: <div class="variablelist"><dl>
6981: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
6982: <dd><p>A list of directories relative to
1.88 wiz 6983: <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98 wiz 6984: beginning of the <span class="emphasis"><em>install</em></span> phase.
6985: The package is supposed to create all needed directories itself
6986: before installing files to it and list all other directories here.
6987: </p></dd>
1.75 rillig 6988: </dl></div>
1.97 rillig 6989: <p>In the rare cases that a package shouldn't install anything,
6990: set <code class="varname">NO_INSTALL</code> to “<span class="quote">yes</span>”. This is
6991: mostly relevant for packages in the <code class="filename">regress</code>
6992: category.</p>
1.75 rillig 6993: </div>
6994: <div class="sect1" lang="en">
6995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 6996: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88 wiz 6997: <p>Once the install stage has completed, a binary package of
6998: the installed files can be built. These binary packages can be
6999: used for quick installation without previous compilation, e.g. by
1.110 hubertf 7000: the <span class="command"><strong>make bin-install</strong></span> or by using
7001: <span class="command"><strong>pkg_add</strong></span>.</p>
1.88 wiz 7002: <p>By default, the binary packages are created in
7003: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7004: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7005: one for each category in the <code class="varname">CATEGORIES</code>
7006: variable. <code class="varname">PACKAGES</code> defaults to
7007: <code class="filename">pkgsrc/packages</code>.</p>
1.97 rillig 7008: <p>If there should be no binary package, set
7009: <code class="varname">NO_PACKAGE</code> to “<span class="quote">yes</span>”.
7010: This should only be used in rare cases, like when a package
7011: definitely is only usable on the machine where it is built and even
7012: then, a binary package can be useful.</p>
1.88 wiz 7013: </div>
7014: <div class="sect1" lang="en">
7015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7016: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88 wiz 7017: <p>Once you're finished with a package, you can clean the work
1.110 hubertf 7018: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.88 wiz 7019: to clean the work directories of all dependencies too, use
1.110 hubertf 7020: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75 rillig 7021: </div>
7022: <div class="sect1" lang="en">
7023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7024: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75 rillig 7025: <div class="variablelist"><dl>
7026: <dt><span class="term">pre/post-*</span></dt>
1.88 wiz 7027: <dd><p>For any of the main targets described in the
7028: previous section, two auxiliary targets exist with
1.87 wiz 7029: “<span class="quote">pre-</span>” and “<span class="quote">post-</span>” used as a
7030: prefix for the main target's name. These targets are
1.88 wiz 7031: invoked before and after the main target is called,
7032: allowing extra configuration or installation steps be
7033: performed from a package's Makefile, for example, which
7034: a program's configure script or install target
7035: omitted.</p></dd>
1.75 rillig 7036: <dt><span class="term">do-*</span></dt>
1.88 wiz 7037: <dd><p>Should one of the main targets do the wrong thing,
7038: and should there be no variable to fix this, you can
7039: redefine it with the do-* target. (Note that redefining
7040: the target itself instead of the do-* target is a bad
7041: idea, as the pre-* and post-* targets won't be called
7042: anymore, etc.) You will not usually need to do
7043: this.</p></dd>
1.75 rillig 7044: <dt><span class="term">reinstall</span></dt>
1.88 wiz 7045: <dd>
1.110 hubertf 7046: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88 wiz 7047: you noticed some file was not installed properly, you
7048: can repeat the installation with this target, which will
7049: ignore the “<span class="quote">already installed</span>” flag.</p>
7050: <p>This is the default value of
7051: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110 hubertf 7052: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88 wiz 7053: package</strong></span>, where the defaults are
7054: “<span class="quote">package</span>” and “<span class="quote">update</span>”,
7055: respectively.</p>
7056: </dd>
1.75 rillig 7057: <dt><span class="term">deinstall</span></dt>
7058: <dd>
1.110 hubertf 7059: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88 wiz 7060: current directory, effectively de-installing the
7061: package. The following variables can be used to tune the
7062: behaviour:</p>
1.75 rillig 7063: <div class="variablelist"><dl>
7064: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110 hubertf 7065: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75 rillig 7066: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88 wiz 7067: <dd><p>Remove all packages that require (depend on)
7068: the given package. This can be used to remove any
7069: packages that may have been pulled in by a given
1.110 hubertf 7070: package, e.g. if <span class="command"><strong>make deinstall
1.87 wiz 7071: DEINSTALLDEPENDS=1</strong></span> is done in
1.88 wiz 7072: <code class="filename">pkgsrc/x11/kde</code>, this is
7073: likely to remove whole KDE. Works by adding
1.110 hubertf 7074: “<span class="quote">-R</span>” to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88 wiz 7075: command line.</p></dd>
1.75 rillig 7076: </dl></div>
7077: </dd>
1.88 wiz 7078: <dt><span class="term">bin-install</span></dt>
7079: <dd><p>Install a binary package from local disk and via FTP
7080: from a list of sites (see the
7081: <code class="varname">BINPKG_SITES</code> variable), and do a
1.110 hubertf 7082: <span class="command"><strong>make package</strong></span> if no binary package is
1.88 wiz 7083: available anywhere. The arguments given to
1.110 hubertf 7084: <span class="command"><strong>pkg_add</strong></span> can be set via
1.88 wiz 7085: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7086: operation, etc.</p></dd>
1.75 rillig 7087: <dt><span class="term">update</span></dt>
7088: <dd>
1.88 wiz 7089: <p>This target causes the current package to be
7090: updated to the latest version. The package and all
7091: depending packages first get de-installed, then current
7092: versions of the corresponding packages get compiled and
7093: installed. This is similar to manually noting which
7094: packages are currently installed, then performing a
1.110 hubertf 7095: series of <span class="command"><strong>make deinstall</strong></span> and
7096: <span class="command"><strong>make install</strong></span> (or whatever
1.88 wiz 7097: <code class="varname">UPDATE_TARGET</code> is set to) for these
7098: packages.</p>
7099: <p>You can use the “<span class="quote">update</span>” target to
1.110 hubertf 7100: resume package updating in case a previous <span class="command"><strong>make
1.88 wiz 7101: update</strong></span> was interrupted for some reason.
7102: However, in this case, make sure you don't call
1.110 hubertf 7103: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88 wiz 7104: list of dependent packages in <code class="varname">WRKDIR</code>.
7105: Otherwise, you lose the ability to automatically update
7106: the current package along with the dependent packages
7107: you have installed.</p>
1.110 hubertf 7108: <p>Resuming an interrupted <span class="command"><strong>make
1.88 wiz 7109: update</strong></span> will only work as long as the package
7110: tree remains unchanged. If the source code for one of
7111: the packages to be updated has been changed, resuming
1.110 hubertf 7112: <span class="command"><strong>make update</strong></span> will most certainly
1.88 wiz 7113: fail!</p>
7114: <p>The following variables can be used either on the
1.110 hubertf 7115: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7116: alter the behaviour of <span class="command"><strong>make
1.88 wiz 7117: update</strong></span>:</p>
1.75 rillig 7118: <div class="variablelist"><dl>
7119: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88 wiz 7120: <dd><p>Install target to recursively use for the
7121: updated package and the dependent packages.
7122: Defaults to <code class="varname">DEPENDS_TARGET</code> if
7123: set, “<span class="quote">install</span>” otherwise for
1.110 hubertf 7124: <span class="command"><strong>make update</strong></span>. Other good
1.88 wiz 7125: targets are “<span class="quote">package</span>” or
7126: “<span class="quote">bin-install</span>”. Do not set this to
7127: “<span class="quote">update</span>” or you will get stuck in an
7128: endless loop!</p></dd>
1.75 rillig 7129: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88 wiz 7130: <dd><p>Don't clean up after updating. Useful if
7131: you want to leave the work sources of the updated
7132: packages around for inspection or other purposes.
7133: Be sure you eventually clean up the source tree
7134: (see the “<span class="quote">clean-update</span>” target below)
7135: or you may run into troubles with old source code
7136: still lying around on your next
1.110 hubertf 7137: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88 wiz 7138: update</strong></span>.</p></dd>
1.75 rillig 7139: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88 wiz 7140: <dd><p>Deinstall each package before installing
7141: (making <code class="varname">DEPENDS_TARGET</code>). This
7142: may be necessary if the
7143: “<span class="quote">clean-update</span>” target (see below) was
1.110 hubertf 7144: called after interrupting a running <span class="command"><strong>make
1.88 wiz 7145: update</strong></span>.</p></dd>
1.75 rillig 7146: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88 wiz 7147: <dd><p>Allows you to disable recursion and hardcode
7148: the target for packages. The default is
7149: “<span class="quote">update</span>” for the update target,
7150: facilitating a recursive update of prerequisite
7151: packages. Only set
7152: <code class="varname">DEPENDS_TARGET</code> if you want to
7153: disable recursive updates. Use
7154: <code class="varname">UPDATE_TARGET</code> instead to just
7155: set a specific target for each package to be
1.110 hubertf 7156: installed during <span class="command"><strong>make update</strong></span>
1.88 wiz 7157: (see above).</p></dd>
1.75 rillig 7158: </dl></div>
7159: </dd>
7160: <dt><span class="term">clean-update</span></dt>
7161: <dd>
1.88 wiz 7162: <p>Clean the source tree for all packages that would
1.110 hubertf 7163: get updated if <span class="command"><strong>make update</strong></span> was called
1.88 wiz 7164: from the current directory. This target should not be
7165: used if the current package (or any of its depending
7166: packages) have already been de-installed (e.g., after
1.110 hubertf 7167: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88 wiz 7168: some packages you intended to update. As a rule of
7169: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110 hubertf 7170: the first time you run <span class="command"><strong>make update</strong></span>
1.88 wiz 7171: and only if you have a dirty package tree (e.g., if you
7172: used <code class="varname">NOCLEAN</code>).</p>
7173: <p>If you are unsure about whether your tree is
1.110 hubertf 7174: clean, you can either perform a <span class="command"><strong>make
1.88 wiz 7175: clean</strong></span> at the top of the tree, or use the
7176: following sequence of commands from the directory of the
7177: package you want to update (<span class="emphasis"><em>before</em></span>
1.110 hubertf 7178: running <span class="command"><strong>make update</strong></span> for the first
1.88 wiz 7179: time, otherwise you lose all the packages you wanted to
7180: update!):</p>
1.87 wiz 7181: <pre class="screen">
7182: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75 rillig 7183: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87 wiz 7184: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7185: </pre>
1.88 wiz 7186: <p>The following variables can be used either on the
1.110 hubertf 7187: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7188: <span class="command"><strong>make clean-update</strong></span>:</p>
1.75 rillig 7189: <div class="variablelist"><dl>
7190: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110 hubertf 7191: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88 wiz 7192: reconstruct the list of directories to update for
1.110 hubertf 7193: this package. Only use this if <span class="command"><strong>make
1.88 wiz 7194: update</strong></span> successfully installed all
7195: packages you wanted to update. Normally, this is
1.110 hubertf 7196: done automatically on <span class="command"><strong>make
1.88 wiz 7197: update</strong></span>, but may have been suppressed by
7198: the <code class="varname">NOCLEAN</code> variable (see
7199: above).</p></dd>
1.75 rillig 7200: </dl></div>
7201: </dd>
1.88 wiz 7202: <dt><span class="term">replace</span></dt>
7203: <dd>
7204: <p>Update the installation of the current package. This
7205: differs from update in that it does not replace dependent
1.93 rillig 7206: 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 7207: target to work.</p>
7208: <p><span class="emphasis"><em>Be careful when using this
7209: target!</em></span> There are no guarantees that dependent
7210: packages will still work, in particular they will most
1.110 hubertf 7211: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88 wiz 7212: library package whose shared library major version changed
7213: between your installed version and the new one. For this
7214: reason, this target is not officially supported and only
7215: recommended for advanced users.</p>
7216: </dd>
1.75 rillig 7217: <dt><span class="term">info</span></dt>
1.110 hubertf 7218: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88 wiz 7219: package. You can use this to check which version of a
7220: package is installed.</p></dd>
7221: <dt><span class="term">index</span></dt>
7222: <dd>
7223: <p>This is a top-level command, i.e. it should be used in
7224: the <code class="filename">pkgsrc</code> directory. It creates a
7225: database of all packages in the local pkgsrc tree, including
7226: dependencies, comment, maintainer, and some other useful
7227: information. Individual entries are created by running
1.110 hubertf 7228: <span class="command"><strong>make describe</strong></span> in the packages'
1.88 wiz 7229: directories. This index file is saved as
7230: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.110 hubertf 7231: verbose format by running <span class="command"><strong>make
1.88 wiz 7232: print-index</strong></span>. You can search in it with
1.110 hubertf 7233: <span class="command"><strong>make search
1.88 wiz 7234: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7235: extract a list of all packages that depend on a particular
1.110 hubertf 7236: one by running <span class="command"><strong>make show-deps
1.88 wiz 7237: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7238: <p>Running this command takes a very long time, some
7239: hours even on fast machines!</p>
7240: </dd>
1.75 rillig 7241: <dt><span class="term">readme</span></dt>
1.88 wiz 7242: <dd>
7243: <p>This target generates a
7244: <code class="filename">README.html</code> file, which can be
1.91 rillig 7245: 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 7246: contain references to any packages which are in the
7247: <code class="varname">PACKAGES</code> directory on the local
7248: host. The generated files can be made to refer to URLs
7249: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7250: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7251: wanted to generate <code class="filename">README.html</code>
7252: files which pointed to binary packages on the local
7253: machine, in the directory
7254: <code class="filename">/usr/packages</code>, set
7255: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7256: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7257: <code class="varname">${PACKAGES}</code> directory and its
7258: subdirectories will be searched for all the binary
7259: packages.</p>
7260: <p>The target can be run at the toplevel or in category
7261: directories, in which case it descends recursively.</p>
7262: </dd>
1.75 rillig 7263: <dt><span class="term">readme-all</span></dt>
1.88 wiz 7264: <dd><p>This is a top-level command, run it in
7265: <code class="filename">pkgsrc</code>. Use this target to create a
7266: file <code class="filename">README-all.html</code> which contains a
7267: list of all packages currently available in the NetBSD
7268: Packages Collection, together with the category they belong
7269: to and a short description. This file is compiled from the
7270: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110 hubertf 7271: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88 wiz 7272: readme</strong></span>.</p></dd>
1.75 rillig 7273: <dt><span class="term">cdrom-readme</span></dt>
1.88 wiz 7274: <dd><p>This is very much the same as the
7275: “<span class="quote">readme</span>” target (see above), but is to be
7276: used when generating a pkgsrc tree to be written to a
7277: CD-ROM. This target also produces
7278: <code class="filename">README.html</code> files, and can be made
7279: to refer to URLs based on
7280: <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87 wiz 7281: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75 rillig 7282: <dt><span class="term">show-distfiles</span></dt>
1.88 wiz 7283: <dd><p>This target shows which distfiles and patchfiles
7284: are needed to build the package
7285: (<code class="varname">ALLFILES</code>, which contains all
7286: <code class="varname">DISTFILES</code> and
1.87 wiz 7287: <code class="varname">PATCHFILES</code>, but not
7288: <code class="filename">patches/*</code>).</p></dd>
1.75 rillig 7289: <dt><span class="term">show-downlevel</span></dt>
1.88 wiz 7290: <dd><p>This target shows nothing if the package is not
7291: installed. If a version of this package is installed,
7292: but is not the version provided in this version of
7293: pkgsrc, then a warning message is displayed. This target
7294: can be used to show which of your installed packages are
7295: downlevel, and so the old versions can be deleted, and
7296: the current ones added.</p></dd>
1.75 rillig 7297: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88 wiz 7298: <dd><p>This target shows the directory in the pkgsrc
7299: hierarchy from which the package can be built and
7300: installed. This may not be the same directory as the one
7301: from which the package was installed. This target is
7302: intended to be used by people who may wish to upgrade
7303: many packages on a single host, and can be invoked from
7304: the top-level pkgsrc Makefile by using the
1.87 wiz 7305: “<span class="quote">show-host-specific-pkgs</span>” target.</p></dd>
1.75 rillig 7306: <dt><span class="term">show-installed-depends</span></dt>
1.88 wiz 7307: <dd><p>This target shows which installed packages match
7308: the current package's <code class="varname">DEPENDS</code>. Useful
7309: if out of date dependencies are causing build
7310: problems.</p></dd>
1.75 rillig 7311: <dt><span class="term">check-shlibs</span></dt>
1.88 wiz 7312: <dd><p>After a package is installed, check all its
7313: binaries and (on ELF platforms) shared libraries to see
7314: if they find the shared libs they need. Run by default
1.110 hubertf 7315: if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75 rillig 7316: <dt><span class="term">print-PLIST</span></dt>
7317: <dd>
7318: <p>After a “<span class="quote">make install</span>” from a new or
1.88 wiz 7319: upgraded pkg, this prints out an attempt to generate a
1.110 hubertf 7320: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88 wiz 7321: -newer work/.extract_done</strong></span>. An attempt is made
7322: to care for shared libs etc., but it is
1.87 wiz 7323: <span class="emphasis"><em>strongly</em></span> recommended to review the
7324: result before putting it into
7325: <code class="filename">PLIST</code>. On upgrades, it's useful to
7326: diff the output of this command against an already
7327: existing <code class="filename">PLIST</code> file.</p>
1.110 hubertf 7328: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88 wiz 7329: other methods that don't update file access times, be
7330: sure to add these files manually to your
1.87 wiz 7331: <code class="filename">PLIST</code>, as the “<span class="quote">find
7332: -newer</span>” command used by this target won't catch
7333: them!</p>
1.110 hubertf 7334: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, “Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>”</a> for more
1.87 wiz 7335: information on this target.</p>
1.75 rillig 7336: </dd>
7337: <dt><span class="term">bulk-package</span></dt>
7338: <dd>
1.88 wiz 7339: <p>Used to do bulk builds. If an appropriate binary
7340: package already exists, no action is taken. If not, this
7341: target will compile, install and package it (and its
7342: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110 hubertf 7343: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.88 wiz 7344: After creating the binary package, the sources, the
7345: just-installed package and its required packages are
7346: removed, preserving free disk space.</p>
7347: <p><span class="emphasis"><em>Beware that this target may deinstall
7348: all packages installed on a system!</em></span></p>
1.75 rillig 7349: </dd>
7350: <dt><span class="term">bulk-install</span></dt>
7351: <dd>
1.88 wiz 7352: <p>Used during bulk-installs to install required
7353: packages. If an up-to-date binary package is available,
1.110 hubertf 7354: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
7355: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87 wiz 7356: but the installed binary won't be removed.</p>
1.88 wiz 7357: <p>A binary package is considered
7358: “<span class="quote">up-to-date</span>” to be installed via
1.110 hubertf 7359: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.88 wiz 7360: <div class="itemizedlist"><ul type="disc">
7361: <li><p>None of the package's files
7362: (<code class="filename">Makefile</code>, ...) were modified
7363: since it was built.</p></li>
7364: <li><p>None of the package's required (binary)
7365: packages were modified since it was built.</p></li>
1.75 rillig 7366: </ul></div>
1.88 wiz 7367: <p><span class="emphasis"><em>Beware that this target may deinstall
7368: all packages installed on a system!</em></span></p>
1.75 rillig 7369: </dd>
7370: </dl></div>
7371: </div>
7372: </div>
7373: <div class="chapter" lang="en">
7374: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7375: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75 rillig 7376: <div class="toc">
7377: <p><b>Table of Contents</b></p>
7378: <dl>
1.106 rillig 7379: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7380: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7381: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7382: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75 rillig 7383: </dl>
7384: </div>
1.87 wiz 7385: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75 rillig 7386: by pkgsrc and also for individual packages to define what commands
7387: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7388: or for later run-time of an installed packaged (such as
7389: <code class="varname">DEPENDS</code>).
7390: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87 wiz 7391: package will not be used.</p>
7392: <p>When building a package, the replacement tools are
1.75 rillig 7393: made available in a directory (as symlinks or wrapper scripts)
7394: that is early in the executable search path. Just like the buildlink
1.87 wiz 7395: system, this helps with consistent builds.</p>
7396: <p>A tool may be needed to help build a specific package. For example,
7397: perl, GNU make (gmake) or yacc may be needed.</p>
7398: <p>Also a tool may be needed, for example, because the native system's supplied
1.75 rillig 7399: tool may be inefficient for building a package with pkgsrc.
7400: For example, a package may need GNU awk, bison (instead of
1.87 wiz 7401: yacc) or a better sed.</p>
7402: <p>The tools used by a package can be listed by running
1.110 hubertf 7403: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75 rillig 7404: <div class="sect1" lang="en">
7405: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7406: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87 wiz 7407: <p>The default set of tools used by pkgsrc is defined in
1.76 rillig 7408: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110 hubertf 7409: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7410: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75 rillig 7411: These can be seen by running:
1.110 hubertf 7412: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87 wiz 7413: <p>If a package needs a specific program to build
1.75 rillig 7414: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87 wiz 7415: to define the tools needed.</p>
1.75 rillig 7416: </div>
7417: <div class="sect1" lang="en">
7418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7419: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87 wiz 7420: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75 rillig 7421: and not the native version for a build dependency.
7422: And the :run means that it is used for a
7423: run-time dependencies also (and becomes a DEPENDS).
7424: The default is a build dependency which can be set with
7425: :build. (So in this example, it is the same as gmake:build
1.87 wiz 7426: and pkg-config:build.)</p>
1.75 rillig 7427: <pre class="programlisting">
7428: USE_TOOLS+= mktemp:pkgsrc
7429: USE_TOOLS+= gmake perl:run pkg-config
7430: </pre>
1.87 wiz 7431: <p>When using the tools framework, a
1.75 rillig 7432: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7433: which contains the full path to the appropriate tool. For example,
7434: <code class="varname">TOOLS_PATH.bash</code> could be “<span class="quote">/bin/bash</span>”
1.87 wiz 7435: on Linux systems.</p>
7436: <p>If you always need a pkgsrc version of the
1.75 rillig 7437: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7438: </p>
7439: </div>
7440: <div class="sect1" lang="en">
7441: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7442: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87 wiz 7443: <p>When improving or porting pkgsrc to a new platform, have a look
1.75 rillig 7444: at (or create) the corresponding platform specific make file fragment under
1.76 rillig 7445: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75 rillig 7446: the name of the common tools. For example:</p>
7447: <pre class="programlisting">
7448: .if exists(/usr/bin/bzcat)
7449: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7450: .elif exists(/usr/bin/bzip2)
7451: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7452: .endif
1.69 rillig 7453:
1.75 rillig 7454: TOOLS_PLATFORM.true?= true # shell builtin
7455: </pre>
7456: </div>
1.97 rillig 7457: <div class="sect1" lang="en">
7458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7459: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97 rillig 7460: <div class="qandaset">
7461: <dl>
1.106 rillig 7462: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97 rillig 7463: </dt>
1.106 rillig 7464: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97 rillig 7465: tools?</a>
7466: </dt>
1.106 rillig 7467: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97 rillig 7468: package is using while being built? I want to know whether it
7469: uses sed or not.</a>
7470: </dt>
7471: </dl>
7472: <table border="0" summary="Q and A Set">
7473: <col align="left" width="1%">
7474: <tbody>
7475: <tr class="question">
7476: <td align="left" valign="top">
1.112 ! weinem 7477: <a name="tools.new"></a><a name="id2727789"></a><p><b>18.4.1.</b></p>
1.97 rillig 7478: </td>
7479: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7480: </tr>
7481: <tr class="answer">
7482: <td align="left" valign="top"></td>
7483: <td align="left" valign="top"><p>TODO</p></td>
7484: </tr>
7485: <tr class="question">
7486: <td align="left" valign="top">
1.112 ! weinem 7487: <a name="tools.listall"></a><a name="id2727799"></a><p><b>18.4.2.</b></p>
1.97 rillig 7488: </td>
7489: <td align="left" valign="top"><p>How do I get a list of all available
7490: tools?</p></td>
7491: </tr>
7492: <tr class="answer">
7493: <td align="left" valign="top"></td>
7494: <td align="left" valign="top"><p>TODO</p></td>
7495: </tr>
7496: <tr class="question">
7497: <td align="left" valign="top">
1.112 ! weinem 7498: <a name="tools.used"></a><a name="id2727810"></a><p><b>18.4.3.</b></p>
1.97 rillig 7499: </td>
7500: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7501: package is using while being built? I want to know whether it
7502: uses sed or not.</p></td>
7503: </tr>
7504: <tr class="answer">
7505: <td align="left" valign="top"></td>
7506: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7507: to do it.)</p></td>
7508: </tr>
7509: </tbody>
7510: </table>
7511: </div>
7512: </div>
1.75 rillig 7513: </div>
7514: <div class="chapter" lang="en">
7515: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 7516: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75 rillig 7517: <div class="toc">
7518: <p><b>Table of Contents</b></p>
7519: <dl>
1.106 rillig 7520: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75 rillig 7521: <dd><dl>
1.106 rillig 7522: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
7523: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
7524: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7525: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7526: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7527: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7528: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7529: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7530: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7531: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7532: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7533: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7534: </dl></dd>
7535: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7536: <dd><dl>
7537: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7538: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
7539: </dl></dd>
7540: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7541: <dd><dl>
7542: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7543: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7544: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7545: </dl></dd>
7546: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7547: <dd><dl>
7548: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7549: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7550: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7551: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7552: </dl></dd>
7553: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7554: <dd><dl>
7555: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7556: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
7557: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to “<span class="quote">...</span>”</a></span></dt>
7558: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7559: </dl></dd>
7560: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7561: <dd><dl>
7562: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7563: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7564: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7565: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7566: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7567: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7568: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7569: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107 rillig 7570: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.106 rillig 7571: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
7572: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7573: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7574: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7575: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7576: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7577: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7578: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7579: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87 wiz 7580: emulation</a></span></dt>
1.106 rillig 7581: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7582: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75 rillig 7583: </dl></dd>
1.106 rillig 7584: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75 rillig 7585: </dl>
7586: </div>
7587: <div class="sect1" lang="en">
7588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 7589: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75 rillig 7590: <div class="sect2" lang="en">
7591: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7592: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78 rillig 7593: <p>One appealing feature of pkgsrc is that it runs on many
1.87 wiz 7594: different platforms. As a result, it is important to ensure,
7595: where possible, that packages in pkgsrc are portable. This
7596: chapter mentions some particular details you should pay
7597: attention to while working on pkgsrc.</p>
1.78 rillig 7598: </div>
7599: <div class="sect2" lang="en">
7600: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 7601: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93 rillig 7602: </h3></div></div></div>
1.78 rillig 7603: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87 wiz 7604: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110 hubertf 7605: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87 wiz 7606: want to use those variables in the preprocessor directives of
1.110 hubertf 7607: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87 wiz 7608: <code class="literal">.for</code>), you need to include the file
7609: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7610: loads the user preferences.</p>
1.78 rillig 7611: <p>But note that some variables may not be completely defined
1.87 wiz 7612: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7613: included, as they may contain references to variables that are
7614: not yet defined. In shell commands this is no problem, since
7615: variables are actually macros, which are only expanded when they
7616: are used. But in the preprocessor directives mentioned above and
7617: in dependency lines (of the form <code class="literal">target:
7618: dependencies</code>) the variables are expanded at load
7619: time.</p>
1.78 rillig 7620: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
7621: <h3 class="title">Note</h3>
7622: <p>Currently there is no exhaustive list of all
1.87 wiz 7623: variables that tells you whether they can be used at load time
7624: or only at run time, but it is in preparation.</p>
1.78 rillig 7625: </div>
7626: </div>
7627: <div class="sect2" lang="en">
7628: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7629: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88 wiz 7630: <p>Occasionally, packages require interaction from the user,
7631: and this can be in a number of ways:</p>
1.78 rillig 7632: <div class="itemizedlist"><ul type="disc">
1.79 rillig 7633: <li><p>When fetching the distfiles, some packages require user
1.87 wiz 7634: interaction such as entering username/password or accepting a
7635: license on a web page.</p></li>
1.88 wiz 7636: <li><p>When extracting the distfiles, some packages may ask for
7637: passwords.</p></li>
1.78 rillig 7638: <li><p>help to configure the package before it is built</p></li>
7639: <li><p>help during the build process</p></li>
7640: <li><p>help during the installation of a package</p></li>
7641: </ul></div>
1.88 wiz 7642: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7643: provided to notify the pkgsrc mechanism of an interactive stage
7644: which will be needed, and this should be set in the package's
7645: <code class="filename">Makefile</code>, e.g.:</p>
1.75 rillig 7646: <pre class="programlisting">
1.100 rillig 7647: INTERACTIVE_STAGE= build
1.87 wiz 7648: </pre>
1.78 rillig 7649: <p>Multiple interactive stages can be specified:</p>
1.75 rillig 7650: <pre class="programlisting">
1.100 rillig 7651: INTERACTIVE_STAGE= configure install
1.87 wiz 7652: </pre>
1.88 wiz 7653: <p>The user can then decide to skip this package by setting the
7654: <code class="varname">BATCH</code> variable.</p>
1.75 rillig 7655: </div>
7656: <div class="sect2" lang="en">
7657: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7658: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98 wiz 7659: <p>Authors of software can choose the licence under which
7660: software can be copied. This is due to copyright law, and reasons
7661: for license choices are outside the scope of pkgsrc. The pkgsrc
7662: system recognizes that there are a number of licenses which some
7663: users may find objectionable or difficult or impossible to comply
7664: with. The Free Software Foundation has declared some licenses
7665: "Free", and the Open Source Initiative has a definition of "Open
7666: Source". The pkgsrc system, as a policy choice, does not label
7667: packages which have licenses that are Free or Open Source.
7668: However, packages without a license meeting either of those tests
7669: are labeled with a license tag denoting the license. Note that a
7670: package with no license to copy trivially does not meet either the
7671: Free or Open Source test.</p>
7672: <p>For packages which are not Free or Open Source, pkgsrc will
7673: not build the package unless the user has indicated to pkgsrc that
7674: packages with that particular license may be built. Note that
7675: this documentation avoids the term "accepted the license". The
7676: pkgsrc system is merely providing a mechanism to avoid
1.99 rillig 7677: accidentally building a package with a non-free license;
1.98 wiz 7678: judgement and responsibility remain with the user. (Installation
7679: of binary packages are not currently subject to this mechanism;
7680: this is a bug.)</p>
7681: <p>One might want to only install packages with a BSD license,
7682: or the GPL, and not the other. The pkgsrc license tag mechanism
7683: does not provide a way to do this. It might be possible to put in
7684: tags for free licenses, and have a default
7685: <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
7686: widely viewed as having a very poor ratio of benefit to
7687: work.</p>
1.78 rillig 7688: <p>The license tag mechanism is intended to address
1.87 wiz 7689: copyright-related issues surrounding building, installing and
7690: using a package, and not to address redistribution issues (see
7691: <code class="varname">RESTRICTED</code> and
7692: <code class="varname">NO_SRC_ON_FTP</code>, etc.). However, the above
7693: definition of licenses for which tags are not needed implies
7694: that packages with redistribution restrictions should have
1.98 wiz 7695: tags, because Free or Open Source programs do not have
7696: redistribution restrictions.</p>
7697: <p>Denoting that a package may be copied according to a
7698: particular license is done by placing the license in
1.87 wiz 7699: <code class="filename">pkgsrc/licenses</code> and setting the
7700: <code class="varname">LICENSE</code> variable to a string identifying the
1.91 rillig 7701: 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 7702: <pre class="programlisting">
1.100 rillig 7703: LICENSE= xv-license
1.87 wiz 7704: </pre>
7705: <p>When trying to build, the user will get a notice that the
1.98 wiz 7706: package is covered by a license which has not been placed in the
7707: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87 wiz 7708: <pre class="programlisting">
1.100 rillig 7709: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7710: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7711: ===> To view the license, enter "/usr/bin/make show-license".
7712: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7713: ===> ACCEPTABLE_LICENSES+=xv-license
7714: *** Error code 1
1.87 wiz 7715: </pre>
1.110 hubertf 7716: <p>The license can be viewed with <span class="command"><strong>make
1.98 wiz 7717: show-license</strong></span>, and if the user so chooses, the line
1.110 hubertf 7718: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98 wiz 7719: convey to pkgsrc that it should not in the future fail because of
7720: that license:</p>
1.78 rillig 7721: <pre class="programlisting">
1.100 rillig 7722: ACCEPTABLE_LICENSES+=xv-license
1.87 wiz 7723: </pre>
1.98 wiz 7724: <p>When adding a package with a new license, the license text
7725: should be added to <code class="filename">pkgsrc/licenses</code> for
7726: displaying. A list of known licenses can be seen in this
1.91 rillig 7727: directory.</p>
1.98 wiz 7728: <p>When the license changes (in a way other than formatting),
7729: please make sure that the new license has a different name (e.g.,
7730: append the version number if it exists, or the date). Just
7731: because a user told pkgsrc to build programs under a previous
7732: version of a license does not mean that pkgsrc should build
1.99 rillig 7733: programs under the new licenses. The higher-level point is that
1.98 wiz 7734: pkgsrc does not evaluate licenses for reasonableness; the only
7735: test is a mechanistic test of whether a particular text has been
7736: approved by either of two bodies.</p>
1.78 rillig 7737: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98 wiz 7738: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7739: is deprecated because it does not crisply refer to a particular
7740: license text. Another problem with such usage is that it does not
7741: enable a user to tell pkgsrc to proceed for a single package
7742: without also telling pkgsrc to proceed for all packages with that
7743: tag.</p>
1.75 rillig 7744: </div>
7745: <div class="sect2" lang="en">
7746: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7747: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75 rillig 7748: <p>Some licenses restrict how software may be re-distributed.
1.98 wiz 7749: Because a license tag is required unless the package is Free or
7750: Open Source, all packages with restrictions should have license
7751: tags. By declaring the restrictions, package tools can
7752: automatically refrain from e.g. placing binary packages on FTP
7753: sites.</p>
7754: <p>There are four restrictions that may be encoded, which are
7755: the cross product of sources (distfiles) and binaries not being
7756: placed on FTP sites and CD-ROMs. Because this is rarely the exact
7757: language in any license, and because non-Free licenses tend to be
7758: different from each other, pkgsrc adopts a definition of FTP and
7759: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
7760: should not be made available over the Internet at no charge.
7761: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7762: made available on some kind of media, together with other source
7763: and binary packages, and which is sold for a distribution charge.
7764: </p>
7765: <p>In order to encode these restrictions, the package system
1.87 wiz 7766: defines five make variables that can be set to note these
7767: restrictions:</p>
1.75 rillig 7768: <div class="itemizedlist"><ul type="disc">
7769: <li>
7770: <p><code class="varname">RESTRICTED</code></p>
7771: <p>This variable should be set whenever a restriction
1.87 wiz 7772: exists (regardless of its kind). Set this variable to a
1.98 wiz 7773: string containing the reason for the restriction. It should
7774: be understood that those wanting to understand the restriction
7775: will have to read the license, and perhaps seek advice of
7776: counsel.</p>
1.75 rillig 7777: </li>
7778: <li>
7779: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98 wiz 7780: <p>Binaries may not be placed on CD-ROM containing other
7781: binary packages, for which a distribution charge may be made.
7782: In this case, set this variable to
7783: <code class="varname">${RESTRICTED}</code>.</p>
1.75 rillig 7784: </li>
7785: <li>
7786: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98 wiz 7787: <p>Binaries may not made available on the Internet without
7788: charge. In this case, set this variable to
7789: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7790: binary packages will not be included on ftp.NetBSD.org.</p>
1.75 rillig 7791: </li>
7792: <li>
7793: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98 wiz 7794: <p>Distfiles may not be placed on CD-ROM, together with
7795: other distfiles, for which a fee may be charged. In this
7796: case, set this variable to <code class="varname">${RESTRICTED}</code>.
7797: </p>
1.75 rillig 7798: </li>
7799: <li>
7800: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98 wiz 7801: <p>Distfiles may not made available via FTP at no charge.
7802: In this case, set this variable to
7803: <code class="varname">${RESTRICTED}</code>. If this variable is set,
7804: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75 rillig 7805: </li>
7806: </ul></div>
7807: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87 wiz 7808: <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
7809: generic make variables to denote restrictions is deprecated,
7810: because they unconditionally prevent users from generating
7811: binary packages!</p>
1.75 rillig 7812: </div>
7813: <div class="sect2" lang="en">
7814: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7815: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75 rillig 7816: <p>Your package may depend on some other package being present
1.88 wiz 7817: - and there are various ways of expressing this dependency.
7818: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7819: <code class="varname">DEPENDS</code> definitions, the
7820: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7821: via <code class="filename">buildlink3.mk</code>, which is the preferred way
7822: to handle dependencies, and which uses the variables named above.
1.110 hubertf 7823: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75 rillig 7824: <p>The basic difference between the two variables is as
1.87 wiz 7825: follows: The <code class="varname">DEPENDS</code> definition registers
7826: that pre-requisite in the binary package so it will be pulled in
7827: when the binary package is later installed, whilst the
7828: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7829: dependency that is only needed for building the package.</p>
1.75 rillig 7830: <p>This means that if you only need a package present whilst
1.87 wiz 7831: you are building, it should be noted as a
7832: <code class="varname">BUILD_DEPENDS</code>.</p>
1.75 rillig 7833: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87 wiz 7834: <code class="varname">DEPENDS</code> definition is:</p>
1.75 rillig 7835: <pre class="programlisting">
1.100 rillig 7836: <pre-req-package-name>:../../<category>/<pre-req-package>
1.87 wiz 7837: </pre>
1.75 rillig 7838: <p>Please note that the “<span class="quote">pre-req-package-name</span>”
1.87 wiz 7839: may include any of the wildcard version numbers recognized by
1.110 hubertf 7840: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75 rillig 7841: <div class="orderedlist"><ol type="1">
7842: <li>
7843: <p>If your package needs another package's binaries or
1.87 wiz 7844: libraries to build or run, and if that package has a
7845: <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75 rillig 7846: <pre class="programlisting">
1.100 rillig 7847: .include "../../graphics/jpeg/buildlink3.mk"
1.87 wiz 7848: </pre>
1.75 rillig 7849: </li>
7850: <li>
7851: <p>If your package needs to use another package to build
1.87 wiz 7852: itself and there is no <code class="filename">buildlink3.mk</code>
7853: file available, use the <code class="varname">BUILD_DEPENDS</code>
7854: definition:</p>
1.75 rillig 7855: <pre class="programlisting">
1.100 rillig 7856: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87 wiz 7857: </pre>
1.75 rillig 7858: </li>
7859: <li>
7860: <p>If your package needs a library with which to link and
1.76 rillig 7861: again there is no <code class="filename">buildlink3.mk</code> file
1.87 wiz 7862: available, this is specified using the
7863: <code class="varname">DEPENDS</code> definition. For example:</p>
1.75 rillig 7864: <pre class="programlisting">
1.100 rillig 7865: DEPENDS+= xpm-3.4j:../../graphics/xpm
1.87 wiz 7866: </pre>
1.109 rillig 7867: <p>You can also use wildcards in package dependencies:</p>
1.75 rillig 7868: <pre class="programlisting">
1.100 rillig 7869: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
1.87 wiz 7870: </pre>
1.75 rillig 7871: <p>Note that such wildcard dependencies are retained when
1.87 wiz 7872: creating binary packages. The dependency is checked when
7873: installing the binary package and any package which matches
7874: the pattern will be used. Wildcard dependencies should be
7875: used with care.</p>
1.75 rillig 7876: <p>The “<span class="quote">-[0-9]*</span>” should be used instead of
1.87 wiz 7877: “<span class="quote">-*</span>” to avoid potentially ambiguous matches
7878: such as “<span class="quote">tk-postgresql</span>” matching a
7879: “<span class="quote">tk-*</span>” <code class="varname">DEPENDS</code>.</p>
1.75 rillig 7880: <p>Wildcards can also be used to specify that a package
1.87 wiz 7881: will only build against a certain minimum version of a
7882: pre-requisite:</p>
1.75 rillig 7883: <pre class="programlisting">
1.100 rillig 7884: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
1.87 wiz 7885: </pre>
1.75 rillig 7886: <p>This means that the package will build against version
1.87 wiz 7887: 3.5.4 of the tiff library or newer. Such a dependency may
7888: be warranted if, for example, the API of the library has
7889: changed with version 3.5.4 and a package would not compile
7890: against an earlier version of tiff.</p>
1.75 rillig 7891: <p>Please note that such dependencies should only be
1.87 wiz 7892: updated if a package requires a newer pre-requisite, but
1.93 rillig 7893: not to denote recommendations such as
1.87 wiz 7894: ABI changes that do not prevent a package from building
7895: correctly. Such recommendations can be expressed using
7896: <code class="varname">ABI_DEPENDS</code>:</p>
1.75 rillig 7897: <pre class="programlisting">
1.100 rillig 7898: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
1.87 wiz 7899: </pre>
1.75 rillig 7900: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87 wiz 7901: line, this denotes that while a package will build against
7902: tiff>=3.5.4, at least version 3.6.1 is recommended.
7903: <code class="varname">ABI_DEPENDS</code> entries will be turned into
7904: dependencies unless explicitly ignored (in which case a
7905: warning will be printed).</p>
1.75 rillig 7906: <p>To ignore these ABI dependency recommendations and just
1.87 wiz 7907: use the required <code class="varname">DEPENDS</code>, set
7908: <code class="varname">USE_ABI_DEPENDS=NO</code>. This may make
7909: it easier and faster to update packages built using pkgsrc,
7910: since older compatible dependencies can continue to be
7911: used. This is useful for people who watch their rebuilds
7912: very carefully; it is not very good as a general-purpose
7913: hammer. If you use it, you need to be mindful of possible
7914: ABI changes, including those from the underlying OS.</p>
1.75 rillig 7915: <p>Packages that are built with recommendations ignored
1.87 wiz 7916: may not be uploaded to ftp.NetBSD.org by developers and
7917: should not be used across different systems that may have
7918: different versions of binary packages installed.</p>
1.75 rillig 7919: <p>For security fixes, please update the package
1.110 hubertf 7920: vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, “Handling packages with security problems”</a> for more
1.87 wiz 7921: information.</p>
1.75 rillig 7922: </li>
7923: <li>
7924: <p>If your package needs some executable to be able to run
1.87 wiz 7925: correctly and if there's no
7926: <code class="filename">buildlink3.mk</code> file, this is specified
7927: using the <code class="varname">DEPENDS</code> variable. The
1.91 rillig 7928: <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 7929: be able to execute the latex binary from the teTeX package
7930: when it runs, and that is specified:</p>
1.75 rillig 7931: <pre class="programlisting">
1.100 rillig 7932: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.87 wiz 7933: </pre>
1.75 rillig 7934: <p>The comment about wildcard dependencies from previous
1.87 wiz 7935: paragraph applies here, too.</p>
1.75 rillig 7936: </li>
7937: </ol></div>
7938: <p>If your package needs files from another package to build,
1.87 wiz 7939: add the relevant distribution files to
7940: <code class="varname">DISTFILES</code>, so they will be extracted
1.91 rillig 7941: 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 7942: (It relies on the jpeg sources being present in source form
7943: during the build.)</p>
1.75 rillig 7944: </div>
7945: <div class="sect2" lang="en">
7946: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7947: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75 rillig 7948: <p>Your package may conflict with other packages a user might
1.87 wiz 7949: already have installed on his system, e.g. if your package
1.88 wiz 7950: installs the same set of files as another package in the pkgsrc
7951: tree.</p>
1.75 rillig 7952: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87 wiz 7953: space-separated list of packages (including version string) your
7954: package conflicts with.</p>
1.91 rillig 7955: <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>
7956: 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 7957: install the same shared library, thus you set in
7958: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
7959: <pre class="programlisting">
1.100 rillig 7960: CONFLICTS= Xaw-Xpm-[0-9]*
1.87 wiz 7961: </pre>
7962: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75 rillig 7963: <pre class="programlisting">
1.100 rillig 7964: CONFLICTS= Xaw3d-[0-9]*
1.87 wiz 7965: </pre>
1.75 rillig 7966: <p>Packages will automatically conflict with other packages
1.87 wiz 7967: with the name prefix and a different version
7968: string. “<span class="quote">Xaw3d-1.5</span>” e.g. will automatically
7969: conflict with the older version “<span class="quote">Xaw3d-1.3</span>”.</p>
1.75 rillig 7970: </div>
7971: <div class="sect2" lang="en">
7972: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 7973: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75 rillig 7974: <p>There are several reasons why a package might be
1.88 wiz 7975: instructed to not build under certain circumstances. If the
1.87 wiz 7976: package builds and runs on most platforms, the exceptions
7977: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
7978: the package builds and runs on a small handful of platforms,
7979: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
7980: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
7981: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
7982: (OS-version-platform) that can use glob-style
7983: wildcards.</p>
1.88 wiz 7984: <p>Some packages are tightly bound to a specific version of an
1.91 rillig 7985: 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 7986: backwards compatible with other versions of the OS, and should be
7987: uploaded to a version specific directory on the FTP server. Mark
7988: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
7989: “<span class="quote">yes</span>”. This variable is not currently used by any of
7990: the package system internals, but may be used in the
7991: future.</p>
1.75 rillig 7992: <p>If the package should be skipped (for example, because it
1.87 wiz 7993: provides functionality already provided by the system), set
1.88 wiz 7994: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
7995: the package should fail because some preconditions are not met,
7996: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87 wiz 7997: message.</p>
1.75 rillig 7998: </div>
7999: <div class="sect2" lang="en">
8000: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8001: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75 rillig 8002: <p>To ensure that a package may not be deleted, once it has been
1.87 wiz 8003: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8004: be set in the package Makefile. This will be carried into any
8005: binary package that is made from this pkgsrc entry. A
8006: “<span class="quote">preserved</span>” package will
1.110 hubertf 8007: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.87 wiz 8008: “<span class="quote">-f</span>” option is used.</p>
1.75 rillig 8009: </div>
8010: <div class="sect2" lang="en">
8011: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8012: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75 rillig 8013: <p>When a vulnerability is found, this should be noted in
1.87 wiz 8014: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110 hubertf 8015: and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87 wiz 8016: in the same directory to update the file on ftp.NetBSD.org.</p>
1.75 rillig 8017: <p>After fixing the vulnerability by a patch, its
1.87 wiz 8018: <code class="varname">PKGREVISION</code> should be increased (this
8019: is of course not necessary if the problem is fixed by using
8020: a newer release of the software).</p>
1.75 rillig 8021: <p>Also, if the fix should be applied to the stable pkgsrc
1.87 wiz 8022: branch, be sure to submit a pullup request!</p>
1.75 rillig 8023: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87 wiz 8024: semi-automatically by a weekly cron job.</p>
1.75 rillig 8025: </div>
8026: <div class="sect2" lang="en">
8027: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8028: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75 rillig 8029: <p>When making fixes to an existing package it can be useful
1.87 wiz 8030: to change the version number in <code class="varname">PKGNAME</code>. To
8031: avoid conflicting with future versions by the original author, a
8032: “<span class="quote">nb1</span>”, “<span class="quote">nb2</span>”, ... suffix can be used
8033: on package versions by setting <code class="varname">PKGREVISION=1</code>
8034: (2, ...). The “<span class="quote">nb</span>” is treated like a
8035: “<span class="quote">.</span>” by the package tools. e.g.</p>
8036: <pre class="programlisting">
1.100 rillig 8037: DISTNAME= foo-17.42
8038: PKGREVISION= 9
1.87 wiz 8039: </pre>
1.75 rillig 8040: <p>will result in a <code class="varname">PKGNAME</code> of
1.87 wiz 8041: “<span class="quote">foo-17.42nb9</span>”. If you want to use the original
8042: value of <code class="varname">PKGNAME</code> without the “<span class="quote">nbX</span>”
8043: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8044: <code class="varname">PKGNAME_NOREV</code>.</p>
1.75 rillig 8045: <p>When a new release of the package is released, the
1.87 wiz 8046: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8047: minor release of the above package, things should be like:</p>
1.75 rillig 8048: <pre class="programlisting">
1.100 rillig 8049: DISTNAME= foo-17.43
1.87 wiz 8050: </pre>
8051: <p><code class="varname">PKGREVISION</code> should be incremented for any
8052: non-trivial change in the resulting binary package. Without a
8053: <code class="varname">PKGREVISION</code> bump, someone with the previous
8054: version installed has no way of knowing that their package is out
8055: of date. Thus, changes without increasing
8056: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8057: trivial that no reasonable person would want to upgrade", and this
8058: is the rough test for when increasing
8059: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8060: changes that do not merit increasing
8061: <code class="varname">PKGREVISION</code> are:</p>
1.100 rillig 8062: <div class="itemizedlist"><ul type="disc">
8063: <li><p>Changing <code class="varname">HOMEPAGE</code>, <code class="varname">MAINTAINER</code>,
8064: or comments in Makefile.</p></li>
8065: <li><p>
8066: Changing build variables if the resulting binary package is the same.</p></li>
8067: <li><p>
8068: Changing <code class="filename">DESCR</code>.</p></li>
8069: <li><p>
8070: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8071: </ul></div>
1.87 wiz 8072: <p>Examples of changes that do merit an increase to
8073: <code class="varname">PKGREVISION</code> include:</p>
1.100 rillig 8074: <div class="itemizedlist"><ul type="disc">
8075: <li><p>
8076: Security fixes</p></li>
8077: <li><p>
8078: Changes or additions to a patch file</p></li>
8079: <li><p>
8080: Changes to the <code class="filename">PLIST</code></p></li>
1.112 ! weinem 8081: <li><p>A dependency is changed or renamed.</p></li>
1.100 rillig 8082: </ul></div>
1.78 rillig 8083: <p>PKGREVISION must also be incremented when dependencies have ABI
8084: changes.</p>
1.75 rillig 8085: </div>
1.79 rillig 8086: <div class="sect2" lang="en">
8087: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8088: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79 rillig 8089: <p>When you want to replace the same text in multiple files
1.87 wiz 8090: or when the replacement text varies, patches alone cannot help.
8091: This is where the SUBST framework comes in. It provides an
8092: easy-to-use interface for replacing text in files.
8093: Example:</p>
8094: <pre class="programlisting">
1.100 rillig 8095: SUBST_CLASSES+= fix-paths
8096: SUBST_STAGE.fix-paths= pre-configure
8097: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8098: SUBST_FILES.fix-paths= src/*.c
8099: SUBST_FILES.fix-paths+= scripts/*.sh
8100: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8101: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
1.87 wiz 8102: </pre>
1.79 rillig 8103: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87 wiz 8104: that are used to identify the different SUBST blocks that are
8105: defined. The SUBST framework is heavily used by pkgsrc, so it is
8106: important to always use the <code class="literal">+=</code> operator with
8107: this variable. Otherwise some substitutions may be
8108: skipped.</p>
1.79 rillig 8109: <p>The remaining variables of each SUBST block are
1.87 wiz 8110: parameterized with the identifier from the first line
8111: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8112: parameters to a function call.</p>
1.79 rillig 8113: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87 wiz 8114: which the replacement will take place. All combinations of
8115: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8116: <code class="literal">post-</code> together with a phase name are
8117: possible, though only few are actually used. Most commonly used
8118: are <code class="literal">post-patch</code> and
8119: <code class="literal">pre-configure</code>. Of these two,
8120: <code class="literal">pre-configure</code> should be preferred because
1.110 hubertf 8121: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87 wiz 8122: have the state after applying the patches but before making any
8123: other changes. This is especially useful when you are debugging
8124: a package in order to create new patches for it. Similarly,
8125: <code class="literal">post-build</code> is preferred over
8126: <code class="literal">pre-install</code>, because the install phase should
8127: generally be kept as simple as possible. When you use
8128: <code class="literal">post-build</code>, you have the same files in the
8129: working directory that will be installed later, so you can check
8130: if the substitution has succeeded.</p>
1.79 rillig 8131: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87 wiz 8132: that is printed just before the substitution is done.</p>
1.79 rillig 8133: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87 wiz 8134: globbing patterns that specifies the files in which the
8135: substitution will take place. The patterns are interpreted
8136: relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79 rillig 8137: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110 hubertf 8138: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87 wiz 8139: command should be prefixed with <code class="literal">-e</code>, so that
8140: all SUBST blocks look uniform.</p>
1.79 rillig 8141: <p>There are some more variables, but they are so seldomly
1.87 wiz 8142: used that they are only documented in the
8143: <code class="filename">mk/subst.mk</code> file.</p>
1.79 rillig 8144: </div>
1.75 rillig 8145: </div>
8146: <div class="sect1" lang="en">
8147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8148: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75 rillig 8149: <div class="sect2" lang="en">
8150: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8151: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75 rillig 8152: <p>If you need to download from a dynamic URL you can set
1.110 hubertf 8153: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87 wiz 8154: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8155: with the name of each file to download as an argument, expecting
8156: it to output the URL of the directory from which to download
1.91 rillig 8157: 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 8158: example of this usage.</p>
1.75 rillig 8159: <p>If the download can't be automated, because the user must
1.87 wiz 8160: submit personal information to apply for a password, or must pay
8161: for the source, or whatever, you can set
8162: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8163: displayed to the user before aborting the build. Example:</p>
8164: <pre class="programlisting">
1.100 rillig 8165: FETCH_MESSAGE= "Please download the files"
8166: FETCH_MESSAGE+= " "${DISTFILES:Q}
8167: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87 wiz 8168: </pre>
1.75 rillig 8169: </div>
8170: <div class="sect2" lang="en">
8171: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8172: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75 rillig 8173: <p>Sometimes authors of a software package make some
1.87 wiz 8174: modifications after the software was released, and they put up a
8175: new distfile without changing the package's version number. If a
8176: package is already in pkgsrc at that time, the checksum will
8177: no longer match. The contents of the new distfile should be
8178: compared against the old one before changing anything, to make
8179: sure the distfile was really updated on purpose, and that
8180: no trojan horse or so crept in.
1.97 rillig 8181: Please mention that the distfiles were compared and what was found
8182: in your commit message.
1.87 wiz 8183: Then, the correct way to work around this is to
8184: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8185: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8186: <code class="varname">DISTFILES</code> and
1.93 rillig 8187: <code class="varname">PATCHFILES</code> for this package will be put in that
1.97 rillig 8188: subdirectory of the local distfiles directory.
1.110 hubertf 8189: (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, “How to handle incrementing versions when fixing an existing package”</a> for more details.)
1.97 rillig 8190: In case this
1.87 wiz 8191: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8192: including the <code class="filename">nbX</code> suffix) or a date stamp
8193: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8194: Do not forget regenerating the <code class="filename">distinfo</code> file
8195: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8196: path in the filenames.
1.97 rillig 8197: Also increase the PKGREVISION if the installed package is different.
1.87 wiz 8198: Furthermore, a mail to the package's authors seems appropriate
8199: telling them that changing distfiles after releases without
8200: changing the file names is not good practice.</p>
1.75 rillig 8201: </div>
8202: </div>
8203: <div class="sect1" lang="en">
8204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8205: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75 rillig 8206: <div class="sect2" lang="en">
8207: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8208: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75 rillig 8209: <p>pkgsrc supports many different machines, with different
1.87 wiz 8210: object formats like a.out and ELF, and varying abilities to do
8211: shared library and dynamic loading at all. To accompany this,
8212: varying commands and options have to be passed to the
8213: compiler, linker, etc. to get the Right Thing, which can be
8214: pretty annoying especially if you don't have all the machines
8215: at your hand to test things. The
1.91 rillig 8216: <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 8217: can help here, as it just “<span class="quote">knows</span>” how to build
8218: both static and dynamic libraries from a set of source files,
8219: thus being platform-independent.</p>
8220: <p>Here's how to use libtool in a package in seven simple
8221: steps:</p>
1.75 rillig 8222: <div class="orderedlist"><ol type="1">
8223: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87 wiz 8224: Makefile.</p></li>
1.75 rillig 8225: <li><p>For library objects, use “<span class="quote">${LIBTOOL} --mode=compile
1.87 wiz 8226: ${CC}</span>” in place of “<span class="quote">${CC}</span>”. You could even
8227: add it to the definition of <code class="varname">CC</code>, if only
8228: libraries are being built in a given Makefile. This one command
8229: will build both PIC and non-PIC library objects, so you need not
8230: have separate shared and non-shared library rules.</p></li>
1.75 rillig 8231: <li>
8232: <p>For the linking of the library, remove any
1.87 wiz 8233: “<span class="quote">ar</span>”, “<span class="quote">ranlib</span>”, and “<span class="quote">ld
8234: -Bshareable</span>” commands, and instead use:</p>
1.75 rillig 8235: <pre class="programlisting">
1.100 rillig 8236: ${LIBTOOL} --mode=link \
8237: ${CC} -o ${.TARGET:.a=.la} \
8238: ${OBJS:.o=.lo} \
8239: -rpath ${PREFIX}/lib \
8240: -version-info major:minor
1.87 wiz 8241: </pre>
1.75 rillig 8242: <p>Note that the library is changed to have a
1.87 wiz 8243: <code class="filename">.la</code> extension, and the objects are
8244: changed to have a <code class="filename">.lo</code>
8245: extension. Change <code class="varname">OBJS</code> as
8246: necessary. This automatically creates all of the
8247: <code class="filename">.a</code>,
8248: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8249: necessary) in the build directory. Be sure to include
8250: “<span class="quote">-version-info</span>”, especially when major and
8251: minor are zero, as libtool will otherwise strip off the
8252: shared library version.</p>
1.75 rillig 8253: <p>From the libtool manual:</p>
8254: <pre class="programlisting">
1.100 rillig 8255: So, libtool library versions are described by three integers:
1.69 rillig 8256:
1.100 rillig 8257: CURRENT
8258: The most recent interface number that this library implements.
1.69 rillig 8259:
1.100 rillig 8260: REVISION
8261: The implementation number of the CURRENT interface.
1.69 rillig 8262:
1.100 rillig 8263: AGE
8264: The difference between the newest and oldest interfaces that
8265: this library implements. In other words, the library implements
8266: all the interface numbers in the range from number `CURRENT -
8267: AGE' to `CURRENT'.
1.1 grant 8268:
1.100 rillig 8269: If two libraries have identical CURRENT and AGE numbers, then the
8270: dynamic linker chooses the library with the greater REVISION number.
1.87 wiz 8271: </pre>
1.75 rillig 8272: <p>The “<span class="quote">-release</span>” option will produce
1.87 wiz 8273: different results for a.out and ELF (excluding symlinks)
8274: in only one case. An ELF library of the form
8275: “<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8276: will have a symlink of
8277: “<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”
8278: on an a.out platform. This is handled
8279: automatically.</p>
1.75 rillig 8280: <p>The “<span class="quote">-rpath argument</span>” is the install
1.87 wiz 8281: directory of the library being built.</p>
1.76 rillig 8282: <p>In the <code class="filename">PLIST</code>, include only the
1.87 wiz 8283: <code class="filename">.la</code> file, the other files will be
8284: added automatically.</p>
1.75 rillig 8285: </li>
8286: <li>
1.76 rillig 8287: <p>When linking shared object (<code class="filename">.so</code>)
1.110 hubertf 8288: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.87 wiz 8289: shared libraries, use “<span class="quote">-module
8290: -avoid-version</span>” to prevent them getting version
8291: tacked on.</p>
1.76 rillig 8292: <p>The <code class="filename">PLIST</code> file gets the
1.87 wiz 8293: <code class="filename">foo.so</code> entry.</p>
1.75 rillig 8294: </li>
8295: <li>
8296: <p>When linking programs that depend on these libraries
1.87 wiz 8297: <span class="emphasis"><em>before</em></span> they are installed, preface
1.110 hubertf 8298: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with “<span class="quote">${LIBTOOL}
1.87 wiz 8299: --mode=link</span>”, and it will find the correct
8300: libraries (static or shared), but please be aware that
8301: libtool will not allow you to specify a relative path in
8302: -L (such as “<span class="quote">-L../somelib</span>”), because it
8303: expects you to change that argument to be the
8304: <code class="filename">.la</code> file. e.g.</p>
1.75 rillig 8305: <pre class="programlisting">
1.100 rillig 8306: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87 wiz 8307: </pre>
1.75 rillig 8308: <p>should be changed to:</p>
8309: <pre class="programlisting">
1.100 rillig 8310: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87 wiz 8311: </pre>
1.75 rillig 8312: <p>and it will do the right thing with the libraries.</p>
8313: </li>
8314: <li>
1.110 hubertf 8315: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8316: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with “<span class="quote">${LIBTOOL}
1.87 wiz 8317: --mode=install</span>”, and change the library name to
8318: <code class="filename">.la</code>. e.g.</p>
1.75 rillig 8319: <pre class="programlisting">
1.100 rillig 8320: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87 wiz 8321: </pre>
1.76 rillig 8322: <p>This will install the static <code class="filename">.a</code>,
1.87 wiz 8323: shared library, any needed symlinks, and run
1.110 hubertf 8324: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75 rillig 8325: </li>
1.76 rillig 8326: <li><p>In your <code class="filename">PLIST</code>, include only
1.87 wiz 8327: the <code class="filename">.la</code>
8328: file (this is a change from previous behaviour).</p></li>
1.75 rillig 8329: </ol></div>
8330: </div>
8331: <div class="sect2" lang="en">
8332: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8333: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75 rillig 8334: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87 wiz 8335: package Makefile. This will override the package's own libtool
8336: in most cases. For older libtool using packages, libtool is
8337: made by ltconfig script during the do-configure step; you can
1.110 hubertf 8338: check the libtool script location by doing <span class="command"><strong>make
1.87 wiz 8339: configure; find work*/ -name libtool</strong></span>.</p>
1.75 rillig 8340: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87 wiz 8341: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
8342: default, it is set to “<span class="quote">libtool */libtool
8343: */*/libtool</span>”. If this does not match the location of the
8344: package's libtool script(s), set it as appropriate.</p>
1.76 rillig 8345: <p>If you do not need <code class="filename">*.a</code> static
1.87 wiz 8346: libraries built and installed, then use
8347: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75 rillig 8348: <p>If your package makes use of the platform-independent library
1.87 wiz 8349: for loading dynamic shared objects, that comes with libtool
8350: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8351: <p>Some packages use libtool incorrectly so that the package
8352: may not work or build in some circumstances. Some of the more
8353: common errors are:</p>
1.75 rillig 8354: <div class="itemizedlist"><ul type="disc">
8355: <li>
8356: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87 wiz 8357: executable or library. This in itself isn't a problem if one of two things
8358: has been done:</p>
1.75 rillig 8359: <div class="orderedlist"><ol type="1">
8360: <li><p>The shared object is named correctly, i.e.
1.87 wiz 8361: <code class="filename">libfoo.la</code>, not
8362: <code class="filename">foo.la</code></p></li>
1.75 rillig 8363: <li><p>The -dlopen option is used when linking an executable.</p></li>
8364: </ol></div>
8365: </li>
8366: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87 wiz 8367: The function lt_dlinit() should be called and the macro
8368: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8369: executables.</p></li>
1.75 rillig 8370: </ul></div>
8371: </div>
8372: <div class="sect2" lang="en">
8373: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8374: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75 rillig 8375: <p>If a package needs GNU autoconf or automake to be executed
1.87 wiz 8376: to regenerate the configure script and Makefile.in makefile
8377: templates, then they should be executed in a pre-configure
8378: target.</p>
1.75 rillig 8379: <p>For packages that need only autoconf:</p>
8380: <pre class="programlisting">
1.100 rillig 8381: AUTOCONF_REQD= 2.50 # if default version is not good enough
8382: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8383: ...
1.1 grant 8384:
1.100 rillig 8385: pre-configure:
8386: cd ${WRKSRC} && autoconf
1.1 grant 8387:
1.100 rillig 8388: ...
1.87 wiz 8389: </pre>
1.75 rillig 8390: <p>and for packages that need automake and autoconf:</p>
8391: <pre class="programlisting">
1.100 rillig 8392: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8393: USE_TOOLS+= automake # use "automake14" for automake-1.4
8394: ...
8395:
8396: pre-configure:
8397: set -e; cd ${WRKSRC}; \
8398: aclocal; autoheader; automake -a --foreign -i; autoconf
1.1 grant 8399:
1.100 rillig 8400: ...
1.87 wiz 8401: </pre>
1.75 rillig 8402: <p>Packages which use GNU Automake will almost certainly
1.87 wiz 8403: require GNU Make.</p>
1.75 rillig 8404: <p>There are times when the configure process makes
1.87 wiz 8405: additional changes to the generated files, which then causes
8406: the build process to try to re-execute the automake sequence.
8407: This is prevented by touching various files in the configure
8408: stage. If this causes problems with your package you can set
8409: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8410: Makefile.</p>
1.75 rillig 8411: </div>
8412: </div>
8413: <div class="sect1" lang="en">
8414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8415: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87 wiz 8416: <div class="sect2" lang="en">
8417: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8418: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87 wiz 8419: <p>Compilers for the C, C++, and Fortran languages comes with
8420: the NetBSD base system. By default, pkgsrc assumes that a package
8421: is written in C and will hide all other compilers (via the wrapper
1.110 hubertf 8422: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87 wiz 8423: <p>To declare which language's compiler a package needs, set
8424: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8425: currently are “<span class="quote">c</span>”, “<span class="quote">c++</span>”, and
8426: “<span class="quote">fortran</span>” (and any combination). The default is
8427: “<span class="quote">c</span>”. Packages using GNU configure scripts, even if
8428: written in C++, usually need a C compiler for the configure
8429: phase.</p>
8430: </div>
8431: <div class="sect2" lang="en">
8432: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8433: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87 wiz 8434: <p>If a program is written in Java, use the Java framework in
8435: pkgsrc. The package must include
8436: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8437: provides the following variables:</p>
8438: <div class="itemizedlist"><ul type="disc">
8439: <li><p><code class="varname">USE_JAVA</code> defines if a build
8440: dependency on the JDK is added. If
8441: <code class="varname">USE_JAVA</code> is set to “<span class="quote">run</span>”, then
8442: there is only a runtime dependency on the JDK. The default is
8443: “<span class="quote">yes</span>”, which also adds a build dependency on the
8444: JDK.</p></li>
8445: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
8446: a package needs a Java2 implementation. The supported values
8447: are “<span class="quote">yes</span>”, “<span class="quote">1.4</span>”, and
8448: “<span class="quote">1.5</span>”. “<span class="quote">yes</span>” accepts any Java2
8449: implementation, “<span class="quote">1.4</span>” insists on versions 1.4 or
8450: above, and “<span class="quote">1.5</span>” only accepts versions 1.5 or
8451: above. This variable is not set by default.</p></li>
8452: </ul></div>
8453: </div>
8454: <div class="sect2" lang="en">
8455: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8456: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87 wiz 8457: <p>If your package contains interpreted perl scripts, add
8458: “<span class="quote">perl</span>” to the <code class="varname">USE_TOOLS</code> variable
8459: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8460: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8461: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8462: that you want adjusted. Every occurrence of
8463: <code class="filename">*/bin/perl</code> will be replaced with the full
8464: path to the perl executable.</p>
8465: <p>If a particular version of perl is needed, set the
8466: <code class="varname">PERL5_REQD</code> variable to the version number. The
8467: default is “<span class="quote">5.0</span>”.</p>
1.110 hubertf 8468: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, “Packages installing perl modules”</a> for information
1.87 wiz 8469: about handling perl modules.</p>
8470: </div>
8471: <div class="sect2" lang="en">
8472: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8473: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87 wiz 8474: <p>Currently, there is no special handling for other languages
8475: in pkgsrc. If a compiler package provides a
8476: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8477: just add a (build) dependency on the appropriate compiler
8478: package.</p>
8479: </div>
8480: </div>
8481: <div class="sect1" lang="en">
8482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8483: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77 rillig 8484: <p>The most common failures when building a package are that
8485: some platforms do not provide certain header files, functions or
8486: libraries, or they provide the functions in a library that the
8487: original package author didn't know. To work around this, you
8488: can rewrite the source code in most cases so that it does not
8489: use the missing functions or provides a replacement function.</p>
8490: <div class="sect2" lang="en">
8491: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8492: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77 rillig 8493: <p>If a package already comes with a GNU configure script, the
8494: preferred way to fix the build failure is to change the
8495: configure script, not the code. In the other cases, you can
8496: utilize the C preprocessor, which defines certain macros
8497: depending on the operating system and hardware architecture it
8498: compiles for. These macros can be queried using for example
8499: <code class="varname">#if defined(__i386)</code>. Almost every operating
8500: system, hardware architecture and compiler has its own macro.
8501: For example, if the macros <code class="varname">__GNUC__</code>,
8502: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8503: are all defined, you know that you are using NetBSD on an i386
8504: compatible CPU, and your compiler is GCC.</p>
8505: <p>The list of the following macros for hardware and
8506: operating system depends on the compiler that is used. For
8507: example, if you want to conditionally compile code on Solaris,
8508: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8509: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75 rillig 8510: <div class="sect3" lang="en">
8511: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8512: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75 rillig 8513: <p>To distinguish between 4.4 BSD-derived systems and the
8514: rest of the world, you should use the following code.</p>
8515: <pre class="programlisting">
1.100 rillig 8516: #include <sys/param.h>
8517: #if (defined(BSD) && BSD >= 199306)
8518: /* BSD-specific code goes here */
8519: #else
8520: /* non-BSD-specific code goes here */
8521: #endif
1.75 rillig 8522: </pre>
1.77 rillig 8523: <p>If this distinction is not fine enough, you can also test
8524: for the following macros.</p>
1.75 rillig 8525: <pre class="programlisting">
1.100 rillig 8526: FreeBSD __FreeBSD__
8527: DragonFly __DragonFly__
8528: Interix __INTERIX
8529: IRIX __sgi (TODO: get a definite source for this)
8530: Linux linux, __linux, __linux__
8531: NetBSD __NetBSD__
8532: OpenBSD __OpenBSD__
8533: Solaris sun, __sun
1.75 rillig 8534: </pre>
8535: </div>
8536: <div class="sect3" lang="en">
8537: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8538: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75 rillig 8539: <pre class="programlisting">
1.100 rillig 8540: i386 i386, __i386, __i386__
8541: MIPS __mips
8542: SPARC sparc, __sparc
1.75 rillig 8543: </pre>
8544: </div>
8545: <div class="sect3" lang="en">
8546: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8547: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75 rillig 8548: <pre class="programlisting">
1.100 rillig 8549: GCC __GNUC__ (major version), __GNUC_MINOR__
8550: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8551: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8552: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75 rillig 8553: </pre>
8554: </div>
8555: </div>
1.78 rillig 8556: <div class="sect2" lang="en">
8557: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8558: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78 rillig 8559: <p>Some source files trigger bugs in the compiler, based on
1.87 wiz 8560: combinations of compiler version and architecture and almost
8561: always relation to optimisation being enabled. Common symptoms
8562: are gcc internal errors or never finishing compiling a
1.78 rillig 8563: file.</p>
8564: <p>Typically, a workaround involves testing the
8565: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8566: optimisation for that combination of file,
8567: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87 wiz 8568: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78 rillig 8569: number of examples.</p>
8570: </div>
8571: <div class="sect2" lang="en">
8572: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8573: <a name="undefined-reference"></a>19.5.3. Undefined reference to “<span class="quote">...</span>”</h3></div></div></div>
1.92 rillig 8574: <p>This error message often means that a package did not
1.78 rillig 8575: link to a shared library it needs. The following functions are
8576: known to cause this error message over and over.</p>
8577: <div class="informaltable">
8578: <a name="undefined-reference-functions"></a><table border="1">
8579: <colgroup>
8580: <col>
8581: <col>
8582: <col>
8583: </colgroup>
8584: <thead><tr>
8585: <th>Function</th>
8586: <th>Library</th>
8587: <th>Affected platforms</th>
8588: </tr></thead>
8589: <tbody>
8590: <tr>
8591: <td>accept, bind, connect</td>
8592: <td>-lsocket</td>
8593: <td>Solaris</td>
8594: </tr>
8595: <tr>
8596: <td>crypt</td>
8597: <td>-lcrypt</td>
8598: <td>DragonFly, NetBSD</td>
8599: </tr>
8600: <tr>
8601: <td>dlopen, dlsym</td>
8602: <td>-ldl</td>
8603: <td>Linux</td>
8604: </tr>
8605: <tr>
8606: <td>gethost*</td>
8607: <td>-lnsl</td>
8608: <td>Solaris</td>
8609: </tr>
8610: <tr>
8611: <td>inet_aton</td>
8612: <td>-lresolv</td>
8613: <td>Solaris</td>
8614: </tr>
8615: <tr>
8616: <td>nanosleep, sem_*, timer_*</td>
8617: <td>-lrt</td>
8618: <td>Solaris</td>
8619: </tr>
8620: <tr>
8621: <td>openpty</td>
8622: <td>-lutil</td>
8623: <td>Linux</td>
8624: </tr>
8625: </tbody>
8626: </table>
8627: </div>
8628: <p>To fix these linker errors, it is often sufficient to say
1.87 wiz 8629: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8630: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110 hubertf 8631: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87 wiz 8632: bmake</strong></span>.</p>
1.92 rillig 8633: <div class="sect3" lang="en">
8634: <div class="titlepage"><div><div><h4 class="title">
1.106 rillig 8635: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92 rillig 8636: <p>When you are using the SunPro compiler, there is another
8637: possibility. That compiler cannot handle the following code:</p>
8638: <pre class="programlisting">
1.100 rillig 8639: extern int extern_func(int);
1.93 rillig 8640:
1.100 rillig 8641: static inline int
8642: inline_func(int x)
8643: {
1.92 rillig 8644: return extern_func(x);
1.100 rillig 8645: }
1.93 rillig 8646:
1.100 rillig 8647: int main(void)
8648: {
1.92 rillig 8649: return 0;
1.100 rillig 8650: }
1.92 rillig 8651: </pre>
8652: <p>It generates the code for <code class="function">inline_func</code> even if
8653: that function is never used. This code then refers to
8654: <code class="function">extern_func</code>, which can usually not be resolved. To
8655: solve this problem you can try to tell the package to disable inlining
8656: of functions.</p>
8657: </div>
1.87 wiz 8658: </div>
8659: <div class="sect2" lang="en">
8660: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8661: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87 wiz 8662: <p>Sometimes packages fail to build because the compiler runs
8663: into an operating system specific soft limit. With the
8664: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8665: to unlimit the resources. Currently, the allowed values are
8666: “<span class="quote">datasize</span>” and “<span class="quote">stacksize</span>” (or both).
8667: Setting this variable is similar to running the shell builtin
1.110 hubertf 8668: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87 wiz 8669: segment size or maximum stack size of a process, respectively, to
8670: their hard limits.</p>
1.78 rillig 8671: </div>
1.75 rillig 8672: </div>
8673: <div class="sect1" lang="en">
8674: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 8675: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75 rillig 8676: <div class="sect2" lang="en">
8677: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8678: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110 hubertf 8679: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87 wiz 8680: with some operating systems cannot create more than one
8681: directory at a time. As such, you should call
8682: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8683: <pre class="programlisting">
1.100 rillig 8684: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8685: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87 wiz 8686: </pre>
1.78 rillig 8687: <p>You can also just append “<span class="quote"><code class="literal">dir1
1.87 wiz 8688: dir2</code></span>” to the
8689: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8690: automatically do the right thing.</p>
1.75 rillig 8691: </div>
8692: <div class="sect2" lang="en">
8693: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8694: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83 wiz 8695: <p>In general, documentation should be installed into
1.87 wiz 8696: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8697: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8698: includes the version number of the package).</p>
1.84 wiz 8699: <p>Many modern packages using GNU autoconf allow to set the
1.87 wiz 8700: directory where HTML documentation is installed with the
8701: “<span class="quote">--with-html-dir</span>” option. Sometimes using this flag
8702: is needed because otherwise the documentation ends up in
8703: <code class="filename">${PREFIX}/share/doc/html</code> or other
8704: places.</p>
8705: <p>An exception to the above is that library API documentation
1.91 rillig 8706: 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 8707: browsers (devhelp) should be left at their default location, which
8708: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8709: documentation can be recognized from files ending in
8710: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8711: (It is also acceptable to install such files in
8712: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8713: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8714: <code class="filename">.devhelp*</code> file must be directly in that
8715: directory then, no additional subdirectory level is allowed in
8716: this case. This is usually achieved by using
8717: “<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”.
8718: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8719: though.)</p>
1.75 rillig 8720: </div>
8721: <div class="sect2" lang="en">
8722: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8723: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75 rillig 8724: <p>Certain packages, most of them in the games category, install
1.87 wiz 8725: a score file that allows all users on the system to record their
8726: highscores. In order for this to work, the binaries need to be
8727: installed setgid and the score files owned by the appropriate
8728: group and/or owner (traditionally the "games" user/group). The
8729: following variables, documented in more detail in
8730: <code class="filename">mk/defaults/mk.conf</code>, control this
8731: behaviour: <code class="varname">SETGIDGAME</code>,
8732: <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8733: <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75 rillig 8734: <p>Note that per default, setgid installation of games is
1.87 wiz 8735: disabled; setting <code class="varname">SETGIDGAME=YES</code> will set all
8736: the other variables accordingly.</p>
1.75 rillig 8737: <p>A package should therefor never hard code file ownership or
1.87 wiz 8738: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8739: <code class="varname">INSTALL_GAME_DATA</code> to set these
8740: correctly.</p>
1.75 rillig 8741: </div>
8742: <div class="sect2" lang="en">
8743: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8744: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.103 wiz 8745: <div class="itemizedlist"><ul type="disc">
8746: <li><p>All installation operations have to be prefixed with
8747: <code class="filename">${DESTDIR}</code>.</p></li>
8748: <li><p>automake gets this DESTDIR mostly right
8749: automatically. Many manual rules and pre/post-install often are
8750: incorrect; fix them.</p></li>
8751: <li><p>If files are installed with special owner/group
8752: either use @owner/@group in the <code class="filename">PLIST</code>
8753: (preferred) or use <code class="varname">SPECIAL_PERMS</code>
8754: (discouraged). Note that @owner/@group are sticky during
8755: install, keep this in mind.</p></li>
8756: <li><p>In general, packages should support
8757: <code class="varname">UNPRIVILEGED</code> to be able to use
8758: DESTDIR.</p></li>
8759: </ul></div>
8760: </div>
8761: <div class="sect2" lang="en">
8762: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8763: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87 wiz 8764: <p>Your package may also contain scripts with hardcoded paths to
8765: other interpreters besides (or as well as) perl. To correct the
8766: full pathname to the script interpreter, you need to set the
8767: following definitions in your <code class="filename">Makefile</code> (we
1.110 hubertf 8768: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87 wiz 8769: <pre class="programlisting">
1.100 rillig 8770: REPLACE_INTERPRETER+= tcl
8771: REPLACE.tcl.old= .*/bin/tclsh
8772: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
8773: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
8774: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87 wiz 8775: </pre>
1.75 rillig 8776: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8777: <h3 class="title">Note</h3>
8778: <p>Before March 2006, these variables were called
1.87 wiz 8779: <code class="varname">_REPLACE.*</code> and
8780: <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75 rillig 8781: </div>
8782: </div>
8783: <div class="sect2" lang="en">
8784: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8785: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75 rillig 8786: <p>Makefiles of packages providing perl5 modules should include
1.87 wiz 8787: the Makefile fragment
8788: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.110 hubertf 8789: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87 wiz 8790: configuration for such modules as well as various hooks to tune
8791: this configuration. See comments in this file for
8792: details.</p>
1.75 rillig 8793: <p>Perl5 modules will install into different places depending
1.87 wiz 8794: on the version of perl used during the build process. To
8795: address this, pkgsrc will append lines to the
8796: <code class="filename">PLIST</code> corresponding to the files listed in
8797: the installed <code class="filename">.packlist</code> file generated by
8798: most perl5 modules. This is invoked by defining
8799: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8800: paths to packlist files, e.g.:</p>
1.75 rillig 8801: <pre class="programlisting">
1.100 rillig 8802: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87 wiz 8803: </pre>
1.75 rillig 8804: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87 wiz 8805: <code class="varname">PERL5_SITEARCH</code>, and
8806: <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8807: in which perl5 modules may be installed, and may be used by
8808: perl5 packages that don't have a packlist. These three
8809: variables are also substituted for in the
8810: <code class="filename">PLIST</code>.</p>
1.75 rillig 8811: </div>
8812: <div class="sect2" lang="en">
8813: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8814: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75 rillig 8815: <p>Some packages install info files or use the
1.87 wiz 8816: “<span class="quote">makeinfo</span>” or “<span class="quote">install-info</span>”
8817: commands. <code class="varname">INFO_FILES</code> should be defined in
8818: the package Makefile so that <code class="filename">INSTALL</code> and
8819: <code class="filename">DEINSTALL</code> scripts will be generated to
8820: handle registration of the info files in the Info directory
8821: file. The “<span class="quote">install-info</span>” command used for the info
8822: files registration is either provided by the system, or by a
8823: special purpose package automatically added as dependency if
8824: needed.</p>
1.75 rillig 8825: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87 wiz 8826: <code class="filename">${PREFIX}</code> where info files are primarily
8827: located. <code class="varname">PKGINFODIR</code> defaults to
8828: “<span class="quote">info</span>” and can be overridden by the user.</p>
1.75 rillig 8829: <p>The info files for the package should be listed in the
1.87 wiz 8830: package <code class="filename">PLIST</code>; however any split info files
8831: need not be listed.</p>
1.75 rillig 8832: <p>A package which needs the “<span class="quote">makeinfo</span>” command
1.87 wiz 8833: at build time must add “<span class="quote">makeinfo</span>” to
8834: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8835: version of the “<span class="quote">makeinfo</span>” command is needed it
8836: should be noted with the <code class="varname">TEXINFO_REQD</code>
8837: variable in the package <code class="filename">Makefile</code>. By
8838: default, a minimum version of 3.12 is required. If the system
1.110 hubertf 8839: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87 wiz 8840: does not match the required minimum, a build dependency on the
1.91 rillig 8841: <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 8842: be added automatically.</p>
1.75 rillig 8843: <p>The build and installation process of the software provided
1.87 wiz 8844: by the package should not use the
1.110 hubertf 8845: <span class="command"><strong>install-info</strong></span> command as the registration of
1.87 wiz 8846: info files is the task of the package
8847: <code class="filename">INSTALL</code> script, and it must use the
1.110 hubertf 8848: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75 rillig 8849: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110 hubertf 8850: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8851: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87 wiz 8852: in <code class="varname">PATH</code>.</p>
1.110 hubertf 8853: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87 wiz 8854: no effect except the logging of a message. The script overriding
1.110 hubertf 8855: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87 wiz 8856: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110 hubertf 8857: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75 rillig 8858: </div>
8859: <div class="sect2" lang="en">
8860: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8861: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81 rillig 8862: <p>All packages that install manual pages should install them
1.87 wiz 8863: into the same directory, so that there is one common place to look
8864: for them. In pkgsrc, this place is
8865: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8866: should be used in packages. The default for
8867: <code class="varname">PKGMANDIR</code> is
8868: “<span class="quote"><code class="filename">man</code></span>”. Another often-used value
8869: is “<span class="quote"><code class="filename">share/man</code></span>”.</p>
1.75 rillig 8870: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
8871: <h3 class="title">Note</h3>
1.87 wiz 8872: <p>The support for a custom <code class="varname">PKGMANDIR</code>
8873: is far from complete.</p>
1.75 rillig 8874: </div>
1.81 rillig 8875: <p>The <code class="filename">PLIST</code> files can just use
1.87 wiz 8876: <code class="filename">man/</code> as the top level directory for the man
8877: page file entries, and the pkgsrc framework will convert as
8878: needed. In all other places, the correct
8879: <code class="varname">PKGMANDIR</code> must be used.</p>
8880: <p>Packages that are
8881: configured with <code class="varname">GNU_CONFIGURE</code> set as
8882: “<span class="quote">yes</span>”, by default will use the
8883: <code class="filename">./configure</code>
8884: --mandir switch to set where the man pages should be installed.
8885: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8886: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8887: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8888: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8889: to “<span class="quote">no</span>”.
8890: Or if the <code class="filename">./configure</code> script uses
8891: a non-standard use of --mandir, you can set
8892: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110 hubertf 8893: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.87 wiz 8894: information on installation of compressed manual pages.</p>
1.75 rillig 8895: </div>
8896: <div class="sect2" lang="en">
8897: <div class="titlepage"><div><div><h3 class="title">
1.107 rillig 8898: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87 wiz 8899: <p>If a package installs <code class="filename">.schemas</code> or
1.107 rillig 8900: <code class="filename">.entries</code> files, used by GConf,
1.87 wiz 8901: you need to take some extra steps to make sure they get registered
8902: in the database:</p>
1.75 rillig 8903: <div class="orderedlist"><ol type="1">
1.107 rillig 8904: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87 wiz 8905: instead of its <code class="filename">buildlink3.mk</code> file. This
1.107 rillig 8906: takes care of rebuilding the GConf database at installation and
1.87 wiz 8907: deinstallation time, and tells the package where to install
1.107 rillig 8908: GConf data files using some standard configure arguments. It
1.87 wiz 8909: also disallows any access to the database directly from the
8910: package.</p></li>
1.75 rillig 8911: <li><p>Ensure that the package installs its
1.87 wiz 8912: <code class="filename">.schemas</code> files under
8913: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
8914: installed under <code class="filename">${PREFIX}/etc</code>, you will
8915: need to manually patch the package.</p></li>
1.75 rillig 8916: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87 wiz 8917: directory, as they will be handled automatically. See
1.110 hubertf 8918: <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, “How do I change the location of configuration files?”</a> for more information.</p></li>
1.107 rillig 8919: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87 wiz 8920: your <code class="filename">Makefile</code> with a list of all
8921: <code class="filename">.schemas</code> files installed by the package, if
8922: any. Names must not contain any directories in them.</p></li>
1.107 rillig 8923: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87 wiz 8924: your <code class="filename">Makefile</code> with a
8925: list of all <code class="filename">.entries</code> files installed by the
8926: package, if any. Names must not contain any directories in
8927: them.</p></li>
1.75 rillig 8928: </ol></div>
8929: </div>
8930: <div class="sect2" lang="en">
8931: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8932: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.87 wiz 8933: <p>If a package installs <code class="filename">.omf</code> files, used by
8934: scrollkeeper, you need to take some extra steps to make sure they
8935: get registered in the database:</p>
1.75 rillig 8936: <div class="orderedlist"><ol type="1">
8937: <li><p>Include
1.87 wiz 8938: <code class="filename">../../textproc/scrollkeeper/omf.mk</code>
8939: instead of its <code class="filename">buildlink3.mk</code> file. This
8940: takes care of rebuilding the scrollkeeper database at
8941: installation and deinstallation time, and disallows any access
8942: to it directly from the package.</p></li>
1.75 rillig 8943: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 8944: <code class="filename">libdata/scrollkeeper</code> directory, as they
8945: will be handled automatically.</p></li>
1.76 rillig 8946: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.87 wiz 8947: the PLIST. It will be handled by scrollkeeper.</p></li>
1.75 rillig 8948: </ol></div>
8949: </div>
8950: <div class="sect2" lang="en">
8951: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8952: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75 rillig 8953: <p>If a package installs font files, you will need to rebuild
1.87 wiz 8954: the fonts database in the directory where they get installed at
8955: installation and deinstallation time. This can be automatically
8956: done by using the pkginstall framework.</p>
1.75 rillig 8957: <p>You can list the directories where fonts are installed in the
1.87 wiz 8958: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
8959: variables, where <em class="replaceable"><code>type</code></em> can be one of
8960: “<span class="quote">ttf</span>”, “<span class="quote">type1</span>” or “<span class="quote">x11</span>”.
8961: Also make sure that the database file
8962: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75 rillig 8963: <p>Note that you should not create new directories for fonts;
1.87 wiz 8964: instead use the standard ones to avoid that the user needs to
8965: manually configure his X server to find them.</p>
1.75 rillig 8966: </div>
8967: <div class="sect2" lang="en">
8968: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8969: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75 rillig 8970: <p>If a package installs GTK2 immodules or loaders, you need to
1.87 wiz 8971: take some extra steps to get them registered in the GTK2 database
8972: properly:</p>
1.75 rillig 8973: <div class="orderedlist"><ol type="1">
8974: <li><p>Include
1.87 wiz 8975: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
8976: <code class="filename">buildlink3.mk</code> file. This takes care of
8977: rebuilding the database at installation and deinstallation time.</p></li>
8978: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
8979: your package installs GTK2 immodules.</p></li>
8980: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
8981: GTK2 loaders.</p></li>
1.75 rillig 8982: <li>
1.87 wiz 8983: <p>Patch the package to not touch any of the GTK2
8984: databases directly. These are:</p>
1.75 rillig 8985: <div class="itemizedlist"><ul type="disc">
1.76 rillig 8986: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
8987: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75 rillig 8988: </ul></div>
8989: </li>
1.87 wiz 8990: <li><p>Check the <code class="filename">PLIST</code> and remove
8991: any entries under the <code class="filename">libdata/gtk-2.0</code>
8992: directory, as they will be handled automatically.</p></li>
1.75 rillig 8993: </ol></div>
8994: </div>
8995: <div class="sect2" lang="en">
8996: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 8997: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75 rillig 8998: <p>If a package installs SGML or XML data files that need to be
1.87 wiz 8999: registered in system-wide catalogs (like DTDs, sub-catalogs,
9000: etc.), you need to take some extra steps:</p>
1.75 rillig 9001: <div class="orderedlist"><ol type="1">
9002: <li><p>Include
1.87 wiz 9003: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9004: your <code class="filename">Makefile</code>, which takes care of
9005: registering those files in system-wide catalogs at
9006: installation and deinstallation time.</p></li>
1.75 rillig 9007: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87 wiz 9008: any SGML catalogs installed by the package.</p></li>
1.75 rillig 9009: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87 wiz 9010: any XML catalogs installed by the package.</p></li>
1.75 rillig 9011: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87 wiz 9012: to be added to the SGML catalog. These come in groups of
9013: three strings; see xmlcatmgr(1) for more information
9014: (specifically, arguments recognized by the 'add' action).
9015: Note that you will normally not use this variable.</p></li>
1.75 rillig 9016: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87 wiz 9017: to be added to the XML catalog. These come in groups of three
9018: strings; see xmlcatmgr(1) for more information (specifically,
9019: arguments recognized by the 'add' action). Note that you will
9020: normally not use this variable.</p></li>
1.75 rillig 9021: </ol></div>
9022: </div>
9023: <div class="sect2" lang="en">
9024: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9025: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75 rillig 9026: <p>If a package provides extensions to the MIME database by
1.87 wiz 9027: installing <code class="filename">.xml</code> files inside
9028: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9029: need to take some extra steps to ensure that the database is kept
9030: consistent with respect to these new files:</p>
1.75 rillig 9031: <div class="orderedlist"><ol type="1">
9032: <li><p>Include
1.87 wiz 9033: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9034: (avoid using the <code class="filename">buildlink3.mk</code> file from
9035: this same directory, which is reserved for inclusion from
9036: other <code class="filename">buildlink3.mk</code> files). It takes
9037: care of rebuilding the MIME database at installation and
9038: deinstallation time, and disallows any access to it directly
9039: from the package.</p></li>
1.75 rillig 9040: <li><p>Check the PLIST and remove any entries under the
1.87 wiz 9041: <code class="filename">share/mime</code> directory,
9042: <span class="emphasis"><em>except</em></span> for files saved under
9043: <code class="filename">share/mime/packages</code>. The former are
9044: handled automatically by
9045: the update-mime-database program, but the latter are
9046: package-dependent and must be removed by the package that
9047: installed them in the first place.</p></li>
1.76 rillig 9048: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87 wiz 9049: from the PLIST. They will be handled by the shared-mime-info
9050: package.</p></li>
1.75 rillig 9051: </ol></div>
9052: </div>
9053: <div class="sect2" lang="en">
9054: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9055: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93 rillig 9056: <p>If a package uses intltool during its build, add
9057: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87 wiz 9058: which forces it to use the intltool package provided by pkgsrc,
9059: instead of the one bundled with the distribution file.</p>
1.75 rillig 9060: <p>This tracks intltool's build-time dependencies and uses the
1.87 wiz 9061: latest available version; this way, the package benefits of any
9062: bug fixes that may have appeared since it was released.</p>
1.75 rillig 9063: </div>
9064: <div class="sect2" lang="en">
9065: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9066: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75 rillig 9067: <p>If a package contains a rc.d script, it won't be copied into
1.87 wiz 9068: the startup directory by default, but you can enable it, by adding
9069: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110 hubertf 9070: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87 wiz 9071: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9072: it will automatically remove the scripts when the package is
9073: deinstalled.</p>
1.75 rillig 9074: </div>
9075: <div class="sect2" lang="en">
9076: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9077: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75 rillig 9078: <p>If a package installs TeX packages into the texmf tree,
1.87 wiz 9079: the <code class="filename">ls-R</code> database of the tree needs to be
9080: updated.</p>
1.75 rillig 9081: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9082: <h3 class="title">Note</h3>
9083: <p>Except the main TeX packages such as teTeX-texmf,
1.87 wiz 9084: packages should install files
9085: into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9086: not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75 rillig 9087: </div>
9088: <div class="orderedlist"><ol type="1">
9089: <li><p>Include
1.87 wiz 9090: <code class="filename">../../print/teTeX/module.mk</code> instead
9091: of <code class="filename">../../mk/tex.buildlink3.mk</code>. This
9092: takes care of rebuilding the <code class="filename">ls-R</code>
9093: database at installation and deinstallation time.</p></li>
1.75 rillig 9094: <li>
9095: <p>If your package installs files into a texmf
1.87 wiz 9096: tree other than the one
9097: at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
9098: set <code class="varname">TEXMFDIRS</code> to the list of all texmf
9099: trees that need database update.</p>
1.75 rillig 9100: <p>If your package also installs font map files that need
1.110 hubertf 9101: to be registered using <span class="command"><strong>updmap</strong></span>,
1.87 wiz 9102: set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.110 hubertf 9103: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.87 wiz 9104: be run automatically at installation/deinstallation to
9105: enable/disable font map files for TeX output
9106: drivers.</p>
1.75 rillig 9107: </li>
1.76 rillig 9108: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87 wiz 9109: databases are included in <code class="filename">PLIST</code>, as
9110: they will be removed only by the teTeX-bin package.</p></li>
1.75 rillig 9111: </ol></div>
9112: </div>
1.85 jmmv 9113: <div class="sect2" lang="en">
9114: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9115: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87 wiz 9116: emulation</h3></div></div></div>
9117: <p>There are some packages that provide libraries and
9118: executables for running binaries from a one operating system
9119: on a different one (if the latter supports it). One example
9120: is running Linux binaries on NetBSD.</p>
1.91 rillig 9121: <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 9122: helps in extracting and packaging Linux rpm packages.</p>
9123: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110 hubertf 9124: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87 wiz 9125: if all libraries for each installed executable can be found by
9126: the dynamic linker. Since the standard dynamic linker is run,
9127: this fails for emulation packages, because the libraries used
9128: by the emulation are not in the standard directories.</p>
9129: </div>
9130: <div class="sect2" lang="en">
9131: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9132: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85 jmmv 9133: <p>If a package installs images under the
1.87 wiz 9134: <code class="filename">share/icons/hicolor</code> and/or updates the
9135: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9136: database, you need to take some extra steps to make sure that the
9137: shared theme directory is handled appropriately and that the cache
9138: database is rebuilt:</p>
1.85 jmmv 9139: <div class="orderedlist"><ol type="1">
9140: <li><p>Include
1.87 wiz 9141: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9142: <li><p>Check the <code class="filename">PLIST</code> and remove the
9143: entry that refers to the theme cache.</p></li>
1.85 jmmv 9144: <li><p>Ensure that the PLIST does not remove the shared icon
9145: directories from the <code class="filename">share/icons/hicolor</code>
9146: hierarchy because they will be handled automatically.</p></li>
9147: </ol></div>
9148: <p>The best way to verify that the PLIST is correct with
9149: respect to the last two points is to regenerate it using
1.110 hubertf 9150: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85 jmmv 9151: </div>
9152: <div class="sect2" lang="en">
9153: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 9154: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85 jmmv 9155: <p>If a package installs <code class="filename">.desktop</code> files
9156: under <code class="filename">share/applications</code> and these include
9157: MIME information, you need to take extra steps to ensure that they
9158: are registered into the MIME database:</p>
9159: <div class="orderedlist"><ol type="1">
9160: <li><p>Include
9161: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9162: <li><p>Check the PLIST and remove the entry that refers to the
9163: <code class="filename">share/applications/mimeinfo.cache</code> file.
9164: It will be handled automatically.</p></li>
9165: </ol></div>
9166: <p>The best way to verify that the PLIST is correct with
1.110 hubertf 9167: respect to the last point is to regenerate it using <span class="command"><strong>make
1.85 jmmv 9168: print-PLIST</strong></span>.</p>
1.75 rillig 9169: </div>
9170: </div>
1.87 wiz 9171: <div class="sect1" lang="en">
9172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9173: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87 wiz 9174: <p>In some cases one does not have the time to solve a problem
9175: immediately. There are currently two ways to declare that one knows
9176: that a package has problems.</p>
9177: <div class="itemizedlist"><ul type="disc">
9178: <li><p>The first way is to plainly mark it as broken. For
9179: this, one just sets the variable <code class="varname">BROKEN</code> to the
9180: reason why the package is broken (similar to the
9181: <code class="varname">RESTRICTED</code> variable). A user trying to build
9182: the package will immediately be shown this message, and the build
9183: will not be even tried.</p></li>
9184: <li><p>After each pkgsrc freeze period (a time when the
9185: tree is stabilized and a new pkgsrc branch is cut), the packages
9186: that were not building in the official branch build on the latest
9187: NetBSD release will be marked as broken on that branch. This is
9188: done by setting the <code class="varname">BROKEN_IN</code> variable to the
9189: branch name (or appending the branch name to it). If a user tries
9190: to build such a package and the build fails, the user gets a
9191: message that says that the package was broken on the respective
9192: branch(es).</p></li>
9193: </ul></div>
9194: <p>Both types of packages are removed from pkgsrc in irregular
9195: intervals.</p>
9196: </div>
1.75 rillig 9197: </div>
9198: <div class="chapter" lang="en">
9199: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9200: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88 wiz 9201: <p>To check out all the gotchas when building a package, here are
9202: the steps that I do in order to get a package working. Please note
9203: this is basically the same as what was explained in the previous
9204: sections, only with some debugging aids.</p>
1.75 rillig 9205: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9206: <li><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
1.75 rillig 9207: <li>
1.91 rillig 9208: <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 9209: create a directory for a new package, change into it, then run
1.110 hubertf 9210: <span class="command"><strong>url2pkg</strong></span>:</p>
1.75 rillig 9211: <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>
9212: <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>
9213: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9214: </li>
1.76 rillig 9215: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9216: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110 hubertf 9217: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75 rillig 9218: <li><p>Add any dependencies glimpsed from documentation and the
1.88 wiz 9219: configure step to the package's
9220: <code class="filename">Makefile</code>.</p></li>
1.75 rillig 9221: <li>
9222: <p>Make the package compile, doing multiple rounds of</p>
9223: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9224: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9225: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9226: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9227: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9228: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9229: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88 wiz 9230: <p>Doing this step as non-root user will ensure that no files
9231: are modified that shouldn't be, especially during the build
1.110 hubertf 9232: phase. <span class="command"><strong>mkpatches</strong></span>,
9233: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91 rillig 9234: 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 9235: package.</p>
1.75 rillig 9236: </li>
1.88 wiz 9237: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.110 hubertf 9238: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
1.75 rillig 9239: <li>
1.76 rillig 9240: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75 rillig 9241: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9242: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9243: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9244: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9245: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88 wiz 9246: <p>You usually need to be <code class="username">root</code> to do
9247: this. Look if there are any files left:</p>
1.75 rillig 9248: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9249: <p>If this reveals any files that are missing in
1.88 wiz 9250: <code class="filename">PLIST</code>, add them.</p>
1.75 rillig 9251: </li>
9252: <li>
1.88 wiz 9253: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9254: package again and make a binary package:</p>
1.75 rillig 9255: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9256: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9257: </li>
9258: <li>
9259: <p>Delete the installed package:</p>
1.88 wiz 9260: <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 9261: </li>
9262: <li>
1.110 hubertf 9263: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88 wiz 9264: command, which shouldn't find anything now:</p>
1.75 rillig 9265: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9266: </li>
9267: <li>
9268: <p>Reinstall the binary package:</p>
1.93 rillig 9269: <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 9270: </li>
1.88 wiz 9271: <li><p>Play with it. Make sure everything works.</p></li>
1.75 rillig 9272: <li>
1.110 hubertf 9273: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88 wiz 9274: reports:</p>
1.75 rillig 9275: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9276: </li>
1.110 hubertf 9277: <li><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
1.75 rillig 9278: </ul></div>
9279: </div>
9280: <div class="chapter" lang="en">
9281: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9282: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75 rillig 9283: <div class="toc">
9284: <p><b>Table of Contents</b></p>
9285: <dl>
1.106 rillig 9286: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9287: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9288: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9289: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9290: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9291: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.75 rillig 9292: </dl>
9293: </div>
9294: <div class="sect1" lang="en">
9295: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9296: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75 rillig 9297: <p>Our policy is that we accept binaries only from pkgsrc
9298: developers to guarantee that the packages don't contain any
9299: trojan horses etc. This is not to annoy anyone but rather to
9300: protect our users! You're still free to put up your home-made
9301: binary packages and tell the world where to get them. NetBSD
9302: developers doing bulk builds and wanting to upload them please
1.110 hubertf 9303: see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, “Uploading results of a bulk build”</a>.</p>
1.75 rillig 9304: </div>
9305: <div class="sect1" lang="en">
9306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9307: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75 rillig 9308: <p>First, check that your package is complete, compiles and
1.110 hubertf 9309: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9310: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82 rillig 9311: archive that contains all files that make up the package.
1.87 wiz 9312: Finally, send this package to the pkgsrc bug tracking system,
1.110 hubertf 9313: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87 wiz 9314: that, go to the web page
1.110 hubertf 9315: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87 wiz 9316: which contains some instructions and a link to a form, where you
9317: can submit packages.</p>
9318: <p>In the form of the problem report, the category should be
9319: “<span class="quote">pkg</span>”, the synopsis should include the package name
9320: and version number, and the description field should contain a
9321: short description of your package (contents of the COMMENT
9322: variable or DESCR file are OK). The uuencoded package data should
9323: go into the “<span class="quote">fix</span>” field.</p>
1.75 rillig 9324: <p>If you want to submit several packages, please send a
9325: separate PR for each one, it's easier for us to track things
9326: that way.</p>
9327: <p>Alternatively, you can also import new packages into
9328: pkgsrc-wip (“<span class="quote">pkgsrc work-in-progress</span>”); see the
1.110 hubertf 9329: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75 rillig 9330: for details.</p>
9331: </div>
9332: <div class="sect1" lang="en">
9333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9334: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75 rillig 9335: <p>Please note all package additions, updates, moves, and
1.93 rillig 9336: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75 rillig 9337: important to keep this file up to date and conforming to the
9338: existing format, because it will be used by scripts to
1.110 hubertf 9339: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75 rillig 9340: sites. Additionally, check the
1.76 rillig 9341: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75 rillig 9342: for the package you updated or removed, in case it was mentioned
9343: there.</p>
9344: <p>When the <code class="varname">PKGREVISION</code> of a package is
9345: bumped, the change should appear in
1.93 rillig 9346: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75 rillig 9347: related or otherwise relevant. Mass bumps that result from a
9348: dependency being updated should not be mentioned. In all other
9349: cases it's the developer's decision.</p>
9350: <p>There is a make target that helps in creating proper
1.110 hubertf 9351: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.75 rillig 9352: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9353: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93 rillig 9354: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75 rillig 9355: file is up-to-date (to avoid having to resolve conflicts later-on)
1.110 hubertf 9356: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9357: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75 rillig 9358: For new packages, or package moves or removals, set the
9359: <code class="varname">CTYPE</code> variable on the command line to "Added",
9360: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110 hubertf 9361: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75 rillig 9362: not the same as your NetBSD login name. Don't forget to commit
1.93 rillig 9363: the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75 rillig 9364: </div>
9365: <div class="sect1" lang="en">
9366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9367: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87 wiz 9368: <p>This section is only of interest for pkgsrc developers with write
1.75 rillig 9369: access to the pkgsrc repository. Please remember that cvs
9370: imports files relative to the current working directory, and that
9371: the pathname that you
1.110 hubertf 9372: give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75 rillig 9373: to place the files in the repository. Newly created packages should be
9374: imported with a vendor tag of “<span class="quote">TNF</span>” and a release tag of
1.87 wiz 9375: “<span class="quote">pkgsrc-base</span>”, e.g:</p>
1.75 rillig 9376: <pre class="programlisting">
1.100 rillig 9377: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9378: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75 rillig 9379: </pre>
1.87 wiz 9380: <p>Remember to move the directory from which you imported out of
1.75 rillig 9381: the way, or cvs will complain the next time you “<span class="quote">cvs
9382: update</span>” your source tree. Also don't forget to add the new
1.87 wiz 9383: package to the category's <code class="filename">Makefile</code>.</p>
9384: <p>The commit message of the initial import should include part of the
1.76 rillig 9385: <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87 wiz 9386: what the package is/does.</p>
9387: <p>For new packages, “<span class="quote">cvs import</span>” is preferred to “<span class="quote">cvs
1.75 rillig 9388: add</span>” because the former gets everything with a single command,
1.87 wiz 9389: and provides a consistent tag.</p>
1.75 rillig 9390: </div>
9391: <div class="sect1" lang="en">
9392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9393: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87 wiz 9394: <p>Please always put a concise, appropriate and relevant summary of the
1.75 rillig 9395: changes between old and new versions into the commit log when updating
1.87 wiz 9396: a package. There are various reasons for this:</p>
1.75 rillig 9397: <div class="itemizedlist"><ul type="disc">
1.87 wiz 9398: <li><p>A URL is volatile, and can change over time. It may go away completely
9399: or its information may be overwritten by newer information.</p></li>
9400: <li><p>Having the change information between old and new versions in our CVS
9401: repository is very useful for people who use either cvs or anoncvs.</p></li>
9402: <li><p>Having the change information between old and new versions in our CVS
1.75 rillig 9403: repository is very useful for people who read the pkgsrc-changes mailing
9404: list, so that they can make tactical decisions about when to upgrade
1.87 wiz 9405: the package.</p></li>
1.75 rillig 9406: </ul></div>
1.87 wiz 9407: <p>Please also recognize that, just because a new version of a package
1.75 rillig 9408: has been released, it should not automatically be upgraded in the CVS
9409: repository. We prefer to be conservative in the packages that are
9410: included in pkgsrc - development or beta packages are not really the
9411: best thing for most places in which pkgsrc is used. Please use your
9412: judgement about what should go into pkgsrc, and bear in mind that
1.87 wiz 9413: stability is to be preferred above new and possibly untested features.</p>
1.75 rillig 9414: </div>
9415: <div class="sect1" lang="en">
9416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9417: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.75 rillig 9418: <div class="orderedlist"><ol type="1">
9419: <li><p>Make a copy of the directory somewhere else.</p></li>
9420: <li>
9421: <p>Remove all CVS dirs.</p>
1.87 wiz 9422: <p>Alternatively to the first two steps you can also do:</p>
1.75 rillig 9423: <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 9424: <p>and use that for further work.</p>
1.75 rillig 9425: </li>
9426: <li><p>Fix <code class="varname">CATEGORIES</code> and any
9427: <code class="varname">DEPENDS</code> paths that just did “<span class="quote">../package</span>”
9428: instead of “<span class="quote">../../category/package</span>”.</p></li>
1.110 hubertf 9429: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75 rillig 9430: place.</p></li>
9431: <li>
9432: <p>Check if any package depends on it:
9433: </p>
9434: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9435: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9436: </li>
9437: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110 hubertf 9438: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76 rillig 9439: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9440: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75 rillig 9441: <li>
9442: <p>Commit the changed and removed files:</p>
9443: <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 9444: <p>(and any packages from step 5, of course).</p>
1.75 rillig 9445: </li>
9446: </ol></div>
9447: </div>
9448: </div>
9449: <div class="chapter" lang="en">
9450: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9451: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75 rillig 9452: <p>This section contains the answers to questions that may
9453: arise when you are writing a package. If you don't find your
9454: question answered here, first have a look in the other chapters,
9455: and if you still don't have the answer, ask on the
9456: <code class="literal">pkgsrc-users</code> mailing list.</p>
9457: <div class="qandaset">
9458: <dl>
1.106 rillig 9459: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75 rillig 9460: MAKEFLAGS, .MAKEFLAGS and
9461: MAKE_FLAGS?</a>
9462: </dt>
1.106 rillig 9463: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75 rillig 9464: MAKE, GMAKE and
9465: MAKE_PROGRAM?</a>
9466: </dt>
1.106 rillig 9467: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75 rillig 9468: CC, PKG_CC and
9469: PKGSRC_COMPILER?</a>
9470: </dt>
1.106 rillig 9471: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75 rillig 9472: BUILDLINK_LDFLAGS,
9473: BUILDLINK_LDADD and
9474: BUILDLINK_LIBS?</a>
9475: </dt>
1.106 rillig 9476: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75 rillig 9477: VARNAME=BUILDLINK_PREFIX.foo
9478: say it's empty?</a>
9479: </dt>
1.106 rillig 9480: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78 rillig 9481: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9482: don't understand the := inside
9483: it.</a>
9484: </dt>
1.106 rillig 9485: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78 rillig 9486: developers?</a>
9487: </dt>
1.106 rillig 9488: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80 rillig 9489: documentation?</a>
9490: </dt>
1.106 rillig 9491: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.92 rillig 9492: do?</a>
9493: </dt>
1.75 rillig 9494: </dl>
9495: <table border="0" summary="Q and A Set">
9496: <col align="left" width="1%">
9497: <tbody>
9498: <tr class="question">
9499: <td align="left" valign="top">
1.112 ! weinem 9500: <a name="devfaq.makeflags"></a><a name="id2733553"></a><p><b>22.1.</b></p>
1.75 rillig 9501: </td>
9502: <td align="left" valign="top"><p>What is the difference between
9503: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9504: <code class="varname">MAKE_FLAGS</code>?</p></td>
9505: </tr>
9506: <tr class="answer">
1.91 rillig 9507: <td align="left" valign="top"></td>
1.75 rillig 9508: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110 hubertf 9509: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75 rillig 9510: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9511: the <code class="varname">MAKE_PROGRAM</code> when building the
9512: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9513: </tr>
9514: <tr class="question">
9515: <td align="left" valign="top">
1.112 ! weinem 9516: <a name="devfaq.make"></a><a name="id2733591"></a><p><b>22.2.</b></p>
1.75 rillig 9517: </td>
9518: <td align="left" valign="top"><p>What is the difference between
9519: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9520: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9521: </tr>
9522: <tr class="answer">
1.91 rillig 9523: <td align="left" valign="top"></td>
1.75 rillig 9524: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110 hubertf 9525: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75 rillig 9526: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9527: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9528: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9529: Make program that is used for building the
9530: package.</p></td>
9531: </tr>
9532: <tr class="question">
9533: <td align="left" valign="top">
1.112 ! weinem 9534: <a name="devfaq.cc"></a><a name="id2733632"></a><p><b>22.3.</b></p>
1.75 rillig 9535: </td>
9536: <td align="left" valign="top"><p>What is the difference between
9537: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9538: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9539: </tr>
9540: <tr class="answer">
1.91 rillig 9541: <td align="left" valign="top"></td>
1.75 rillig 9542: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9543: compiler, which can be configured by the pkgsrc user.
9544: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9545: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9546: path to a compiler, but the type of compiler that should be
1.76 rillig 9547: used. See <code class="filename">mk/compiler.mk</code> for more
1.75 rillig 9548: information about the latter variable.</p></td>
9549: </tr>
9550: <tr class="question">
9551: <td align="left" valign="top">
1.112 ! weinem 9552: <a name="devfaq.bl3flags"></a><a name="id2733671"></a><p><b>22.4.</b></p>
1.75 rillig 9553: </td>
9554: <td align="left" valign="top"><p>What is the difference between
9555: <code class="varname">BUILDLINK_LDFLAGS</code>,
9556: <code class="varname">BUILDLINK_LDADD</code> and
9557: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9558: </tr>
9559: <tr class="answer">
1.91 rillig 9560: <td align="left" valign="top"></td>
1.75 rillig 9561: <td align="left" valign="top"><p>[FIXME]</p></td>
9562: </tr>
9563: <tr class="question">
9564: <td align="left" valign="top">
1.112 ! weinem 9565: <a name="devfaq.bl3prefix"></a><a name="id2733691"></a><p><b>22.5.</b></p>
1.75 rillig 9566: </td>
1.110 hubertf 9567: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75 rillig 9568: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9569: say it's empty?</p></td>
9570: </tr>
9571: <tr class="answer">
1.91 rillig 9572: <td align="left" valign="top"></td>
1.75 rillig 9573: <td align="left" valign="top"><p>For optimization reasons, some variables are only
9574: available in the “<span class="quote">wrapper</span>” phase and later. To
9575: “<span class="quote">simulate</span>” the wrapper phase, append
1.110 hubertf 9576: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75 rillig 9577: command.</p></td>
9578: </tr>
1.78 rillig 9579: <tr class="question">
9580: <td align="left" valign="top">
1.112 ! weinem 9581: <a name="devfaq.master_sites"></a><a name="id2733721"></a><p><b>22.6.</b></p>
1.78 rillig 9582: </td>
9583: <td align="left" valign="top"><p>What does
9584: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9585: don't understand the <code class="literal">:=</code> inside
9586: it.</p></td>
9587: </tr>
9588: <tr class="answer">
1.91 rillig 9589: <td align="left" valign="top"></td>
1.78 rillig 9590: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9591: assignment operator, like you might expect at first sight.
9592: Instead, it is a degenerate form of
9593: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110 hubertf 9594: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78 rillig 9595: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9596: case of <code class="varname">MASTER_SITE_*</code>,
9597: <em class="replaceable"><code>old_string</code></em> is the empty string and
9598: <em class="replaceable"><code>new_string</code></em> is
9599: <code class="literal">package/</code>. That's where the
9600: <code class="literal">:</code> and the <code class="literal">=</code> fall
9601: together.</p></td>
9602: </tr>
9603: <tr class="question">
9604: <td align="left" valign="top">
1.112 ! weinem 9605: <a name="devfaq.mailinglists"></a><a name="id2733866"></a><p><b>22.7.</b></p>
1.78 rillig 9606: </td>
9607: <td align="left" valign="top"><p>Which mailing lists are there for package
9608: developers?</p></td>
9609: </tr>
9610: <tr class="answer">
1.91 rillig 9611: <td align="left" valign="top"></td>
1.78 rillig 9612: <td align="left" valign="top"><div class="variablelist"><dl>
1.110 hubertf 9613: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78 rillig 9614: <dd><p>This is a list for technical discussions related
9615: to pkgsrc development, e.g. soliciting feedback for changes to
9616: pkgsrc infrastructure, proposed new features, questions related
9617: to porting pkgsrc to a new platform, advice for maintaining a
9618: package, patches that affect many packages, help requests moved
9619: from pkgsrc-users when an infrastructure bug is found,
9620: etc.</p></dd>
1.110 hubertf 9621: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78 rillig 9622: <dd><p>All bug reports in category "pkg" sent with
1.110 hubertf 9623: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78 rillig 9624: directly; use one of the other mailing
9625: lists.</p></dd>
9626: </dl></div></td>
9627: </tr>
1.80 rillig 9628: <tr class="question">
9629: <td align="left" valign="top">
1.112 ! weinem 9630: <a name="devfaq.documentation"></a><a name="id2733905"></a><p><b>22.8.</b></p>
1.80 rillig 9631: </td>
9632: <td align="left" valign="top"><p>Where is the pkgsrc
9633: documentation?</p></td>
9634: </tr>
9635: <tr class="answer">
1.91 rillig 9636: <td align="left" valign="top"></td>
1.80 rillig 9637: <td align="left" valign="top">
9638: <p>There are many places where you can find
9639: documentation about pkgsrc:</p>
9640: <div class="itemizedlist"><ul type="disc">
9641: <li><p>The pkgsrc guide (this document) is a collection
9642: of chapters that explain large parts of pkgsrc, but some
9643: chapters tend to be outdated. Which ones they are is hard to
9644: say.</p></li>
1.110 hubertf 9645: <li><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.80 rillig 9646: about certain features, announcements of new parts of the pkgsrc
9647: infrastructure and sometimes even announcements that a certain
9648: feature has been marked as obsolete. The benefit here is that
9649: each message has a date appended to it.</p></li>
9650: <li><p>Many of the files in the
9651: <code class="filename">mk/</code> directory start with a comment that
9652: describes the purpose of the file and how it can be used by the
1.92 rillig 9653: pkgsrc user and package authors. An easy way to find this
1.110 hubertf 9654: documentation is to run <span class="command"><strong>bmake
1.92 rillig 9655: help</strong></span>.</p></li>
1.80 rillig 9656: <li><p>The CVS log messages are a rich source of
9657: information, but they tend to be highly abbreviated, especially
9658: for actions that occur often. Some contain a detailed
9659: description of what has changed, but they are geared towards the
9660: other pkgsrc developers, not towards an average pkgsrc user.
9661: They also only document <span class="emphasis"><em>changes</em></span>, so if you
9662: don't know what has been before, these messages may not be worth
9663: too much to you.</p></li>
9664: <li><p>Some parts of pkgsrc are only “<span class="quote">implicitly
9665: documented</span>”, that is the documentation exists only in the
9666: mind of the developer who wrote the code. To get this
1.110 hubertf 9667: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80 rillig 9668: to see who has written it and ask on the
9669: <code class="literal">tech-pkg</code> mailing list, so that others can
9670: find your questions later (see above). To be sure that the
9671: developer in charge reads the mail, you may CC him or
9672: her.</p></li>
9673: </ul></div>
9674: </td>
9675: </tr>
1.92 rillig 9676: <tr class="question">
9677: <td align="left" valign="top">
1.112 ! weinem 9678: <a name="devfaq.too-much-time"></a><a name="id2734035"></a><p><b>22.9.</b></p>
1.92 rillig 9679: </td>
9680: <td align="left" valign="top"><p>I have a little time to kill. What shall I
9681: do?</p></td>
9682: </tr>
9683: <tr class="answer">
9684: <td align="left" valign="top"></td>
9685: <td align="left" valign="top">
1.93 rillig 9686: <p>This is not really an FAQ yet, but here's the answer
1.92 rillig 9687: anyway.</p>
9688: <div class="itemizedlist"><ul type="disc">
1.110 hubertf 9689: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92 rillig 9690: <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
9691: will tell you about newer versions of installed packages that are
9692: available, but not yet updated in pkgsrc.</p></li>
9693: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.112 ! weinem 9694: — it contains a list of suggested new packages and a list of
1.92 rillig 9695: cleanups and enhancements for pkgsrc that would be nice to
9696: have.</p></li>
9697: <li><p>Review packages for which review was requested on
1.110 hubertf 9698: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92 rillig 9699: mailing list.</p></li>
9700: </ul></div>
9701: </td>
9702: </tr>
1.75 rillig 9703: </tbody>
9704: </table>
9705: </div>
9706: </div>
1.85 jmmv 9707: <div class="chapter" lang="en">
9708: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 9709: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85 jmmv 9710: <div class="toc">
9711: <p><b>Table of Contents</b></p>
9712: <dl>
1.106 rillig 9713: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9714: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9715: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9716: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85 jmmv 9717: </dl>
9718: </div>
1.110 hubertf 9719: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85 jmmv 9720: site</a>:</p>
9721: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9722: environment, an intuitive and attractive desktop for users, and the
9723: GNOME development platform, an extensive framework for building
9724: applications that integrate into the rest of the desktop.</p></blockquote></div>
9725: <p>pkgsrc provides a seamless way to automatically build and install
9726: a complete GNOME environment <span class="emphasis"><em>under many different
9727: platforms</em></span>. We can say with confidence that pkgsrc is one of
9728: the most advanced build and packaging systems for GNOME due to its
9729: included technologies buildlink3, the wrappers and tools framework and
9730: automatic configuration file management. Lots of efforts are put into
9731: achieving a completely clean deinstallation of installed software
9732: components.</p>
1.110 hubertf 9733: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85 jmmv 9734: the above also means that great efforts are put into making GNOME work
1.110 hubertf 9735: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85 jmmv 9736: pkgsrc as its preferred packaging system, contributing lots of
9737: portability fixes to make GNOME build and install under it.</p>
9738: <p>This chapter is aimed at pkgsrc developers and other people
9739: interested in helping our GNOME porting and packaging efforts. It
9740: provides instructions on how to manage the existing packages and some
9741: important information regarding their internals.</p>
9742: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
9743: <h3 class="title">We need your help!</h3>
9744: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9745: and GNOME and are willing to learn new exciting stuff, please jump
1.110 hubertf 9746: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85 jmmv 9747: work</a> list! There is still a long way to go to get a
9748: fully-functional GNOME desktop under NetBSD and we need your help to
9749: achieve it!</p>
9750: </div>
9751: <div class="sect1" lang="en">
9752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9753: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85 jmmv 9754: <p>pkgsrc includes three GNOME-related meta packages:</p>
9755: <div class="itemizedlist"><ul type="disc">
1.91 rillig 9756: <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 9757: the core GNOME desktop environment. It only includes the necessary
9758: bits to get it to boot correctly, although it may lack important
9759: functionality for daily operation. The idea behind this package is
9760: to let end users build their own configurations on top of this one,
9761: first installing this meta package to achieve a functional setup and
9762: then adding individual applications.</p></li>
1.91 rillig 9763: <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 9764: complete installation of the GNOME platform and desktop as defined
9765: by the GNOME project; this is based on the components distributed in
9766: the <code class="filename">platform/x.y/x.y.z/sources</code> and
9767: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9768: official FTP server. Developer-only tools found in those
9769: directories are not installed unless required by some other
9770: component to work properly. Similarly, packages from the bindings
9771: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9772: in unless required as a dependency for an end-user component. This
1.91 rillig 9773: 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>
9774: <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 9775: Installs all the tools required to build a GNOME component when
9776: fetched from the CVS repository. These are required to let the
1.110 hubertf 9777: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85 jmmv 9778: </ul></div>
9779: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9780: sorted in a way that eases updates: a package may depend on other
9781: packages listed before it but not on any listed after it. It is very
9782: important to keep this order to ease updates so... <span class="emphasis"><em>do not
9783: change it to alphabetical sorting!</em></span></p>
9784: </div>
9785: <div class="sect1" lang="en">
9786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9787: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85 jmmv 9788: <p>Almost all GNOME applications are written in C and use a common
9789: set of tools as their build system. Things get different with the new
9790: bindings to other languages (such as Python), but the following will
9791: give you a general idea on the minimum required tools:</p>
9792: <div class="itemizedlist"><ul type="disc">
9793: <li>
9794: <p>Almost all GNOME applications use the GNU Autotools as their
9795: build system. As a general rule you will need to tell this to your
9796: package:</p>
1.100 rillig 9797: <pre class="programlisting">
9798: GNU_CONFIGURE=yes
1.85 jmmv 9799: USE_LIBTOOL=yes
1.100 rillig 9800: USE_TOOLS+=gmake
9801: </pre>
1.85 jmmv 9802: </li>
9803: <li>
9804: <p>If the package uses pkg-config to detect dependencies, add this
9805: tool to the list of required utilities:</p>
9806: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91 rillig 9807: <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 9808: the end of the build process to ensure that you did not miss to
9809: specify any dependency in your package and that the version
9810: requirements are all correct.</p>
9811: </li>
1.93 rillig 9812: <li><p>If the package uses intltool, be sure to add
9813: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85 jmmv 9814: to handle dependencies and to force the package to use the latest
9815: available version.</p></li>
9816: <li>
9817: <p>If the package uses gtk-doc (a documentation generation
9818: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
9819: tool is rather big and the distfile should come with pregenerated
9820: documentation anyway; if it does not, it is a bug that you ought to
9821: report. For such packages you should disable gtk-doc (unless it is
1.89 rillig 9822: the default):</p>
9823: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9824: <p>The default location of installed HTML files
9825: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
9826: and should not be changed unless the package insists on installing
9827: them somewhere else. Otherwise programs as
1.110 hubertf 9828: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.89 rillig 9829: do that with an entry similar to:</p>
9830: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85 jmmv 9831: </li>
9832: </ul></div>
9833: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9834: files under the installation prefix to maintain databases. In this
9835: context, shared means that those exact same directories and files are
9836: used among several different packages, leading to conflicts in the
9837: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
9838: handle the most common cases, so you have to forget about using
9839: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9840: omitting shared files from them. If you find yourself doing those,
9841: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9842: <p>The following table lists the common situations that result in
9843: using shared directories or files. For each of them, the appropriate
9844: solution is given. After applying the solution be sure to
9845: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110 hubertf 9846: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85 jmmv 9847: <div class="table">
1.106 rillig 9848: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91 rillig 9849: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85 jmmv 9850: <colgroup>
9851: <col>
9852: <col>
9853: </colgroup>
9854: <thead><tr>
9855: <th>If the package...</th>
9856: <th>Then...</th>
9857: </tr></thead>
9858: <tbody>
9859: <tr>
9860: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.110 hubertf 9861: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, “Packages installing scrollkeeper data files”</a>.</td>
1.85 jmmv 9862: </tr>
9863: <tr>
9864: <td>Installs icons under the
9865: <code class="filename">share/icons/hicolor</code> hierarchy or updates
9866: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110 hubertf 9867: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, “Packages installing hicolor theme icons”</a>.</td>
1.85 jmmv 9868: </tr>
9869: <tr>
9870: <td>Installs files under
9871: <code class="filename">share/mime/packages</code>.</td>
1.110 hubertf 9872: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, “Packages installing extensions to the MIME database”</a>.</td>
1.85 jmmv 9873: </tr>
9874: <tr>
9875: <td>Installs <code class="filename">.desktop</code> files under
9876: <code class="filename">share/applications</code> and these include MIME
9877: information.</td>
1.110 hubertf 9878: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, “Packages installing desktop files”</a>.</td>
1.85 jmmv 9879: </tr>
9880: </tbody>
1.91 rillig 9881: </table></div>
1.85 jmmv 9882: </div>
1.91 rillig 9883: <br class="table-break">
1.85 jmmv 9884: </div>
9885: <div class="sect1" lang="en">
9886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9887: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85 jmmv 9888: <p>When seeing GNOME as a whole, there are two kinds of
9889: updates:</p>
9890: <div class="variablelist"><dl>
9891: <dt><span class="term">Major update</span></dt>
9892: <dd>
9893: <p>Given that there is still a very long way for GNOME 3 (if it
9894: ever appears), we consider a major update one that goes from a
9895: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9896: where <code class="literal">Y</code> is even and greater than
9897: <code class="literal">X</code>. These are hard to achieve because they
9898: introduce lots of changes in the components' code and almost all
9899: GNOME distfiles are updated to newer versions. Some of them can
9900: even break API and ABI compatibility with the previous major
9901: version series. As a result, the update needs to be done all at
9902: once to minimize breakage.</p>
9903: <p>A major update typically consists of around 80 package
9904: updates and the addition of some new ones.</p>
9905: </dd>
9906: <dt><span class="term">Minor update</span></dt>
9907: <dd>
9908: <p>We consider a minor update one that goes from a
9909: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
9910: one where <code class="literal">Y</code> is greater than
9911: <code class="literal">X</code>. These are easy to achieve because they do
9912: not update all GNOME components, can be done in an incremental way
9913: and do not break API nor ABI compatibility.</p>
9914: <p>A minor update typically consists of around 50 package
9915: updates, although the numbers here may vary a lot.</p>
9916: </dd>
9917: </dl></div>
9918: <p>In order to update the GNOME components in pkgsrc to a new stable
9919: release (either major or minor), the following steps should be
9920: followed:</p>
9921: <div class="orderedlist"><ol type="1">
9922: <li>
9923: <p>Get a list of all the tarballs that form the new release by
9924: using the following commands. These will leave the full list of the
9925: components's distfiles into the <code class="filename">list.txt</code>
9926: file:</p>
1.88 wiz 9927: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9928: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
9929: awk '{ print $9 }' >list.txt</code></strong>
1.88 wiz 9930: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85 jmmv 9931: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
9932: awk '{ print $9 }' >>list.txt</code></strong></pre>
9933: </li>
9934: <li><p>Open each meta package's <code class="filename">Makefile</code> and
9935: bump their version to the release you are updating them to. The
9936: three meta packages should be always consistent with versioning.
9937: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
9938: in them.</p></li>
9939: <li>
9940: <p>For each meta package, update all its
9941: <code class="varname">DEPENDS</code> lines to match the latest versions as
9942: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
9943: newer version (even if found in the FTP) because the meta packages
9944: are supposed to list the exact versions that form a specific GNOME
9945: release. Exceptions are permitted here if a newer version solves a
9946: serious issue in the overall desktop experience; these typically
9947: come in the form of a revision bump in pkgsrc, not in newer versions
9948: from the developers.</p>
9949: <p>Packages not listed in the <code class="filename">list.txt</code> file
9950: should be updated to the latest version available (if found in
9951: pkgsrc). This is the case, for example, of the dependencies on the
1.91 rillig 9952: 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 9953: </li>
9954: <li>
9955: <p>Generate a patch from the modified meta packages and extract the
9956: list of "new" lines. This will provide you an outline on what
9957: packages need to be updated in pkgsrc and in what order:</p>
1.93 rillig 9958: <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 9959: </li>
9960: <li><p>For major desktop updates it is recommended to zap all your
9961: installed packages and start over from scratch at this point.</p></li>
9962: <li><p>Now comes the longest step by far: iterate over the contents
9963: of <code class="filename">todo.txt</code> and update the packages listed in
9964: it in order. For major desktop updates none of these should be
1.93 rillig 9965: committed until the entire set is completed because there are chances
1.85 jmmv 9966: of breaking not-yet-updated packages.</p></li>
9967: <li><p>Once the packages are up to date and working, commit them to
9968: the tree one by one with appropriate log messages. At the end,
9969: commit the three meta package updates and all the corresponding
9970: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
9971: <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>
9972: </ol></div>
9973: </div>
9974: <div class="sect1" lang="en">
9975: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 9976: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85 jmmv 9977: <p>GNOME is a very big component in pkgsrc which approaches 100
9978: packages. Please, it is very important that you always, always,
9979: <span class="strong"><strong>always</strong></span> feed back any portability
1.110 hubertf 9980: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, “Feedback to the author”</a>). This is the only way to get
1.85 jmmv 9981: their attention on portability issues and to ensure that future versions
9982: can be built out-of-the box on NetBSD. The less custom patches in
9983: pkgsrc, the easier further updates are. Those developers in charge of
9984: issuing major GNOME updates will be grateful if you do that.</p>
1.110 hubertf 9985: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85 jmmv 9986: Bugzilla</a>. Not all components use these to track bugs, but most
9987: of them do. Do not be short on your reports: always provide detailed
9988: explanations of the current failure, how it can be improved to achieve
9989: maximum portability and, if at all possible, provide a patch against CVS
9990: head. The more verbose you are, the higher chances of your patch being
9991: accepted.</p>
9992: <p>Also, please avoid using preprocessor magic to fix portability
9993: issues. While the FreeBSD GNOME people are doing a great job in porting
9994: GNOME to their operating system, the official GNOME sources are now
9995: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
9996: and similar macros. This hurts portability. Please see our patching
1.110 hubertf 9997: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.85 jmmv 9998: details.</p>
9999: </div>
10000: </div>
1.75 rillig 10001: </div>
10002: <div class="part" lang="en">
10003: <div class="titlepage"><div><div><h1 class="title">
10004: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10005: <div class="partintro" lang="en">
10006: <div></div>
10007: <p>This part of the guide deals with everything
10008: from the infrastructure that is behind the interfaces described
10009: in the developer's guide. A casual package maintainer should not
10010: need anything from this part.</p>
10011: <div class="toc">
10012: <p><b>Table of Contents</b></p>
10013: <dl>
1.106 rillig 10014: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75 rillig 10015: <dd><dl>
1.106 rillig 10016: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10017: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10018: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75 rillig 10019: <dd><dl>
1.106 rillig 10020: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10021: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75 rillig 10022: </dl></dd>
1.106 rillig 10023: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10024: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10025: <dd><dl>
1.106 rillig 10026: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10027: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81 rillig 10028: </dl></dd>
1.106 rillig 10029: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81 rillig 10030: <dd><dl>
1.106 rillig 10031: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10032: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10033: </dl></dd>
10034: </dl></dd>
1.106 rillig 10035: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75 rillig 10036: <dd><dl>
1.106 rillig 10037: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10038: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10039: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10040: <dd><dl>
1.106 rillig 10041: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10042: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10043: </dl></dd>
10044: </dl></dd>
1.106 rillig 10045: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75 rillig 10046: <dd><dl>
1.106 rillig 10047: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10048: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10049: </dl></dd>
10050: </dl>
10051: </div>
10052: </div>
10053: <div class="chapter" lang="en">
10054: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10055: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75 rillig 10056: <div class="toc">
10057: <p><b>Table of Contents</b></p>
10058: <dl>
1.106 rillig 10059: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10060: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10061: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81 rillig 10062: <dd><dl>
1.106 rillig 10063: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10064: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81 rillig 10065: </dl></dd>
1.106 rillig 10066: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10067: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75 rillig 10068: <dd><dl>
1.106 rillig 10069: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10070: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75 rillig 10071: </dl></dd>
1.106 rillig 10072: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75 rillig 10073: <dd><dl>
1.106 rillig 10074: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10075: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75 rillig 10076: </dl></dd>
10077: </dl>
10078: </div>
10079: <p>The pkgsrc infrastructure consists of many small Makefile
10080: fragments. Each such fragment needs a properly specified
10081: interface. This chapter explains how such an interface looks
10082: like.</p>
10083: <div class="sect1" lang="en">
10084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10085: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81 rillig 10086: <p>Whenever a variable is defined in the pkgsrc
10087: infrastructure, the location and the way of definition provide
10088: much information about the intended use of that variable.
10089: Additionally, more documentation may be found in a header
10090: comment or in this pkgsrc guide.</p>
10091: <p>A special file is
10092: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10093: variables that are intended to be user-defined. They are either
10094: defined using the <code class="literal">?=</code> operator or they are
10095: left undefined because defining them to anything would
10096: effectively mean “<span class="quote">yes</span>”. All these variables may be
10097: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10098: file.</p>
10099: <p>Outside this file, the following conventions apply:
10100: Variables that are defined using the <code class="literal">?=</code>
10101: operator may be overridden by a package.</p>
10102: <p>Variables that are defined using the <code class="literal">=</code>
10103: operator may be used read-only at run-time.</p>
10104: <p>Variables whose name starts with an underscore must not be
10105: accessed outside the pkgsrc infrastructure at all. They may
10106: change without further notice.</p>
10107: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10108: <h3 class="title">Note</h3>
10109: <p>These conventions are currently not applied
10110: consistently to the complete pkgsrc
10111: infrastructure.</p>
10112: </div>
10113: </div>
10114: <div class="sect1" lang="en">
10115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10116: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81 rillig 10117: <p>All variables that contain lists of things should default
10118: to being empty. Two examples that do not follow this rule are
10119: <code class="varname">USE_LANGUAGES</code> and
10120: <code class="varname">DISTFILES</code>. These variables cannot simply be
10121: modified using the <code class="literal">+=</code> operator in package
10122: <code class="filename">Makefile</code>s (or other files included by
10123: them), since there is no guarantee whether the variable is
10124: already set or not, and what its value is. In the case of
10125: <code class="varname">DISTFILES</code>, the packages “<span class="quote">know</span>”
10126: the default value and just define it as in the following
10127: example.</p>
10128: <pre class="programlisting">
1.100 rillig 10129: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81 rillig 10130: </pre>
10131: <p>Because of the selection of this default value, the same
10132: value appears in many package Makefiles. Similarly for
10133: <code class="varname">USE_LANGUAGES</code>, but in this case the default
10134: value (“<span class="quote"><code class="literal">c</code></span>”) is so short that it
10135: doesn't stand out. Nevertheless it is mentioned in many
10136: files.</p>
10137: </div>
10138: <div class="sect1" lang="en">
10139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10140: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75 rillig 10141: <div class="sect2" lang="en">
10142: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10143: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75 rillig 10144: <p>Variable evaluation takes place either at load time or at
10145: runtime, depending on the context in which they occur. The
10146: contexts where variables are evaluated at load time are:</p>
10147: <div class="itemizedlist"><ul type="disc">
10148: <li><p>The right hand side of the <code class="literal">:=</code>
10149: and <code class="literal">!=</code> operators,</p></li>
10150: <li><p>Make directives like <code class="literal">.if</code> or
10151: <code class="literal">.for</code>,</p></li>
10152: <li><p>Dependency lines.</p></li>
10153: </ul></div>
10154: <p>A special exception are references to the iteration
10155: variables of <code class="literal">.for</code> loops, which are expanded
10156: inline, no matter in which context they appear.</p>
10157: <p>As the values of variables may change during load time,
10158: care must be taken not to evaluate them by accident. Typical
10159: examples for variables that should not be evaluated at load time
10160: are <code class="varname">DEPENDS</code> and
10161: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10162: clear, here is an example:</p>
10163: <pre class="programlisting">
1.100 rillig 10164: CONFIGURE_ARGS= # none
10165: CFLAGS= -O
10166: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
1.1 grant 10167:
1.100 rillig 10168: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
1.1 grant 10169:
1.100 rillig 10170: CFLAGS+= -Wall
1.75 rillig 10171: </pre>
10172: <p>This code shows how the use of the <code class="literal">:=</code>
10173: operator can quickly lead to unexpected results. The first
10174: paragraph is fairly common code. The second paragraph evaluates
10175: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10176: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10177: <code class="literal">-Wall</code> is appended to the
10178: <code class="varname">CFLAGS</code>, but this addition will not appear in
10179: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10180: paragraphs from above typically occur in completely unrelated
10181: files.</p>
10182: </div>
10183: <div class="sect2" lang="en">
10184: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10185: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75 rillig 10186: <p>After all the files have been loaded, the values of the
10187: variables cannot be changed anymore. Variables that are used in
10188: the shell commands are expanded at this point.</p>
10189: </div>
10190: </div>
10191: <div class="sect1" lang="en">
10192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10193: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78 rillig 10194: <p>There are many ways in which the definition and use of a
10195: variable can be restricted in order to detect bugs and
10196: violations of the (mostly unwritten) policies. See the
10197: <code class="literal">pkglint</code> developer's documentation for further
10198: details.</p>
10199: </div>
10200: <div class="sect1" lang="en">
10201: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10202: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76 rillig 10203: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75 rillig 10204: of the following classes. Cases where a file falls into more
10205: than one class should be avoided as it often leads to subtle
10206: bugs.</p>
10207: <div class="sect2" lang="en">
10208: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10209: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75 rillig 10210: <p>In a traditional imperative programming language some of
1.76 rillig 10211: the <code class="filename">.mk</code> files could be described as
1.112 ! weinem 10212: procedures. They take some input parameters and—after
! 10213: inclusion—provide a result in output parameters. Since all
1.76 rillig 10214: variables in <code class="filename">Makefile</code>s have global scope
1.75 rillig 10215: care must be taken not to use parameter names that have already
10216: another meaning. For example, <code class="varname">PKGNAME</code> is a
10217: bad choice for a parameter name.</p>
10218: <p>Procedures are completely evaluated at preprocessing time.
10219: That is, when calling a procedure all input parameters must be
10220: completely resolvable. For example,
10221: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10222: parameter since it is very likely that further text will be
10223: added after calling the procedure, which would effectively apply
10224: the procedure to only a part of the variable. Also, references
10225: to other variables wit will be modified after calling the
10226: procedure.</p>
10227: <p>A procedure can declare its output parameters either as
10228: suitable for use in preprocessing directives or as only
10229: available at runtime. The latter alternative is for variables
10230: that contain references to other runtime variables.</p>
10231: <p>Procedures shall be written such that it is possible to
10232: call the procedure more than once. That is, the file must not
10233: contain multiple-inclusion guards.</p>
10234: <p>Examples for procedures are
1.76 rillig 10235: <code class="filename">mk/bsd.options.mk</code> and
10236: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75 rillig 10237: that the parameters are evaluated at load time, they should be
10238: assigned using the <code class="literal">:=</code> operator, which should
10239: be used only for this purpose.</p>
10240: </div>
10241: <div class="sect2" lang="en">
10242: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10243: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75 rillig 10244: <p>Action files take some input parameters and may define
10245: runtime variables. They shall not define loadtime variables.
10246: There are action files that are included implicitly by the
10247: pkgsrc infrastructure, while other must be included
10248: explicitly.</p>
10249: <p>An example for action files is
1.76 rillig 10250: <code class="filename">mk/subst.mk</code>.</p>
1.75 rillig 10251: </div>
10252: </div>
1.81 rillig 10253: <div class="sect1" lang="en">
10254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10255: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81 rillig 10256: <p>Package <code class="filename">Makefile</code>s usually consist of
10257: a set of variable definitions, and include the file
10258: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10259: Before that, they may also include various other
10260: <code class="filename">*.mk</code> files if they need to query the
10261: availability of certain features like the type of compiler or
10262: the X11 implementation. Due to the heavy use of preprocessor
10263: directives like <code class="literal">.if</code> and
10264: <code class="literal">.for</code>, the order in which the files are loaded
10265: matters.</p>
10266: <p>This section describes at which point the various files
10267: are loaded and gives reasons for that order.</p>
10268: <div class="sect2" lang="en">
10269: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10270: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93 rillig 10271: </h3></div></div></div>
10272: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81 rillig 10273: is to define some essential variables like
10274: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10275: <code class="varname">MACHINE_ARCH</code>.</p>
10276: <p>Then, the user settings are loaded from the file specified
1.110 hubertf 10277: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104 rillig 10278: After that, those variables
1.81 rillig 10279: that have not been overridden by the user are loaded from
10280: <code class="filename">mk/defaults/mk.conf</code>.</p>
10281: <p>After the user settings, the system settings and platform
10282: settings are loaded, which may override the user
10283: settings.</p>
10284: <p>Then, the tool definitions are loaded. The tool wrappers
10285: are not yet in effect. This only happens when building a
10286: package, so the proper variables must be used instead of the
10287: direct tool names.</p>
10288: <p>As the last steps, some essential variables from the
10289: wrapper and the package system flavor are loaded, as well as the
10290: variables that have been cached in earlier phases of a package
10291: build.</p>
10292: </div>
10293: <div class="sect2" lang="en">
10294: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10295: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93 rillig 10296: </h3></div></div></div>
1.81 rillig 10297: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10298: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10299: loaded, which fill default values for those variables that have
1.93 rillig 10300: not been defined by the package. These variables may later
1.81 rillig 10301: be used even in unrelated files.</p>
10302: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10303: provides the target <code class="literal">error-check</code> that is added
10304: as a special dependency to all other targets that use
10305: <code class="varname">DELAYED_ERROR_MSG</code> or
10306: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10307: <p>Then, the package-specific hacks from
10308: <code class="filename">hacks.mk</code> are included.</p>
10309: <p>Then, various other files follow. Most of them don't have
10310: any dependencies on what they need to have included before or
10311: after them, though some do.</p>
10312: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10313: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10314: restricts the use of these variables to all the files that have
10315: been included before. Appearances in later files will be
10316: silently ignored.</p>
10317: <p>Then, the files for the main targets are included, in the
10318: order of later execution, though the actual order should not
10319: matter.</p>
10320: <p>At last, some more files are included that don't set any
10321: interesting variables but rather just define make targets to be
10322: executed.</p>
10323: </div>
10324: </div>
1.75 rillig 10325: </div>
10326: <div class="chapter" lang="en">
10327: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10328: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75 rillig 10329: <div class="toc">
10330: <p><b>Table of Contents</b></p>
10331: <dl>
1.106 rillig 10332: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10333: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10334: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75 rillig 10335: <dd><dl>
1.106 rillig 10336: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10337: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75 rillig 10338: </dl></dd>
10339: </dl>
10340: </div>
10341: <p>The pkgsrc infrastructure consists of a large codebase,
10342: and there are many corners where every little bit of a file is
10343: well thought out, making pkgsrc likely to fail as soon as
10344: anything is changed near those parts. To prevent most changes
10345: from breaking anything, a suite of regression tests should go
10346: along with every important part of the pkgsrc infrastructure.
10347: This chapter describes how regression tests work in pkgsrc and
10348: how you can add new tests.</p>
10349: <div class="sect1" lang="en">
10350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10351: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75 rillig 10352: <p></p>
10353: </div>
10354: <div class="sect1" lang="en">
10355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10356: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91 rillig 10357: <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.110 hubertf 10358: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75 rillig 10359: can simply run that command, which will run all tests in the
1.76 rillig 10360: <code class="filename">regress</code> category.</p>
1.75 rillig 10361: </div>
10362: <div class="sect1" lang="en">
10363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10364: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76 rillig 10365: <p>Every directory in the <code class="filename">regress</code>
10366: category that contains a file called <code class="filename">spec</code>
1.75 rillig 10367: is considered a regression test. This file is a shell program
1.110 hubertf 10368: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75 rillig 10369: The following functions can be overridden to suit your
10370: needs.</p>
10371: <div class="sect2" lang="en">
10372: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10373: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75 rillig 10374: <p>These functions do not take any parameters. They are all
10375: called in “<span class="quote">set -e</span>” mode, so you should be careful
10376: to check the exitcodes of any commands you run in the
10377: test.</p>
10378: <div class="variablelist"><dl>
10379: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10380: <dd><p>This function prepares the environment for the
10381: test. By default it does nothing.</p></dd>
10382: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10383: <dd><p>This function runs the actual test. By default,
10384: it calls <code class="varname">TEST_MAKE</code> with the arguments
10385: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10386: error messages into the file
10387: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10388: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10389: <dd><p>This function is run after the test and is
10390: typically used to compare the actual output from the one that is
10391: expected. It can make use of the various helper functions from
10392: the next section.</p></dd>
10393: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10394: <dd><p>This function cleans everything up after the
10395: test has been run. By default it does nothing.</p></dd>
10396: </dl></div>
10397: </div>
10398: <div class="sect2" lang="en">
10399: <div class="titlepage"><div><div><h3 class="title">
1.106 rillig 10400: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75 rillig 10401: <div class="variablelist"><dl>
10402: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10403: <dd><p>This function compares the exitcode of the
1.110 hubertf 10404: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75 rillig 10405: If they differ, the test will fail.</p></dd>
10406: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10407: <dd><p>This function checks for each of its parameters
1.110 hubertf 10408: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75 rillig 10409: extended regular expression. If it does not, the test will
10410: fail.</p></dd>
10411: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10412: <dd><p>This function checks for each of its parameters
1.110 hubertf 10413: if the output from <span class="command"><strong>do_test()</strong></span> does
1.75 rillig 10414: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10415: If any of the regular expressions matches, the test will
10416: fail.</p></dd>
10417: </dl></div>
10418: </div>
10419: </div>
10420: </div>
10421: <div class="chapter" lang="en">
10422: <div class="titlepage"><div><div><h2 class="title">
1.106 rillig 10423: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75 rillig 10424: <div class="toc">
10425: <p><b>Table of Contents</b></p>
10426: <dl>
1.106 rillig 10427: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10428: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75 rillig 10429: </dl>
10430: </div>
10431: <p>The pkgsrc system has already been ported to many
10432: operating systems, hardware architectures and compilers. This
10433: chapter explains the necessary steps to make pkgsrc even more
10434: portable.</p>
10435: <div class="sect1" lang="en">
10436: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10437: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75 rillig 10438: <p>To port pkgsrc to a new operating system (called
10439: <code class="literal">MyOS</code> in this example), you need to touch the
10440: following files:</p>
10441: <div class="variablelist"><dl>
1.93 rillig 10442: <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 10443: <dd><p>This file contains some basic definitions, for
10444: example the name of the C
10445: compiler.</p></dd>
1.76 rillig 10446: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75 rillig 10447: <dd><p>Insert code that defines the variables
10448: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10449: <code class="varname">LOWER_OS_VERSION</code>,
10450: <code class="varname">LOWER_VENDOR</code>,
10451: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10452: <code class="varname">APPEND_ELF</code>, and the other variables that
10453: appear in this file.</p></dd>
1.93 rillig 10454: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10455: <dd><p>This file contains the platform-specific
10456: definitions that are used by pkgsrc. Start by copying one of the
10457: other files and edit it to your
10458: needs.</p></dd>
1.93 rillig 10459: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75 rillig 10460: <dd><p>This file contains a list of directories,
10461: together with their permission bits and ownership. These
10462: directories will be created automatically with every package
1.98 wiz 10463: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10464: be removed.</p></dd>
1.93 rillig 10465: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75 rillig 10466: <dd><p>Just copy one of the pre-existing x11.dist files
10467: to your
1.76 rillig 10468: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10469: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75 rillig 10470: <dd><p>On some operating systems, the tools that are
10471: provided with the base system are not good enough for pkgsrc.
1.110 hubertf 10472: For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75 rillig 10473: narrow limit on the line length they can process. Therefore
10474: pkgsrc brings its own tools, which can be enabled
10475: here.</p></dd>
1.93 rillig 10476: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75 rillig 10477: <dd><p>This file defines the paths to all the tools
10478: that are needed by one or the other package in pkgsrc, as well
10479: as by pkgsrc itself. Find out where these tools are on your
10480: platform and add them.</p></dd>
10481: </dl></div>
10482: <p>Now, you should be able to build some basic packages, like
1.91 rillig 10483: <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 10484: </div>
10485: <div class="sect1" lang="en">
10486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106 rillig 10487: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75 rillig 10488: <p>TODO</p>
10489: </div>
10490: </div>
10491: </div>
10492: <div class="appendix" lang="en">
10493: <div class="titlepage"><div><div><h2 class="title">
10494: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10495: <div class="toc">
10496: <p><b>Table of Contents</b></p>
10497: <dl>
10498: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10499: <dd><dl>
10500: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10501: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10502: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.110 hubertf 10503: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.75 rillig 10504: </dl></dd>
10505: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10506: </dl>
10507: </div>
10508: <p>We checked to find a piece of software that wasn't in the packages
10509: collection, and picked GNU bison. Quite why someone would want to have
1.110 hubertf 10510: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75 rillig 10511: present in the tree is beyond us, but it's useful for the purposes of
10512: this exercise.</p>
10513: <div class="sect1" lang="en">
10514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10515: <a name="example-files"></a>A.1. files</h2></div></div></div>
10516: <div class="sect2" lang="en">
10517: <div class="titlepage"><div><div><h3 class="title">
10518: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10519: <pre class="programlisting">
1.100 rillig 10520: # $NetBSD$
10521: #
1.1 grant 10522:
1.100 rillig 10523: DISTNAME= bison-1.25
10524: CATEGORIES= devel
10525: MASTER_SITES= ${MASTER_SITE_GNU}
1.1 grant 10526:
1.100 rillig 10527: MAINTAINER= thorpej@NetBSD.org
10528: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10529: COMMENT= GNU yacc clone
1.1 grant 10530:
1.100 rillig 10531: GNU_CONFIGURE= yes
10532: INFO_FILES= bison.info
1.1 grant 10533:
1.100 rillig 10534: .include "../../mk/bsd.pkg.mk"
1.1 grant 10535: </pre>
1.75 rillig 10536: </div>
10537: <div class="sect2" lang="en">
10538: <div class="titlepage"><div><div><h3 class="title">
10539: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10540: <pre class="programlisting">
1.100 rillig 10541: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.110 hubertf 10542: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100 rillig 10543: of the NetBSD source tree is beyond me.
1.1 grant 10544: </pre>
1.75 rillig 10545: </div>
10546: <div class="sect2" lang="en">
10547: <div class="titlepage"><div><div><h3 class="title">
10548: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10549: <pre class="programlisting">
1.100 rillig 10550: @comment $NetBSD$
10551: bin/bison
10552: man/man1/bison.1.gz
10553: share/bison.simple
10554: share/bison.hairy
1.1 grant 10555: </pre>
1.75 rillig 10556: </div>
10557: <div class="sect2" lang="en">
10558: <div class="titlepage"><div><div><h3 class="title">
1.110 hubertf 10559: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93 rillig 10560: </h3></div></div></div>
1.75 rillig 10561: <p>The NetBSD package system comes with
1.91 rillig 10562: <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 10563: which helps to check the contents of these
10564: files. After installation it is quite easy to use, just change to the
10565: directory of the package you wish to examine and execute
1.110 hubertf 10566: <span class="command"><strong>pkglint</strong></span>:</p>
1.75 rillig 10567: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10568: looks fine.</pre>
10569: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110 hubertf 10570: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75 rillig 10571: -Wall</strong></span> for a very thorough check.</p>
10572: </div>
10573: </div>
10574: <div class="sect1" lang="en">
10575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10576: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10577: <p>Create the directory where the package lives,
10578: plus any auxiliary directories:</p>
10579: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10580: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10581: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10582: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76 rillig 10583: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110 hubertf 10584: <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75 rillig 10585: then continue with fetching the distfile:</p>
10586: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1 grant 10587: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10588: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10589: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10590: ftp: Error retrieving file: 500 Internal error
10591:
10592: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10593: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10594: ftp: Error retrieving file: 500 Internal error
10595:
10596: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10597: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75 rillig 10598: Successfully retrieved file.</pre>
10599: <p>Generate the checksum of the distfile into
1.76 rillig 10600: <code class="filename">distinfo</code>:</p>
1.88 wiz 10601: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75 rillig 10602: <p>Now compile:</p>
10603: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10604: >> Checksum OK for bison-1.25.tar.gz.
10605: ===> Extracting for bison-1.25
10606: ===> Patching for bison-1.25
10607: ===> Ignoring empty patch directory
10608: ===> Configuring for bison-1.25
10609: creating cache ./config.cache
10610: checking for gcc... cc
10611: checking whether we are using GNU C... yes
10612: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10613: checking how to run the C preprocessor... cc -E
10614: checking for minix/config.h... no
10615: checking for POSIXized ISC... no
10616: checking whether cross-compiling... no
10617: checking for ANSI C header files... yes
10618: checking for string.h... yes
10619: checking for stdlib.h... yes
10620: checking for memory.h... yes
10621: checking for working const... yes
10622: checking for working alloca.h... no
10623: checking for alloca... yes
10624: checking for strerror... yes
10625: updating cache ./config.cache
10626: creating ./config.status
10627: creating Makefile
10628: ===> Building for bison-1.25
10629: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
10630: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
10631: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
10632: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
10633: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
1.68 rillig 10634: 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 10635: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
10636: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
10637: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
10638: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
10639: 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
10640: 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
10641: 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
10642: 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
10643: 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
10644: 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
10645: 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
10646: 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
10647: 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
10648: 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
10649: 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
10650: 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
10651: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10652: rm -f bison.s1
1.75 rillig 10653: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10654: <p>Everything seems OK, so install the files:</p>
10655: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10656: >> Checksum OK for bison-1.25.tar.gz.
10657: ===> Installing for bison-1.25
10658: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
10659: rm -f /usr/pkg/bin/bison
10660: cd /usr/pkg/share; rm -f bison.simple bison.hairy
10661: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10662: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10663: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10664: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10665: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10666: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75 rillig 10667: ===> Registering installation for bison-1.25</pre>
10668: <p>You can now use bison, and also - if you decide so - remove it with
1.110 hubertf 10669: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75 rillig 10670: binary package, do this now:</p>
10671: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10672: >> Checksum OK for bison-1.25.tar.gz.
10673: ===> Building package for bison-1.25
10674: Creating package bison-1.25.tgz
10675: Registering depends:.
1.75 rillig 10676: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10677: <p>Now that you don't need the source and object files
10678: any more, clean up:</p>
10679: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10680: ===> Cleaning for bison-1.25</pre>
10681: </div>
10682: </div>
10683: <div class="appendix" lang="en">
10684: <div class="titlepage"><div><div><h2 class="title">
10685: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10686: <div class="toc">
10687: <p><b>Table of Contents</b></p>
10688: <dl>
10689: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10690: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10691: </dl>
10692: </div>
10693: <div class="sect1" lang="en">
10694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10695: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10696: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1 grant 10697: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10698: => figlet221.tar.gz doesn't seem to exist on this system.
10699: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10700: => [172219 bytes]
10701: Connected to ftp.plig.net.
10702: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10703: 331 Guest login ok, send your complete e-mail address as password.
10704: 230-You are user #5 of 500 simultaneous users allowed.
10705: 230-
1.68 rillig 10706: 230- ___ _ _ _
10707: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
1.1 grant 10708: 230- | _| _| . |_| . | | | . |_| . | _| . |
10709: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
10710: 230- |_| |_| |___| |___|
10711: 230-
10712: 230-** Welcome to ftp.plig.org **
10713: 230-
10714: 230-Please note that all transfers from this FTP site are logged. If you
10715: 230-do not like this, please disconnect now.
10716: 230-
10717: 230-This arhive is available via
10718: 230-
10719: 230-HTTP: http://ftp.plig.org/
10720: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
10721: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
10722: 230-
10723: 230-Please email comments, bug reports and requests for packages to be
1.68 rillig 10724: 230-mirrored to ftp-admin@plig.org.
1.1 grant 10725: 230-
10726: 230-
10727: 230 Logged in anonymously.
10728: Remote system type is UNIX.
10729: Using binary mode to transfer files.
10730: 200 Type okay.
10731: 250 "/pub" is new cwd.
10732: 250-"/pub/figlet" is new cwd.
10733: 250-
10734: 250-Welcome to the figlet archive at ftp.figlet.org
1.68 rillig 10735: 250-
1.75 rillig 10736: 250- ftp://ftp.figlet.org/pub/figlet/
1.1 grant 10737: 250-
10738: 250-The official FIGlet web page is:
1.75 rillig 10739: 250- http://www.figlet.org/
1.1 grant 10740: 250-
10741: 250-If you have questions, please mailto:info@figlet.org. If you want to
10742: 250-contribute a font or something else, you can email us.
1.68 rillig 10743: 250
1.1 grant 10744: 250 "/pub/figlet/program" is new cwd.
10745: 250 "/pub/figlet/program/unix" is new cwd.
10746: local: figlet221.tar.gz remote: figlet221.tar.gz
10747: 502 Unimplemented command.
10748: 227 Entering Passive Mode (195,40,6,41,246,104)
10749: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10750: 38% |************** | 65800 64.16 KB/s 00:01 ETA
10751: 226 Transfer completed.
10752: 172219 bytes received in 00:02 (75.99 KB/s)
10753: 221 Goodbye.
10754: => Checksum OK for figlet221.tar.gz.
10755: ===> Extracting for figlet-2.2.1nb2
10756: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10757: ===> Patching for figlet-2.2.1nb2
10758: ===> Applying pkgsrc patches for figlet-2.2.1nb2
10759: ===> Overriding tools for figlet-2.2.1nb2
10760: ===> Creating toolchain wrappers for figlet-2.2.1nb2
10761: ===> Configuring for figlet-2.2.1nb2
10762: ===> Building for figlet-2.2.1nb2
10763: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
10764: chmod a+x figlet
10765: gcc -O2 -o chkfont chkfont.c
10766: => Unwrapping files-to-be-installed.
1.14 xtraeme 10767: <code class="prompt">#</code>
1.75 rillig 10768: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1 grant 10769: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10770: ===> Installing for figlet-2.2.1nb2
10771: install -d -o root -g wheel -m 755 /usr/pkg/bin
10772: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10773: mkdir -p /usr/pkg/share/figlet
10774: cp figlet /usr/pkg/bin
10775: cp chkfont /usr/pkg/bin
10776: chmod 555 figlist showfigfonts
10777: cp figlist /usr/pkg/bin
10778: cp showfigfonts /usr/pkg/bin
10779: cp fonts/*.flf /usr/pkg/share/figlet
10780: cp fonts/*.flc /usr/pkg/share/figlet
10781: cp figlet.6 /usr/pkg/man/man6
10782: ===> Registering installation for figlet-2.2.1nb2
1.75 rillig 10783: <code class="prompt">#</code></pre>
10784: </div>
10785: <div class="sect1" lang="en">
10786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10787: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10788: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1 grant 10789: ===> Checking for vulnerabilities in figlet-2.2.1nb2
10790: ===> Packaging figlet-2.2.1nb2
10791: ===> Building binary package for figlet-2.2.1nb2
10792: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10793: Using SrcDir value of /usr/pkg
1.68 rillig 10794: Registering depends:.
1.75 rillig 10795: <code class="prompt">#</code></pre>
10796: </div>
10797: </div>
10798: <div class="appendix" lang="en">
10799: <div class="titlepage"><div><div><h2 class="title">
1.76 rillig 10800: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10801: <div class="toc">
10802: <p><b>Table of Contents</b></p>
10803: <dl>
10804: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</a></span></dt>
10805: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10806: <dt><span class="sect1"><a href="#ftp-iso">C.3. <code class="filename">iso</code>: Currently empty</a></span></dt>
10807: <dt><span class="sect1"><a href="#ftp-misc">C.4. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
1.102 rillig 10808: <dt><span class="sect1"><a href="#ftp-packages">C.5. <code class="filename">packages</code>: Binary packages</a></span></dt>
1.108 rillig 10809: <dt><span class="sect1"><a href="#ftp-reports">C.6. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10810: <dt><span class="sect1"><a href="#ftp-source">C.7. <code class="filename">current</code>,
1.93 rillig 10811: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10812: source packages</a></span></dt>
10813: </dl>
10814: </div>
10815: <p>As in other big projects, the directory layout of pkgsrc
10816: is quite complex for newbies. This chapter explains where you
10817: find things on the FTP server. The base directory on
1.110 hubertf 10818: <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89 rillig 10819: On other servers it may be different, but inside this directory,
10820: everything should look the same, no matter on which server you
10821: are. This directory contains some subdirectories, which are
10822: explained below.</p>
1.76 rillig 10823: <div class="sect1" lang="en">
10824: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10825: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109 rillig 10826: <p>This directory used to contain binary packages of the
10827: package management tools for various platforms. For those
10828: package collections that need them, they are now stored near the
1.110 hubertf 10829: binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.109 rillig 10830: directory</a>.</p>
1.76 rillig 10831: </div>
10832: <div class="sect1" lang="en">
10833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10834: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10835: <p>The directory <code class="filename">distfiles</code> contains lots
10836: of archive files from all pkgsrc packages, which are mirrored
10837: here. The subdirectories are called after their package names
10838: and are used when the distributed files have names that don't
10839: explicitly contain a version number or are otherwise too generic
10840: (for example <code class="filename">release.tar.gz</code>).</p>
10841: </div>
10842: <div class="sect1" lang="en">
10843: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10844: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
10845: <p>This directory is currently not in use.</p>
10846: </div>
10847: <div class="sect1" lang="en">
10848: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10849: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10850: <p>This directory contains things that individual pkgsrc
10851: developers find worth publishing.</p>
10852: </div>
10853: <div class="sect1" lang="en">
10854: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102 rillig 10855: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10856: <p>This directory contains binary packages for the various
10857: platforms that are supported by pkgsrc.
10858: 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>
10859: <div class="itemizedlist"><ul type="disc">
1.108 rillig 10860: <li><p><code class="varname">OPSYS</code> is the name of the
1.109 rillig 10861: operating system for which the packages have been built. The
1.110 hubertf 10862: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109 rillig 10863: command, so it may differ from the one you are used to
10864: hear.</p></li>
1.108 rillig 10865: <li><p><code class="varname">ARCH</code> is the hardware
10866: architecture of the platform for which the packages have been
1.110 hubertf 10867: built. It also includes the <code class="varname">ABI</code> (Application
10868: Binary Interface) for platforms that have several of
10869: them.</p></li>
1.108 rillig 10870: <li><p><code class="varname">OSVERSION</code> is the version of
10871: the operating system. For version numbers that change often (for
10872: example NetBSD-current), the often-changing part should be
10873: replaced with an <code class="literal">x</code>, for example
10874: <code class="literal">4.99.x</code>.</p></li>
10875: <li><p><code class="varname">TAG</code> is either
10876: <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
10877: for a stable branch, or <code class="literal">head</code> for packages
10878: built from the HEAD branch. The latter should only be used when
10879: the packages are updated on a regular basis. Otherwise the date
10880: from checking out pkgsrc should be appended, for example
10881: <code class="literal">head_20071015</code>.</p></li>
1.102 rillig 10882: </ul></div>
10883: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10884: can quickly click through the directories on the
10885: server and find the best binary packages for their machines. Since they
10886: usually know the operating system and the hardware architecture, OPSYS
10887: and ARCH are placed first. After these choices, they can select the
10888: best combination of OSVERSION and TAG together, since it is usually the
10889: case that packages stay compatible between different version of the
10890: operating system.</p>
10891: <p>In each of these directories, there is a
10892: whole binary packages collection for a specific platform. It has a directory called
1.76 rillig 10893: <code class="filename">All</code> which contains all binary packages.
10894: Besides that, there are various category directories that
10895: contain symbolic links to the real binary packages.</p>
10896: </div>
10897: <div class="sect1" lang="en">
10898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108 rillig 10899: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
10900: <p>Here are the reports from bulk builds, for those who want
10901: to fix packages that didn't build on some of the platforms. The
1.110 hubertf 10902: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.108 rillig 10903: </div>
10904: <div class="sect1" lang="en">
10905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10906: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93 rillig 10907: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76 rillig 10908: source packages</h2></div></div></div>
10909: <p>These directories contain the “<span class="quote">real</span>” pkgsrc,
10910: that is the files that define how to create binary packages from
10911: source archives.</p>
10912: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89 rillig 10913: snapshot of the CVS repository, which is updated regularly. The
10914: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10915: directory, ready to be downloaded as a whole.</p>
1.76 rillig 10916: <p>In the directories for the quarterly branches, there is an
10917: additional file called
10918: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10919: which contains the state of pkgsrc when it was branched.</p>
10920: </div>
1.75 rillig 10921: </div>
10922: <div class="appendix" lang="en">
10923: <div class="titlepage"><div><div><h2 class="title">
10924: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
10925: <div class="toc">
10926: <p><b>Table of Contents</b></p>
10927: <dl>
1.79 rillig 10928: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75 rillig 10929: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
10930: </dl>
10931: </div>
1.79 rillig 10932: <p>This section contains information on editing the pkgsrc
10933: guide itself.</p>
1.75 rillig 10934: <div class="sect1" lang="en">
10935: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79 rillig 10936: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
10937: <p>The pkgsrc guide's source code is stored in
10938: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
10939: are created from it:</p>
10940: <div class="itemizedlist"><ul type="disc">
10941: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
10942: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110 hubertf 10943: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
10944: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79 rillig 10945: The PDF version of the pkgsrc guide.</p></li>
1.110 hubertf 10946: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79 rillig 10947: PostScript version of the pkgsrc guide.</p></li>
1.75 rillig 10948: </ul></div>
10949: </div>
10950: <div class="sect1" lang="en">
10951: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10952: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79 rillig 10953: <p>The procedure to edit the pkgsrc guide is:</p>
10954: <div class="procedure"><ol type="1">
10955: <li><p>Make sure you have the packages needed to
1.83 wiz 10956: regenerate the pkgsrc guide (and other XML-based NetBSD
1.91 rillig 10957: 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
10958: 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 10959: PostScript and PDF versions. You will need both packages
10960: installed, to make sure documentation is consistent across all
10961: formats.</p></li>
1.110 hubertf 10962: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79 rillig 10963: right directory. All further steps will take place
10964: here.</p></li>
10965: <li><p>Edit the XML file(s) in
10966: <code class="filename">files/</code>.</p></li>
1.110 hubertf 10967: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79 rillig 10968: guide for valid XML and to build the final output files. If you
10969: get any errors at this stage, you can just edit the files, as
10970: there are only symbolic links in the working directory, pointing
10971: to the files in <code class="filename">files/</code>.</p></li>
1.110 hubertf 10972: <li><p><span class="command"><strong>(cd files && cvs
1.79 rillig 10973: commit)</strong></span></p></li>
1.110 hubertf 10974: <li><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.79 rillig 10975: regenerate the output files with the proper RCS
10976: Ids.</p></li>
1.91 rillig 10977: <li>
1.110 hubertf 10978: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91 rillig 10979: commit the files in both <code class="filename">pkgsrc/doc</code> and
10980: <code class="filename">htdocs</code>.</p>
10981: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
10982: <h3 class="title">Note</h3>
10983: <p>If you have added, removed or renamed some chapters,
1.110 hubertf 10984: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
10985: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91 rillig 10986: directory.</p>
10987: </div>
10988: </li>
1.79 rillig 10989: </ol></div>
1.75 rillig 10990: </div>
10991: </div>
10992: </div></body>
1.1 grant 10993: </html>
CVSweb <webmaster@jp.NetBSD.org>