Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.57
1.1 dsieger 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5: <title>The pkgsrc guide</title>
1.25 spz 6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1 dsieger 7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
9: </head>
1.41 asau 10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1 dsieger 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.10 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.1 dsieger 22: </div>
23: <div class="author">
24: <h3 class="author">
25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
26: </h3>
1.10 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.1 dsieger 28: </div>
29: <h3 class="corpauthor">
30: The pkgsrc Developers
31: </h3>
32: </div></div>
1.4 rillig 33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6 rillig 34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.41 asau 35: <div><div class="abstract">
1.1 dsieger 36: <p class="title"><b>Abstract</b></p>
37: <p>pkgsrc is a centralized package management system for
38: Unix-like operating systems. This guide provides information for
39: users and developers of pkgsrc. It covers installation of binary
40: and source packages, creation of binary and source packages and
41: a high-level overview about the infrastructure.</p>
42: </div></div>
43: </div>
44: <hr>
45: </div>
46: <div class="toc">
47: <p><b>Table of Contents</b></p>
48: <dl>
49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
50: <dd><dl>
51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
52: <dd><dl>
53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
55: </dl></dd>
56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
60: </dl></dd>
61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
62: <dd><dl>
63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
64: <dd><dl>
65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
66: <dd><dl>
1.51 asau 67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 69: </dl></dd>
70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
71: <dd><dl>
72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
74: </dl></dd>
75: </dl></dd>
76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
77: <dd><dl>
78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
81: <dd><dl>
1.45 obache 82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
85: <dt><span class="sect2"><a href="#interix">3.3.4. Interix</a></span></dt>
86: <dt><span class="sect2"><a href="#irix">3.3.5. IRIX</a></span></dt>
87: <dt><span class="sect2"><a href="#linux">3.3.6. Linux</a></span></dt>
1.57 ! bsiegert 88: <dt><span class="sect2"><a href="#mirbsd">3.3.7. MirBSD</a></span></dt>
! 89: <dt><span class="sect2"><a href="#openbsd">3.3.8. OpenBSD</a></span></dt>
! 90: <dt><span class="sect2"><a href="#solaris">3.3.9. Solaris</a></span></dt>
1.1 dsieger 91: </dl></dd>
92: </dl></dd>
93: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
94: <dd><dl>
95: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
96: <dd><dl>
97: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
98: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
99: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
100: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
101: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
102: <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>
103: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
104: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
105: </dl></dd>
106: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
107: <dd><dl>
108: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
109: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
110: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
111: </dl></dd>
112: </dl></dd>
113: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
114: <dd><dl>
115: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
116: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 117: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 118: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 119: <dd><dl>
1.4 rillig 120: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 121: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
122: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 123: </dl></dd>
1.4 rillig 124: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
125: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 126: </dl></dd>
127: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
128: <dd><dl>
129: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
130: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 131: </dl></dd>
132: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
133: builds)</a></span></dt>
1.1 dsieger 134: <dd><dl>
1.6 rillig 135: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
136: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
137: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
138: <dd><dl>
139: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
140: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
141: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
142: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
143: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
144: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
145: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
146: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
147: </dl></dd>
148: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 149: <dd><dl>
150: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
151: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
152: </dl></dd>
1.6 rillig 153: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
154: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
155: </dl></dd>
156: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
157: <dd><dl>
1.23 wiz 158: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
159: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 160: </dl></dd>
161: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
162: <dd><dl>
163: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
164: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
165: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
166: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
167: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
168: <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>
169: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23 wiz 170: <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.6 rillig 171: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23 wiz 172: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
173: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
174: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.6 rillig 175: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
176: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
177: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23 wiz 178: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6 rillig 179: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.23 wiz 180: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 181: </dl></dd>
182: </dl></dd>
183: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
184: <dd><dl>
1.6 rillig 185: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 186: <dd><dl>
1.6 rillig 187: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 188: <dd><dl>
1.6 rillig 189: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
190: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17 imil 191: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 192: </dl></dd>
1.6 rillig 193: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
194: <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>
195: </dl></dd>
196: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
197: <dd><dl>
1.23 wiz 198: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
199: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 200: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
201: <dd><dl>
202: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
203: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
204: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
205: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
206: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
207: </dl></dd>
208: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
209: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
210: <dd><dl>
211: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
212: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
213: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
214: </dl></dd>
1.23 wiz 215: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
216: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 217: </dl></dd>
1.23 wiz 218: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 219: <dd><dl>
220: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 221: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 222: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
223: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
224: <dd><dl>
225: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
226: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
227: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
228: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
229: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
230: </dl></dd>
231: </dl></dd>
232: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
233: <dd><dl>
234: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 235: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
236: <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.6 rillig 237: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
238: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 239: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 240: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
241: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
242: </dl></dd>
243: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
244: <dd><dl>
245: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 246: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 247: <dd><dl>
248: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 249: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
250: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
251: and
252: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
253: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 254: </dl></dd>
1.23 wiz 255: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 256: <dd><dl>
1.23 wiz 257: <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>
1.6 rillig 258: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
259: </dl></dd>
260: </dl></dd>
261: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
262: <dd><dl>
263: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
264: <dd><dl>
265: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
266: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
267: </dl></dd>
268: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
269: <dd><dl>
1.23 wiz 270: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 271: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
272: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
273: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
274: </dl></dd>
275: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
276: <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>
277: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
278: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
279: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
280: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
281: <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>
282: </dl></dd>
283: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
284: <dd><dl>
285: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 286: <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>
1.6 rillig 287: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 288: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 289: </dl></dd>
290: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
291: <dd><dl>
292: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
293: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
294: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
295: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 296: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 297: <dd><dl>
298: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
299: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
300: </dl></dd>
1.23 wiz 301: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
302: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
303: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
304: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
305: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
306: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
307: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
308: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
309: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
310: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 311: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
312: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
313: </dl></dd>
314: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
315: <dd><dl>
316: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
317: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
318: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
319: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
320: </dl></dd>
321: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
322: <dd><dl>
323: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
324: <dd><dl>
325: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 326: <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>
1.6 rillig 327: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
328: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
329: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
330: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
331: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
332: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
333: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
334: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
335: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
336: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
337: </dl></dd>
1.23 wiz 338: <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>
1.6 rillig 339: <dd><dl>
340: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
341: <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>
342: </dl></dd>
1.23 wiz 343: <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>
1.6 rillig 344: <dd><dl>
345: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
346: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
347: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
348: </dl></dd>
349: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
350: <dd><dl>
351: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
352: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
353: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 354: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
355: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 356: </dl></dd>
1.23 wiz 357: <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>
1.6 rillig 358: <dd><dl>
359: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
360: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 361: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 362: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
363: </dl></dd>
1.23 wiz 364: <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>
1.6 rillig 365: <dd><dl>
366: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
367: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
368: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
369: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
370: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
371: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
372: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
373: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 374: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 375: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 376: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
377: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
378: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
379: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
380: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
381: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
382: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
383: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 384: emulation</a></span></dt>
1.6 rillig 385: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
386: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 387: </dl></dd>
1.6 rillig 388: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 389: </dl></dd>
1.6 rillig 390: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
391: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 392: <dd><dl>
1.6 rillig 393: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
394: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
395: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 396: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 397: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 398: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
399: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 400: </dl></dd>
401: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
402: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
403: <dd><dl>
404: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
405: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
406: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
407: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 408: </dl></dd>
409: </dl></dd>
410: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
411: <dd><dl>
1.6 rillig 412: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 413: <dd><dl>
1.6 rillig 414: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
415: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
416: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 417: <dd><dl>
1.6 rillig 418: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
419: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 420: </dl></dd>
1.6 rillig 421: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
422: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 423: <dd><dl>
1.6 rillig 424: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
425: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 426: </dl></dd>
1.6 rillig 427: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 428: <dd><dl>
1.23 wiz 429: <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>
430: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 431: </dl></dd>
432: </dl></dd>
1.6 rillig 433: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 434: <dd><dl>
1.6 rillig 435: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
436: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
437: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 438: <dd><dl>
1.6 rillig 439: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
440: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 441: </dl></dd>
442: </dl></dd>
1.6 rillig 443: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 444: <dd><dl>
1.6 rillig 445: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
446: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 447: </dl></dd>
448: </dl></dd>
449: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
450: <dd><dl>
451: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
452: <dd><dl>
453: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
454: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
455: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 456: <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.1 dsieger 457: </dl></dd>
458: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
459: </dl></dd>
460: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
461: <dd><dl>
462: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
463: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
464: </dl></dd>
465: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
466: <dd><dl>
1.23 wiz 467: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
468: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
469: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
470: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
471: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
472: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 473: source packages</a></span></dt>
474: </dl></dd>
475: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
476: <dd><dl>
477: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
478: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
479: </dl></dd>
480: </dl>
481: </div>
482: <div class="list-of-tables">
483: <p><b>List of Tables</b></p>
484: <dl>
485: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
486: </dt>
1.6 rillig 487: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1 dsieger 488: </dt>
1.6 rillig 489: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1 dsieger 490: </dt>
491: </dl>
492: </div>
1.41 asau 493: <div class="chapter">
494: <div class="titlepage"><div><div><h1 class="title">
495: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1 dsieger 496: <div class="toc">
497: <p><b>Table of Contents</b></p>
498: <dl>
499: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
500: <dd><dl>
501: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
502: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
503: </dl></dd>
504: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
505: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
506: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
507: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
508: </dl>
509: </div>
1.41 asau 510: <div class="sect1">
1.1 dsieger 511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
512: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
513: <p>There is a lot of software freely available for Unix-based
514: systems, which is usually available in form of the source code. Before
515: such software can be used, it needs to be configured to the local
516: system, compiled and installed, and this is exactly what The NetBSD
517: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
518: to handle binary packages, so that not every user has to build the
519: packages for himself, which is a time-costly task.</p>
520: <p>pkgsrc currently contains several thousand packages,
521: including:</p>
1.41 asau 522: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 523: <li class="listitem"><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.1 dsieger 524: web server</p></li>
1.23 wiz 525: <li class="listitem"><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.1 dsieger 526: web browser</p></li>
1.23 wiz 527: <li class="listitem"><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.1 dsieger 528: Desktop Environment</p></li>
1.23 wiz 529: <li class="listitem"><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.1 dsieger 530: Desktop Environment</p></li>
531: </ul></div>
532: <p>...just to name a few.</p>
533: <p>pkgsrc has built-in support for handling varying dependencies,
534: such as pthreads and X11, and extended features such as IPv6 support on
535: a range of platforms.</p>
1.41 asau 536: <div class="sect2">
1.1 dsieger 537: <div class="titlepage"><div><div><h3 class="title">
538: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
539: <p>
540: pkgsrc provides the following key features:
541: </p>
1.41 asau 542: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 543: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1 dsieger 544: and installation of binary packages. The source and latest
545: patches are retrieved from a master or mirror download site, checksum
546: verified, then built on your system. Support for binary-only
547: distributions is available for both native platforms and NetBSD
548: emulated platforms.</p></li>
1.23 wiz 549: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1 dsieger 550: including binaries, libraries, man pages and other
551: documentation.</p></li>
1.23 wiz 552: <li class="listitem"><p>Package dependencies, including when performing package updates,
1.1 dsieger 553: are handled automatically. The configuration files of various
554: packages are handled automatically during updates, so local changes
555: are preserved.</p></li>
1.23 wiz 556: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1 dsieger 557: consists of highly portable code. This allows the greatest speed of
1.25 spz 558: development when porting to a new platform. This portability also
1.1 dsieger 559: ensures that pkgsrc is <span class="emphasis"><em>consistent across all
560: platforms</em></span>.</p></li>
1.23 wiz 561: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1 dsieger 562: international encryption requirements and build-time options for a
563: large number of packages are all set in a simple, central
564: configuration file.</p></li>
1.23 wiz 565: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1 dsieger 566: freely available under a BSD license, so you may extend and adapt
567: pkgsrc to your needs. Support for local packages and patches is
568: available right out of the box, so you can configure it specifically
569: for your environment.</p></li>
570: </ul></div>
571: <p>The following principles are basic to pkgsrc:</p>
1.41 asau 572: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 573: <li class="listitem"><p><span class="quote">“<span class="quote">It should only work if it's right.</span>”</span>
1.14 jmcneill 574: — That means, if a package contains bugs, it's better to find
1.1 dsieger 575: them and to complain about them rather than to just install the package
576: and hope that it works. There are numerous checks in pkgsrc that try to
577: 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
578: of shell scripts), and post-installation checks (installed files,
579: references to shared libraries, script interpreters).</p></li>
1.23 wiz 580: <li class="listitem"><p><span class="quote">“<span class="quote">If it works, it should work everywhere</span>”</span>
1.14 jmcneill 581: — Like NetBSD has been ported to many hardware architectures,
1.1 dsieger 582: pkgsrc has been ported to many operating systems. Care is taken that
583: packages behave the same on all platforms.</p></li>
584: </ul></div>
585: </div>
1.41 asau 586: <div class="sect2">
1.1 dsieger 587: <div class="titlepage"><div><div><h3 class="title">
588: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
589: <p>pkgsrc consists of both a source distribution and a binary
590: distribution for these operating systems. After retrieving the required
591: source or binaries, you can be up and running with pkgsrc in just
592: minutes!</p>
593: <p>pkgsrc was derived from FreeBSD's ports system, and
594: initially developed for NetBSD only. Since then, pkgsrc has
595: grown a lot, and now supports the following platforms:</p>
596: <div class="table">
597: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
598: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
599: <colgroup>
600: <col>
601: <col>
602: </colgroup>
603: <thead><tr>
604: <th>Platform</th>
605: <th>Date Support Added</th>
606: </tr></thead>
607: <tbody>
608: <tr>
1.10 hubertf 609: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1 dsieger 610: <td align="center">Aug 1997</td>
611: </tr>
612: <tr>
1.10 hubertf 613: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1 dsieger 614: <td align="center">Mar 1999</td>
615: </tr>
616: <tr>
1.10 hubertf 617: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1 dsieger 618: <td align="center">Jun 1999</td>
619: </tr>
620: <tr>
621: <td>
1.10 hubertf 622: <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
623: (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1 dsieger 624: </td>
625: <td align="center">Oct 2001</td>
626: </tr>
627: <tr>
1.10 hubertf 628: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1 dsieger 629: <td align="center">Nov 2002</td>
630: </tr>
631: <tr>
1.10 hubertf 632: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1 dsieger 633: <td align="center">Nov 2002</td>
634: </tr>
635: <tr>
1.10 hubertf 636: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1 dsieger 637: <td align="center">Dec 2002</td>
638: </tr>
639: <tr>
640: <td>BSD/OS</td>
641: <td align="center">Dec 2003</td>
642: </tr>
643: <tr>
1.10 hubertf 644: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1 dsieger 645: <td align="center">Dec 2003</td>
646: </tr>
647: <tr>
648: <td>
1.10 hubertf 649: <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1 dsieger 650: (Microsoft Windows Services for Unix)
651: </td>
652: <td align="center">Mar 2004</td>
653: </tr>
654: <tr>
1.10 hubertf 655: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1 dsieger 656: <td align="center">Oct 2004</td>
657: </tr>
658: <tr>
1.10 hubertf 659: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1 dsieger 660: <td align="center">Nov 2004</td>
661: </tr>
662: <tr>
1.10 hubertf 663: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1 dsieger 664: <td align="center">Apr 2007</td>
665: </tr>
1.23 wiz 666: <tr>
667: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
668: <td align="center">Sep 2010</td>
669: </tr>
1.45 obache 670: <tr>
671: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57 ! bsiegert 672: <td align="center">Jan 2011</td>
1.45 obache 673: </tr>
674: <tr>
675: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
676: <td align="center">Nov 2011</td>
677: </tr>
678: <tr>
679: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
680: <td align="center">Mar 2013</td>
681: </tr>
1.1 dsieger 682: </tbody>
683: </table></div>
684: </div>
685: <br class="table-break">
686: </div>
687: </div>
1.41 asau 688: <div class="sect1">
1.1 dsieger 689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
690: <a name="overview"></a>1.2. Overview</h2></div></div></div>
691: <p>This document is divided into three parts. The first,
1.10 hubertf 692: <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1 dsieger 693: describes how one can use one of the packages in the Package
694: Collection, either by installing a precompiled binary package,
695: or by building one's own copy using the NetBSD package system.
1.10 hubertf 696: 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.1 dsieger 697: package so it can be easily built by other NetBSD users without
698: knowing about the package's building details. The third part,
1.10 hubertf 699: <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1 dsieger 700: is intended for those who want to understand how pkgsrc is
701: implemented.</p>
702: <p>This document is available in various formats:
1.10 hubertf 703: <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.1 dsieger 704: </div>
1.41 asau 705: <div class="sect1">
1.1 dsieger 706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
707: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23 wiz 708: <p>There has been a lot of talk about <span class="quote">“<span class="quote">ports</span>”</span>,
709: <span class="quote">“<span class="quote">packages</span>”</span>, etc. so far. Here is a description of all the
1.1 dsieger 710: terminology used within this document.</p>
1.41 asau 711: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 712: <dt><span class="term">Package</span></dt>
713: <dd><p>A set of files and building instructions
714: that describe what's necessary
715: to build a certain piece of software using
716: pkgsrc. Packages are traditionally stored under
717: <code class="filename">/usr/pkgsrc</code>.</p></dd>
718: <dt><span class="term">The NetBSD package system</span></dt>
1.23 wiz 719: <dd><p>This is the former name of <span class="quote">“<span class="quote">pkgsrc</span>”</span>. It
1.1 dsieger 720: is part of the NetBSD operating system and can be bootstrapped
721: to run on non-NetBSD operating systems as well. It handles
722: building (compiling), installing, and removing of
723: packages.</p></dd>
724: <dt><span class="term">Distfile</span></dt>
725: <dd><p>This term describes the file or files that are
726: provided by the author of the piece of software to
727: distribute his work. All the changes necessary to build on
728: NetBSD are reflected in the corresponding package. Usually
729: the distfile is in the form of a compressed tar-archive,
730: but other types are possible, too. Distfiles are usually
731: stored below
732: <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
733: <dt><span class="term">Port</span></dt>
734: <dd><p>This is the term used by FreeBSD and OpenBSD people
735: for what we call a package.
1.23 wiz 736: In NetBSD terminology, <span class="quote">“<span class="quote">port</span>”</span> refers to a different
1.1 dsieger 737: architecture.</p></dd>
738: <dt><span class="term">Precompiled/binary package</span></dt>
739: <dd>
740: <p>A set of binaries built with pkgsrc from a distfile
741: and stuffed together in a single <code class="filename">.tgz</code>
742: file so it can be installed on machines of the same
743: machine architecture without the need to
744: recompile. Packages are usually generated in
745: <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25 spz 746: an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23 wiz 747: <p>Sometimes, this is referred to by the term <span class="quote">“<span class="quote">package</span>”</span> too,
1.1 dsieger 748: especially in the context of precompiled packages.</p>
749: </dd>
750: <dt><span class="term">Program</span></dt>
751: <dd><p>The piece of software to be installed which will be
752: constructed from all the files in the distfile by the
753: actions defined in the corresponding package.</p></dd>
754: </dl></div>
1.41 asau 755: <div class="sect2">
1.1 dsieger 756: <div class="titlepage"><div><div><h3 class="title">
757: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41 asau 758: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 759: <dt><span class="term">pkgsrc users</span></dt>
760: <dd>
761: <p>The
762: pkgsrc users are people who use the packages provided by pkgsrc.
763: Typically they are system administrators. The people using the
1.23 wiz 764: software that is inside the packages (maybe called <span class="quote">“<span class="quote">end
765: users</span>”</span>) are not covered by the pkgsrc guide.</p>
1.1 dsieger 766: <p>There are two kinds of pkgsrc users: Some only want to
767: install pre-built binary packages. Others build the pkgsrc
768: packages from source, either for installing them directly or for
1.10 hubertf 769: 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.1 dsieger 770: documentation.</p>
771: </dd>
772: <dt><span class="term">package maintainers</span></dt>
773: <dd><p>A
1.10 hubertf 774: 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.1 dsieger 775: <dt><span class="term">infrastructure developers</span></dt>
776: <dd><p>These people are involved in all those files
777: that live in the <code class="filename">mk/</code> directory and below.
1.10 hubertf 778: 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.1 dsieger 779: too.</p></dd>
780: </dl></div>
781: </div>
782: </div>
1.41 asau 783: <div class="sect1">
1.1 dsieger 784: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
785: <a name="typography"></a>1.4. Typography</h2></div></div></div>
786: <p>When giving examples for commands, shell prompts are used to
787: show if the command should/can be issued as root, or if
1.23 wiz 788: <span class="quote">“<span class="quote">normal</span>”</span> user privileges are sufficient. We use a
1.1 dsieger 789: <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
790: shell prompt, assuming they use the C-shell or tcsh.</p>
791: </div>
792: </div>
1.41 asau 793: <div class="part">
1.1 dsieger 794: <div class="titlepage"><div><div><h1 class="title">
795: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
796: <div class="toc">
797: <p><b>Table of Contents</b></p>
798: <dl>
799: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
800: <dd><dl>
801: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
802: <dd><dl>
1.51 asau 803: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 804: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 805: </dl></dd>
806: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
807: <dd><dl>
808: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
809: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
810: </dl></dd>
811: </dl></dd>
812: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
813: <dd><dl>
814: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
815: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
816: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
817: <dd><dl>
1.45 obache 818: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
819: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
820: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
821: <dt><span class="sect2"><a href="#interix">3.3.4. Interix</a></span></dt>
822: <dt><span class="sect2"><a href="#irix">3.3.5. IRIX</a></span></dt>
823: <dt><span class="sect2"><a href="#linux">3.3.6. Linux</a></span></dt>
1.57 ! bsiegert 824: <dt><span class="sect2"><a href="#mirbsd">3.3.7. MirBSD</a></span></dt>
! 825: <dt><span class="sect2"><a href="#openbsd">3.3.8. OpenBSD</a></span></dt>
! 826: <dt><span class="sect2"><a href="#solaris">3.3.9. Solaris</a></span></dt>
1.1 dsieger 827: </dl></dd>
828: </dl></dd>
829: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
830: <dd><dl>
831: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
832: <dd><dl>
833: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
834: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
835: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
836: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
837: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
838: <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>
839: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
840: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
841: </dl></dd>
842: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
843: <dd><dl>
844: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
845: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
846: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
847: </dl></dd>
848: </dl></dd>
849: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
850: <dd><dl>
851: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
852: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 853: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 854: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 855: <dd><dl>
1.4 rillig 856: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 857: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
858: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 859: </dl></dd>
1.4 rillig 860: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
861: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 862: </dl></dd>
863: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
864: <dd><dl>
865: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
866: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6 rillig 867: </dl></dd>
868: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
869: builds)</a></span></dt>
1.1 dsieger 870: <dd><dl>
1.6 rillig 871: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
872: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
873: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
874: <dd><dl>
875: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
876: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
877: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
878: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
879: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
880: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
881: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
882: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
883: </dl></dd>
884: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 885: <dd><dl>
886: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
887: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
888: </dl></dd>
1.6 rillig 889: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
890: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
891: </dl></dd>
892: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
893: <dd><dl>
1.23 wiz 894: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
895: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6 rillig 896: </dl></dd>
897: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
898: <dd><dl>
899: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
900: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
901: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
902: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
903: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
904: <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>
905: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23 wiz 906: <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.6 rillig 907: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23 wiz 908: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
909: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
910: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.6 rillig 911: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
912: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
913: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23 wiz 914: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6 rillig 915: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.23 wiz 916: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 917: </dl></dd>
918: </dl>
919: </div>
1.41 asau 920: <div class="chapter">
1.1 dsieger 921: <div class="titlepage"><div><div><h2 class="title">
922: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
923: <div class="toc">
924: <p><b>Table of Contents</b></p>
925: <dl>
926: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
927: <dd><dl>
1.51 asau 928: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23 wiz 929: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1 dsieger 930: </dl></dd>
931: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
932: <dd><dl>
933: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
934: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
935: </dl></dd>
936: </dl>
937: </div>
938: <p>Before you download and extract the files, you need to decide
939: where you want to extract them. When using pkgsrc as root user, pkgsrc
940: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
941: free to install the sources and binary packages wherever you want in
942: your filesystem, provided that the pathname does not contain white-space
943: or other characters that are interpreted specially by the shell and some
944: other programs. A safe bet is to use only letters, digits, underscores
945: and dashes.</p>
1.41 asau 946: <div class="sect1">
1.1 dsieger 947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
948: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
949: <p>Before you download any pkgsrc files, you should decide
950: whether you want the <span class="emphasis"><em>current</em></span> branch or the
951: <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
952: quarterly basis from the current branch and only gets modified
953: for security updates. The names of the stable branches are built
954: from the year and the quarter, for example
1.21 snj 955: <code class="literal">2009Q1</code>.</p>
1.1 dsieger 956: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23 wiz 957: want to download pkgsrc. You can get it as a tar file or via CVS.
958: Both ways are described here.</p>
1.51 asau 959: <p>Note that tar archive contains CVS working copy.
960: Thus you can switch to using CVS at any later time.</p>
961: <p>Note also that quarterly branch is not frozen in stone.
962: It receives critical updates.</p>
1.41 asau 963: <div class="sect2">
1.1 dsieger 964: <div class="titlepage"><div><div><h3 class="title">
1.51 asau 965: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1 dsieger 966: <p>The primary download location for all pkgsrc files is
1.51 asau 967: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
968: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
969: (it points to the same location).
970: There are a number of subdirectories for different purposes,
971: which are 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>
972: <p>The tar archive for the current branch is in the directory
973: <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1 dsieger 974: It is autogenerated daily.</p>
1.51 asau 975: <p>To save download time we provide bzip2- and
976: xz-compressed archives which are published at
977: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
978: and
979: <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
980: respectively.
981: </p>
982: <p>You can fetch the same files using FTP.</p>
1.21 snj 983: <p>The tar file for the stable branch 2009Q1 is in the
984: directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.12 weinem 985: <p>To download a pkgsrc stable tarball, run:</p>
986: <pre class="screen">
1.22 jakllsch 987: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
988: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12 weinem 989: stable branch to be downloaded, for example,
1.23 wiz 990: <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span>.</p>
1.51 asau 991: <p>You can use fetch it also using "wget", "curl",
992: or your web browser.</p>
1.12 weinem 993: <p>Then, extract it with:</p>
1.22 jakllsch 994: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
1.12 weinem 995: <p>This will create the directory <code class="filename">pkgsrc/</code>
996: in <code class="filename">/usr/</code> and all the package source will be
997: stored under <code class="filename">/usr/pkgsrc/</code>.</p>
998: <p>To download pkgsrc-current, run:</p>
999: <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.1 dsieger 1000: </div>
1.41 asau 1001: <div class="sect2">
1.1 dsieger 1002: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 1003: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
1004: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39 wiz 1005: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.23 wiz 1006: </pre>
1007: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
1008: branch to be checked out, for example, <span class="quote">“<span class="quote">pkgsrc-2009Q1</span>”</span></p>
1009: <p>This will create the directory <code class="filename">pkgsrc/</code>
1010: in your <code class="filename">/usr/</code> directory and all the package source
1011: will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
1012: <p>To fetch the pkgsrc current branch, run:</p>
1.39 wiz 1013: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1 dsieger 1014: </pre>
1.29 dholland 1015: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23 wiz 1016: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39 wiz 1017: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23 wiz 1018: </pre>
1019: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
1020: For Bourne shells, you can set it in your <code class="filename">.profile</code>
1021: or better globally in <code class="filename">/etc/profile</code>:</p>
1022: <pre class="programlisting">
1023: # set CVS remote shell command
1024: CVS_RSH=ssh
1025: export CVS_RSH
1026: </pre>
1027: <p>By default, CVS doesn't do things like most people would expect it to do.
1028: But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
1029: in your home directory and saving the following lines to it.
1030: This file will save you lots of headache and some bug reports, so we strongly recommend it.
1031: You can find an explanation of this file in the CVS documentation.</p>
1.2 rillig 1032: <pre class="programlisting">
1033: # recommended CVS configuration file from the pkgsrc guide
1.39 wiz 1034: cvs -q -z2
1.2 rillig 1035: checkout -P
1.4 rillig 1036: update -dP
1037: diff -upN
1.2 rillig 1038: rdiff -u
1.23 wiz 1039: release -d
1.2 rillig 1040: </pre>
1.1 dsieger 1041: </div>
1042: </div>
1.41 asau 1043: <div class="sect1">
1.1 dsieger 1044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1045: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1046: <p>The preferred way to keep pkgsrc up-to-date is via CVS
1047: (which also works if you have first installed it via a tar
1048: file). It saves bandwidth and hard disk activity, compared to
1049: downloading the tar file again.</p>
1.41 asau 1050: <div class="sect2">
1.1 dsieger 1051: <div class="titlepage"><div><div><h3 class="title">
1052: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41 asau 1053: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1054: <h3 class="title">Warning</h3>
1055: <p>When updating from a tar file, you first need to
1056: completely remove the old pkgsrc directory. Otherwise those
1057: files that have been removed from pkgsrc in the mean time will
1058: not be removed on your local disk, resulting in inconsistencies.
1059: When removing the old files, any changes that you have done to
1060: the pkgsrc files will be lost after updating. Therefore updating
1061: via CVS is strongly recommended.</p>
1062: </div>
1063: <p>Note that by default the distfiles and the binary packages
1064: are saved in the pkgsrc tree, so don't forget to rescue them
1065: before updating. You can also configure pkgsrc to use other than
1066: the default directories by setting the
1067: <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10 hubertf 1068: variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1 dsieger 1069: <p>To update pkgsrc from a tar file, download the tar file as
1070: explained above. Then, make sure that you have not made any
1071: changes to the files in the pkgsrc directory. Remove the pkgsrc
1072: directory and extract the new tar file. Done.</p>
1073: </div>
1.41 asau 1074: <div class="sect2">
1.1 dsieger 1075: <div class="titlepage"><div><div><h3 class="title">
1076: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25 spz 1077: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1078: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && cvs update -dP</code></strong>
1079: </pre>
1080: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1081: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP</code></strong>
1082: </pre>
1.41 asau 1083: <div class="sect3">
1.1 dsieger 1084: <div class="titlepage"><div><div><h4 class="title">
1085: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1086: <p>When updating pkgsrc, the CVS program keeps track of the
1087: branch you selected. But if you, for whatever reason, want to
1088: switch from the stable branch to the current one, you can do it
1.23 wiz 1089: by adding the option <span class="quote">“<span class="quote">-A</span>”</span> after the
1090: <span class="quote">“<span class="quote">update</span>”</span> keyword. To switch from the current branch
1.1 dsieger 1091: back to the stable branch, add the
1.23 wiz 1092: <span class="quote">“<span class="quote">-rpkgsrc-2009Q3</span>”</span> option.</p>
1.1 dsieger 1093: </div>
1.41 asau 1094: <div class="sect3">
1.1 dsieger 1095: <div class="titlepage"><div><div><h4 class="title">
1096: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1097: <p>When you update pkgsrc, the CVS program will only touch
1098: those files that are registered in the CVS repository. That
1099: means that any packages that you created on your own will stay
1100: unmodified. If you change files that are managed by CVS, later
1101: updates will try to merge your changes with those that have been
1102: done by others. See the CVS manual, chapter
1.23 wiz 1103: <span class="quote">“<span class="quote">update</span>”</span> for details.</p>
1.1 dsieger 1104: </div>
1105: </div>
1106: </div>
1107: </div>
1.41 asau 1108: <div class="chapter">
1.1 dsieger 1109: <div class="titlepage"><div><div><h2 class="title">
1110: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1111: <div class="toc">
1112: <p><b>Table of Contents</b></p>
1113: <dl>
1114: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1115: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1116: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1117: <dd><dl>
1.45 obache 1118: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
1119: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
1120: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1121: <dt><span class="sect2"><a href="#interix">3.3.4. Interix</a></span></dt>
1122: <dt><span class="sect2"><a href="#irix">3.3.5. IRIX</a></span></dt>
1123: <dt><span class="sect2"><a href="#linux">3.3.6. Linux</a></span></dt>
1.57 ! bsiegert 1124: <dt><span class="sect2"><a href="#mirbsd">3.3.7. MirBSD</a></span></dt>
! 1125: <dt><span class="sect2"><a href="#openbsd">3.3.8. OpenBSD</a></span></dt>
! 1126: <dt><span class="sect2"><a href="#solaris">3.3.9. Solaris</a></span></dt>
1.1 dsieger 1127: </dl></dd>
1128: </dl>
1129: </div>
1.41 asau 1130: <div class="sect1">
1.1 dsieger 1131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1132: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10 hubertf 1133: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, “Using binary packages”</a>.</p>
1.1 dsieger 1134: </div>
1.41 asau 1135: <div class="sect1">
1.1 dsieger 1136: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1137: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43 asau 1138: <p>pkgsrc can be bootstrapped for use in two different modes:
1139: privileged and unprivileged one. In unprivileged mode in contrast
1.44 asau 1140: to privileged one all programs are installed under one particular user
1.43 asau 1141: and cannot utilise privileged operations (packages don't create
1142: special users and all special file permissions like setuid are ignored).
1143: </p>
1.1 dsieger 1144: <p>Installing the bootstrap kit from source should be as simple as:</p>
1145: <pre class="screen">
1146: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1147: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1148: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1149: </pre>
1.43 asau 1150: <p>To bootstrap in unprivileged mode pass <span class="quote">“<span class="quote">--unprivileged</span>”</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
1151: <p>By default, in privileged mode pkgsrc uses
1152: <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
1153: where programs will be installed in,
1.1 dsieger 1154: and <code class="filename">/var/db/pkg</code> for the package database
1.43 asau 1155: directory where pkgsrc will do its internal bookkeeping,
1156: <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
1157: where packages install their persistent data.
1158: In unprivileged mode pkgsrc uses
1159: <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1160: <code class="filename">~/pkg/var/db/pkg</code> for the package database,
1161: and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
1162: </p>
1163: <p>You can change default layout using command-line arguments.
1164: Run <span class="quote">“<span class="quote">./bootstrap --help</span>”</span> to get details.
1165: </p>
1.41 asau 1166: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1167: <h3 class="title">Note</h3>
1.10 hubertf 1168: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1169: Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1170: For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23 wiz 1171: instead of <span class="quote">“<span class="quote">make</span>”</span>.</p>
1.1 dsieger 1172: </div>
1.43 asau 1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1174: <h3 class="title">Note</h3>
1175: <p>It is possible to bootstrap multiple instances of pkgsrc
1176: using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
1177: corresponding to the installation you're working with to build
1178: and install packages.
1179: </p>
1180: </div>
1.1 dsieger 1181: </div>
1.41 asau 1182: <div class="sect1">
1.1 dsieger 1183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1184: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1185: <p>Here are some platform-specific notes you should be aware of.</p>
1.41 asau 1186: <div class="sect2">
1.1 dsieger 1187: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1188: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
1189: <p>Cygwin 1.7.x and later are supported.</p>
1190: <p>You need to install minimal base packages in `Base' category
1191: plus any of compiler, gcc, gcc4, and/or clang.
1192: For gcc and gcc4, C and C++ compiler will be installed by default,
1193: but you can install Fortran compiler additionally
1194: because it will be required to use libtool.
1195: If it is not installed (or too old), Fortran compiler will be
1196: installed with pkgsrc automatically.</p>
1197: <p>As noted in
1198: <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
1199: su(1) command has been in Cygwin distribution, but it has never worked.
1200: Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
1201: </p>
1202: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
1203: then pick "Run as administrator".</p></li></ul></div>
1204: </div>
1205: <div class="sect2">
1206: <div class="titlepage"><div><div><h3 class="title">
1207: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.41 asau 1208: <p>Darwin 5.x and up are supported.</p>
1209: <p>Before you start, you need to download and install
1210: the Mac OS X Developer Tools from Apple's Developer Connection.
1211: This requires (free) membership. See
1.22 jakllsch 1212: <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.41 asau 1213: for details. Also, make sure you install X11 (an optional
1214: package included with the Developer Tools) if you intend
1215: to build packages that use the X11 Window System.
1216: (If you don't want or need the full Xcode GUI,
1217: download and install Command Line Tools for Xcode.)</p>
1.1 dsieger 1218: </div>
1.41 asau 1219: <div class="sect2">
1.1 dsieger 1220: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1221: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.29 dholland 1222: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.1 dsieger 1223: other versions may work.</p>
1224: <p>Care should be taken so that the tools that this kit installs do not conflict
1225: with the FreeBSD userland tools. There are several steps:</p>
1.23 wiz 1226: <div class="orderedlist"><ol class="orderedlist" type="1">
1227: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.1 dsieger 1228: <code class="filename">/var/db/pkg</code>. It is therefore
1229: recommended that you choose a different location (e.g.
1230: <code class="filename">/usr/pkgdb</code>) by
1231: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1232: <li class="listitem">
1.1 dsieger 1233: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1234: good idea to move them out of the way to avoid confusion, e.g.</p>
1235: <pre class="screen">
1236: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1237: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1238: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1241: </pre>
1242: </li>
1.23 wiz 1243: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1244: <code class="filename">/etc/mk.conf.example</code> file
1245: when you use the bootstrap script.</p></li>
1246: </ol></div>
1247: </div>
1.41 asau 1248: <div class="sect2">
1.1 dsieger 1249: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1250: <a name="interix"></a>3.3.4. Interix</h3></div></div></div>
1.1 dsieger 1251: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1252: providing a Unix-like environment with a tighter kernel integration than
1253: available with Cygwin. It is part of the Windows Services for Unix
1254: package, available for free for any licensed copy of Windows 2000, XP
1.10 hubertf 1255: (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.1 dsieger 1256: <p>Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but
1257: are not officially supported. (The main difference in 3.0/3.1 is lack
1258: of pthreads, but other parts of libc may also be lacking.)</p>
1.24 wiz 1259: <p>Services for Unix Applications (aka SUA) is an integrated
1260: component of Windows Server 2003 R2 (5.2), Windows Vista and
1261: Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1262: (6.1). As of this writing, the SUA's Interix 6.0 (32bit) and
1263: 6.1 (64bit) subsystems have been tested. Other versions may
1264: work as well. The Interix 5.x subsystem has not yet been tested
1265: with pkgsrc.</p>
1.41 asau 1266: <div class="sect3">
1.1 dsieger 1267: <div class="titlepage"><div><div><h4 class="title">
1.45 obache 1268: <a name="platform.interix-sfu-install"></a>3.3.4.1. When installing Interix/SFU</h4></div></div></div>
1.1 dsieger 1269: <p>At an absolute minimum, the following packages must be installed from
1270: the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.41 asau 1271: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1272: <li class="listitem"><p>Utilities -> Base Utilities</p></li>
1273: <li class="listitem"><p>Interix GNU Components -> (all)</p></li>
1274: <li class="listitem"><p>Remote Connectivity</p></li>
1275: <li class="listitem"><p>Interix SDK</p></li>
1.1 dsieger 1276: </ul></div>
1277: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1278: "UNIX Perl". That is Perl 5.6 without shared module support, installed to
1279: /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1280: pkgsrc (or from a binary package).</p>
1281: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1282: not need to be installed, but Remote Connectivity itself should be
1283: installed in order to have a working inetd.</p>
1284: <p>During installation you may be asked whether to enable setuid
1285: behavior for Interix programs, and whether to make pathnames default to
1286: case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
1287: enabled. (Without case-sensitivity, a large number of packages including
1288: perl will not build.)</p>
1289: <p>NOTE: Newer Windows service packs change the way binary execution
1290: works (via the Data Execution Prevention feature). In order to use
1291: pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1292: POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1293: must be installed. Hotfixes are available from Microsoft through a
1.14 jmcneill 1294: support contract; however, Debian Interix Port has made most Interix
1295: hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1 dsieger 1296: <p>In addition to the hotfix noted above, it may be necessary to
1297: disable Data Execution Prevention entirely to make Interix functional.
1298: This may happen only with certain types of CPUs; the cause is not fully
1299: understood at this time. If gcc or other applications still segfault
1300: repeatedly after installing one of the hotfixes note above, the
1301: following option can be added to the appropriate "boot.ini" line on the
1302: Windows boot drive: /NoExecute=AlwaysOff
1303: (WARNING, this will disable DEP completely, which may be a security
1304: risk if applications are often run as a user in the Administrators
1305: group!)</p>
1306: </div>
1.41 asau 1307: <div class="sect3">
1.1 dsieger 1308: <div class="titlepage"><div><div><h4 class="title">
1.45 obache 1309: <a name="platform.interix-sfu-postinstall"></a>3.3.4.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.1 dsieger 1310: <p>If SFU is already installed and you wish to alter these settings to work
1311: with pkgsrc, note the following things.</p>
1.41 asau 1312: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1313: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.1 dsieger 1314: Windows Services for UNIX, then click Change. In the installer, choose
1315: Add or Remove, then uncheck Utilities->UNIX Perl.</p></li>
1.23 wiz 1316: <li class="listitem">
1.1 dsieger 1317: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1318: change the following registry key:</p>
1319: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1320: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1321: </li>
1.23 wiz 1322: <li class="listitem">
1.1 dsieger 1323: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1324: following registry key:</p>
1325: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1326: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1327: </li>
1328: </ul></div>
1329: </div>
1.41 asau 1330: <div class="sect3">
1.1 dsieger 1331: <div class="titlepage"><div><div><h4 class="title">
1.45 obache 1332: <a name="platform.interix-notes"></a>3.3.4.3. Important notes for using pkgsrc</h4></div></div></div>
1.1 dsieger 1333: <p>The package manager (either the pkgsrc "su" user, or the user
1334: running "pkg_add") must be a member of the local Administrators
1335: group. Such a user must also be used to run the bootstrap. This is
1336: slightly relaxed from the normal pkgsrc requirement of "root".</p>
1337: <p>The package manager should use a umask of 002. "make install" will
1338: automatically complain if this is not the case. This ensures that
1339: directories written in /var/db/pkg are Administrators-group writeable.</p>
1340: <p>The popular Interix binary packages from http://www.interopsystems.com/
1341: use an older version of pkgsrc's pkg_* tools. Ideally, these should
1342: NOT be used in conjunction with pkgsrc. If you choose to use them at
1343: the same time as the pkgsrc packages, ensure that you use the proper
1344: pkg_* tools for each type of binary package.</p>
1345: <p>The TERM setting used for DOS-type console windows (including those
1346: invoked by the csh and ksh startup shortcuts) is "interix". Most systems
1347: don't have a termcap/terminfo entry for it, but the following .termcap
1348: entry provides adequate emulation in most cases:</p>
1349: <pre class="programlisting">
1350: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1351: </pre>
1352: </div>
1.41 asau 1353: <div class="sect3">
1.1 dsieger 1354: <div class="titlepage"><div><div><h4 class="title">
1.45 obache 1355: <a name="platform.interix-limits"></a>3.3.4.4. Limitations of the Interix platform</h4></div></div></div>
1.1 dsieger 1356: <p>Though Interix suffices as a familiar and flexible substitute
1357: for a full Unix-like platform, it has some drawbacks that should
1358: be noted for those desiring to make the most of Interix.</p>
1.41 asau 1359: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1360: <li class="listitem">
1.1 dsieger 1361: <p><span class="strong"><strong>X11:</strong></span></p>
1362: <p>Interix comes with the standard set of X11R6 client libraries,
1363: and can run X11 based applications, but it does
1364: <span class="emphasis"><em>not</em></span> come with an X server. Some options are
1.10 hubertf 1365: <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1366: <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1 dsieger 1367: (available in a trimmed version for Interix from Interop Systems as the
1.10 hubertf 1368: <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1 dsieger 1369: and the free X11 server included with
1.10 hubertf 1370: <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1 dsieger 1371: </li>
1.23 wiz 1372: <li class="listitem">
1.1 dsieger 1373: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1374: <p>Because Interix runs in a completely different NT subsystem from
1375: Win32 applications, it does not currently support various X11
1376: protocol extensions for acceleration (such as MIT-SHM or DGA).
1377: Most interactive applications to a local X server will run
1378: reasonably fast, but full motion video and other graphics
1379: intensive applications may require a faster-than-expected CPU.</p>
1380: </li>
1.23 wiz 1381: <li class="listitem">
1.1 dsieger 1382: <p><span class="strong"><strong>Audio:</strong></span></p>
1383: <p>Interix has no native support for audio output. For audio
1.10 hubertf 1384: support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1 dsieger 1385: audio system on Interix. Unlike on most platforms, the
1386: <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.10 hubertf 1387: <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1 dsieger 1388: server component. To output audio via an Interix host, the
1389: <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
1390: must also be installed.</p>
1391: </li>
1.23 wiz 1392: <li class="listitem">
1.1 dsieger 1393: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1394: <p>Direct device access is not currently supported in Interix, so it
1395: is not currently possible to access CD/DVD drives, USB devices,
1396: or SCSI devices through non-filesystem means. Among other things,
1397: this makes it impossible to use Interix directly for CD/DVD
1398: burning.</p>
1399: </li>
1.23 wiz 1400: <li class="listitem">
1.1 dsieger 1401: <p><span class="strong"><strong>Tape drives:</strong></span></p>
1402: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1403: drives are also not directly accessible in Interix. However,
1404: support is in work to make tape drive access possible by using
1405: Cygwin as a bridge (similarly to audio bridged via Cygwin's
1406: esound server).</p>
1407: </li>
1408: </ul></div>
1409: </div>
1.41 asau 1410: <div class="sect3">
1.1 dsieger 1411: <div class="titlepage"><div><div><h4 class="title">
1.45 obache 1412: <a name="platform.interix-knownissues"></a>3.3.4.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.1 dsieger 1413: <p>It is not necessary, in general, to have a "root" user on the
1414: Windows system; any member of the local Administrators group will
1415: suffice. However, some packages currently assume that the user
1416: named "root" is the privileged user. To accommodate these, you
1417: may create such a user; make sure it is in the local group
1418: Administrators (or your language equivalent).</p>
1.10 hubertf 1419: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1 dsieger 1420: 0755, not 0775, in <code class="filename">$PKG_DBDIR</code>. For the
1421: time being, install packages as the local Administrator (or
1422: your language equivalent), or run the following command after
1423: installing a package to work around the issue:</p>
1424: <pre class="screen">
1425: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1426: </pre>
1427: </div>
1428: </div>
1.41 asau 1429: <div class="sect2">
1.1 dsieger 1430: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1431: <a name="irix"></a>3.3.5. IRIX</h3></div></div></div>
1.1 dsieger 1432: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1433: compiler (cc/c89). Please set the <code class="varname">CC</code> environment variable
1434: according to your preference. If you do not have a license for the MIPSpro
1.10 hubertf 1435: 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.1 dsieger 1436: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.29 dholland 1437: version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1 dsieger 1438: etc.</p>
1439: <p>At this point in time, pkgsrc only supports one ABI at a time. That is, you cannot
1440: switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
1441: you start out using "abi=n32", that's what all your packages will be built
1442: with.</p>
1443: <p>Therefore, please make sure that you have no conflicting
1444: <code class="varname">CFLAGS</code> in your environment or the
1.10 hubertf 1445: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Particularly, make sure that you do not
1.1 dsieger 1446: try to link n32 object files with lib64 or vice versa. Check your
1447: <code class="filename">/etc/compiler.defaults</code>!</p>
1448: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1449: please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1450: as it appears that IRIX linker occasionally runs into issues when trying to
1451: link over a network-mounted file system.</p>
1452: <p>The bootstrapping process should set all the right options for programs such
1453: as imake(1), but you may want to set some options depending on your local
1454: setup. Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1455: course, your compiler's man pages for details.</p>
1456: <p>If you are using SGI's MIPSPro compiler, please set
1457:
1458: </p>
1459: <pre class="programlisting">
1460: PKGSRC_COMPILER= mipspro
1461: </pre>
1462: <p>
1463:
1.10 hubertf 1464: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. Otherwise, pkgsrc will assume you
1.1 dsieger 1465: are using gcc and may end up passing invalid flags to the compiler. Note that
1466: bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1467: default.</p>
1468: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1469: but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1470: to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1471: <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1472: '--preserve-path' flag.</p>
1473: </div>
1.41 asau 1474: <div class="sect2">
1.1 dsieger 1475: <div class="titlepage"><div><div><h3 class="title">
1.45 obache 1476: <a name="linux"></a>3.3.6. Linux</h3></div></div></div>
1.1 dsieger 1477: <p>Some versions of Linux (for example Debian GNU/Linux) need
1478: either libtermcap or libcurses (libncurses). Installing the
1479: distributions libncurses-dev package (or equivalent) should fix
1480: the problem.</p>
1481: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1482: (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1483: i386 have been tested.</p>
1484: <p>To bootstrap using icc, assuming the default icc installation
1485: directory:</p>
1486: <pre class="programlisting">
1.31 wiz 1487: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.1 dsieger 1488: </pre>
1.41 asau 1489: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1490: <h3 class="title">Note</h3>
1.31 wiz 1491: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
1492: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
1493: <p>For icc 10.1 neither of these appears to be necessary.</p>
1494: </div>
1495: <p>Use a value for ICCBASE that corresponds to the directory
1496: where icc is installed. After bootstrapping, set
1497: <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.30 wiz 1498: <pre class="programlisting">
1.31 wiz 1499: ICCBASE= /opt/intel/cc/10.1.008
1.1 dsieger 1500: </pre>
1.31 wiz 1501: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
1502: <code class="filename">/opt/intel_cc_80</code>. This is the default
1503: install directory for icc 8.0. If you are using a more recent
1504: version, be sure to set the correct path explicitly.
1505: </p>
1.1 dsieger 1506: <p>pkgsrc uses the static linking method of the runtime libraries
1507: provided by icc, so binaries can be run on other systems which do not
1508: have the shared libraries installed.</p>
1509: <p>Libtool, however, extracts a list of libraries from the
1.29 dholland 1510: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1 dsieger 1511: records it, throwing away the -Bstatic and -Bdynamic options
1512: interspersed between the libraries. This means that
1513: libtool-linked C++ shared libraries will have a runtime
1514: dependency on the icc libraries until this is fixed in
1515: libtool.</p>
1516: </div>
1.41 asau 1517: <div class="sect2">
1.1 dsieger 1518: <div class="titlepage"><div><div><h3 class="title">
1.57 ! bsiegert 1519: <a name="mirbsd"></a>3.3.7. MirBSD</h3></div></div></div>
! 1520: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
! 1521: Older versions might also work. Releases before #10 are not
! 1522: supported.</p>
! 1523: <p>The package tools of the (older) native ports tree,
! 1524: <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
! 1525: have the same names as the ones used by pkgsrc. Care should be taken
! 1526: that the right tools are used. When installing packages from source,
! 1527: use the <code class="filename">bmake</code> command for pkgsrc and
! 1528: <code class="filename">mmake</code> for MirPorts.</p>
! 1529: <p>pkgsrc and MirPorts use the same location for the package
! 1530: database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
! 1531: to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
! 1532: tree is self-contained. This is also the default setting used in the
! 1533: binary package builds.</p>
! 1534: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
! 1535: server. The bootstrap kit there already contains the
! 1536: <span class="command"><strong>pkgin</strong></span> package manager. See the
! 1537: <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
! 1538: page for more details.</p>
! 1539: </div>
! 1540: <div class="sect2">
! 1541: <div class="titlepage"><div><div><h3 class="title">
! 1542: <a name="openbsd"></a>3.3.8. OpenBSD</h3></div></div></div>
1.29 dholland 1543: <p>OpenBSD 5.1 has been tested and supported,
1544: other versions may work.</p>
1.1 dsieger 1545: <p>Care should be taken so that the tools that this kit installs do not conflict
1546: with the OpenBSD userland tools. There are several steps:</p>
1.23 wiz 1547: <div class="orderedlist"><ol class="orderedlist" type="1">
1548: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.1 dsieger 1549: <code class="filename">/var/db/pkg</code>. It is therefore
1550: recommended that you choose a different location (e.g.
1551: <code class="filename">/usr/pkgdb</code>) by
1552: using the --pkgdbdir option to the bootstrap script.</p></li>
1.23 wiz 1553: <li class="listitem">
1.1 dsieger 1554: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1555: good idea to move them out of the way to avoid confusion, e.g.</p>
1556: <pre class="screen">
1557: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1558: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1559: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1560: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1561: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1562: </pre>
1563: </li>
1.23 wiz 1564: <li class="listitem">
1.10 hubertf 1565: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1 dsieger 1566: <code class="filename">/etc/mk.conf.example</code> file
1567: when you use the bootstrap script. OpenBSD's make program uses
1.10 hubertf 1568: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 1569: as well. You can work around this by enclosing all the pkgsrc-specific parts
1570: of the file with:</p>
1571: <pre class="programlisting">
1572: .ifdef BSD_PKG_MK
1573: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1574: .else
1575: # OpenBSD stuff
1576: .endif
1577: </pre>
1578: </li>
1579: </ol></div>
1580: </div>
1.41 asau 1581: <div class="sect2">
1.1 dsieger 1582: <div class="titlepage"><div><div><h3 class="title">
1.57 ! bsiegert 1583: <a name="solaris"></a>3.3.9. Solaris</h3></div></div></div>
1.35 wiz 1584: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
1585: You will need a working C compiler. Both gcc 4.5.3 and
1.1 dsieger 1586: Sun WorkShop 5 have been tested.</p>
1587: <p>The following packages are required on Solaris 8 for the bootstrap
1588: process and to build packages.</p>
1.41 asau 1589: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1590: <li class="listitem"><p>SUNWsprot</p></li>
1591: <li class="listitem"><p>SUNWarc</p></li>
1592: <li class="listitem"><p>SUNWbtool</p></li>
1593: <li class="listitem"><p>SUNWtoo</p></li>
1594: <li class="listitem"><p>SUNWlibm</p></li>
1.1 dsieger 1595: </ul></div>
1596: <p>Please note that the use of GNU binutils on Solaris is
1597: <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1598: <p>Whichever compiler you use, please ensure the compiler tools and
1599: your $prefix are in your <code class="varname">PATH</code>. This includes
1600: <code class="filename">/usr/ccs/{bin,lib}</code>
1601: and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.41 asau 1602: <div class="sect3">
1.1 dsieger 1603: <div class="titlepage"><div><div><h4 class="title">
1.57 ! bsiegert 1604: <a name="solaris-gcc-note"></a>3.3.9.1. If you are using gcc</h4></div></div></div>
1.1 dsieger 1605: <p>It makes life much simpler if you only use the same gcc consistently
1606: for building all packages.</p>
1607: <p>It is recommended that an external gcc be used only for bootstrapping,
1608: then either build gcc from
1.35 wiz 1609: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.1 dsieger 1610: package, then remove gcc used during bootstrapping.</p>
1.10 hubertf 1611: <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.1 dsieger 1612: </div>
1.41 asau 1613: <div class="sect3">
1.1 dsieger 1614: <div class="titlepage"><div><div><h4 class="title">
1.57 ! bsiegert 1615: <a name="solaris-sun-workshop-note"></a>3.3.9.2. If you are using Sun WorkShop</h4></div></div></div>
1.1 dsieger 1616: <p>You will need at least the following packages installed (from WorkShop
1617: 5.0)</p>
1.41 asau 1618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1619: <li class="listitem"><p>SPROcc
1.1 dsieger 1620: - Sun WorkShop Compiler C 5.0</p></li>
1.23 wiz 1621: <li class="listitem"><p>SPROcpl
1.1 dsieger 1622: - Sun WorkShop Compiler C++ 5.0</p></li>
1.23 wiz 1623: <li class="listitem"><p>SPROild
1.1 dsieger 1624: - Sun WorkShop Incremental Linker</p></li>
1.23 wiz 1625: <li class="listitem"><p>SPROlang
1.1 dsieger 1626: - Sun WorkShop Compilers common components</p></li>
1627: </ul></div>
1628: <p>You should set the following variables in your
1.10 hubertf 1629: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1630: <pre class="programlisting">
1631: CC= cc
1632: CXX= CC
1633: CPP= cc -E
1634: CXXCPP= CC -E
1635: </pre>
1.41 asau 1636: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1637: <h3 class="title">Note</h3>
1638: <p>The <code class="varname">CPP</code> setting might break some
1639: packages that use the C preprocessor for processing things other
1640: than C source code.</p>
1641: </div>
1642: </div>
1.41 asau 1643: <div class="sect3">
1.1 dsieger 1644: <div class="titlepage"><div><div><h4 class="title">
1.57 ! bsiegert 1645: <a name="solaris-sunpro-64"></a>3.3.9.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.1 dsieger 1646: <p>To build 64-bit packages, you just need to have the
1.10 hubertf 1647: following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1 dsieger 1648: <pre class="programlisting">
1649: PKGSRC_COMPILER= sunpro
1650: ABI= 64
1651: </pre>
1.41 asau 1652: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1653: <h3 class="title">Note</h3>
1654: <p>This setting has been tested for the SPARC
1655: architecture. Intel and AMD machines need some more
1656: work.</p>
1657: </div>
1658: </div>
1.41 asau 1659: <div class="sect3">
1.1 dsieger 1660: <div class="titlepage"><div><div><h4 class="title">
1.57 ! bsiegert 1661: <a name="plat.sunos.problems"></a>3.3.9.4. Common problems</h4></div></div></div>
1.10 hubertf 1662: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1 dsieger 1663: <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1664: The workaround is to use another shell for the configure
1665: 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.10 hubertf 1666: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 1667: <pre class="programlisting">
1668: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1669: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1670: </pre>
1671: <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>
1672: </div>
1673: </div>
1674: </div>
1675: </div>
1.41 asau 1676: <div class="chapter">
1.1 dsieger 1677: <div class="titlepage"><div><div><h2 class="title">
1678: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1679: <div class="toc">
1680: <p><b>Table of Contents</b></p>
1681: <dl>
1682: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1683: <dd><dl>
1684: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1685: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1686: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1687: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1688: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1689: <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>
1690: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1691: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1692: </dl></dd>
1693: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1694: <dd><dl>
1695: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1696: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1697: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1698: </dl></dd>
1699: </dl>
1700: </div>
1701: <p>Basically, there are two ways of using pkgsrc. The first
1702: is to only install the package tools and to use binary packages
1.23 wiz 1703: that someone else has prepared. This is the <span class="quote">“<span class="quote">pkg</span>”</span>
1704: in pkgsrc. The second way is to install the <span class="quote">“<span class="quote">src</span>”</span>
1.1 dsieger 1705: of pkgsrc, too. Then you are able to build your own packages,
1706: and you can still use binary packages from someone else.</p>
1.41 asau 1707: <div class="sect1">
1.1 dsieger 1708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1709: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10 hubertf 1710: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9 rillig 1711: server and its mirrors, there are collections of binary packages,
1712: ready to be installed. These binary packages have been built using the
1713: default settings for the directories, that is:</p>
1.41 asau 1714: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 1715: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1716: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1717: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9 rillig 1718: </ul></div>
1719: <p>If you cannot use these directories for whatever reasons (maybe
1720: because you're not root), you cannot use these binary packages, but
1.10 hubertf 1721: 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.41 asau 1722: <div class="sect2">
1.1 dsieger 1723: <div class="titlepage"><div><div><h3 class="title">
1724: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5 weinem 1725: <p>To install binary packages, you first need to know from where
1726: to get them. The first place where you should look is on the main
1.10 hubertf 1727: 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.5 weinem 1728: <p>This directory contains binary packages for multiple
1729: platforms. First, select your operating system. (Ignore the
1730: directories with version numbers attached to it, they just exist for
1731: legacy reasons.) Then, select your hardware architecture, and in the
1.23 wiz 1732: third step, the OS version and the <span class="quote">“<span class="quote">version</span>”</span> of pkgsrc.</p>
1.9 rillig 1733: <p>In this directory, you often find a file called
1734: <code class="filename">bootstrap.tar.gz</code> which contains the package
1735: management tools. If the file is missing, it is likely that your
1736: operating system already provides those tools. Download the file and
1737: extract it in the <code class="filename">/</code> directory. It will create
1738: the directories <code class="filename">/usr/pkg</code> (containing the tools
1739: for managing binary packages) and <code class="filename">/var/db/pkg</code>
1740: (the database of installed packages).</p>
1.1 dsieger 1741: </div>
1.41 asau 1742: <div class="sect2">
1.1 dsieger 1743: <div class="titlepage"><div><div><h3 class="title">
1744: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9 rillig 1745: <p>In the directory from the last section, there is a
1746: subdirectory called <code class="filename">All</code>, which contains all the
1747: binary packages that are available for the platform, excluding those
1748: that may not be distributed via FTP or CDROM (depending on which
1.23 wiz 1749: medium you are using).</p>
1.9 rillig 1750: <p>To install packages directly from an FTP or HTTP server, run
1751: the following commands in a Bourne-compatible shell (be sure to
1.10 hubertf 1752: <span class="command"><strong>su</strong></span> to root first):</p>
1.9 rillig 1753: <pre class="screen">
1754: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1755: <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>
1756: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1757: </pre>
1758: <p>Instead of URLs, you can also use local paths, for example if
1759: you are installing from a set of CDROMs, DVDs or an NFS-mounted
1760: repository. If you want to install packages from multiple sources,
1761: you can separate them by a semicolon in
1762: <code class="varname">PKG_PATH</code>.</p>
1763: <p>After these preparations, installing a package is very
1764: easy:</p>
1765: <pre class="screen">
1766: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1767: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1768: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1769: </pre>
1.1 dsieger 1770: <p>Note that any prerequisite packages needed to run the
1771: package in question will be installed, too, assuming they are
1772: present where you install from.</p>
1.23 wiz 1773: <p>Adding packages might install vulnerable packages.
1774: Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14 jmcneill 1775: regularly, especially after installing new packages, and verify
1776: that the vulnerabilities are acceptable for your configuration.</p>
1.1 dsieger 1777: <p>After you've installed packages, be sure to have
1778: <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1779: <code class="varname">PATH</code> so you can actually start the just
1780: installed program.</p>
1781: </div>
1.41 asau 1782: <div class="sect2">
1.1 dsieger 1783: <div class="titlepage"><div><div><h3 class="title">
1784: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1785: <p>To deinstall a package, it does not matter whether it was
1786: installed from source code or from a binary package. The
1.10 hubertf 1787: <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1788: To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1 dsieger 1789: <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1790: name can be given with or without version number. Wildcards can
1791: also be used to deinstall a set of packages, for example
1792: <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1793: so that the shell does not expand them before
1794: <code class="literal">pkg_delete</code> sees them.</p>
1795: <p>The <code class="option">-r</code> option is very powerful: it
1796: removes all the packages that require the package in question
1797: and then removes the package itself. For example:
1798:
1799: </p>
1800: <pre class="screen">
1801: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1802: </pre>
1803: <p>
1804:
1805: will remove jpeg and all the packages that used it; this allows
1806: upgrading the jpeg package.</p>
1807: </div>
1.41 asau 1808: <div class="sect2">
1.1 dsieger 1809: <div class="titlepage"><div><div><h3 class="title">
1810: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10 hubertf 1811: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1 dsieger 1812: installed packages or binary package files.</p>
1813: </div>
1.41 asau 1814: <div class="sect2">
1.1 dsieger 1815: <div class="titlepage"><div><div><h3 class="title">
1816: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1817: <p>
1818: The NetBSD Security-Officer and Packages Groups maintain a list of
1819: known security vulnerabilities to packages which are (or have been)
1820: included in pkgsrc. The list is available from the NetBSD
1.10 hubertf 1821: 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.1 dsieger 1822: </p>
1823: <p>
1.22 jakllsch 1824: Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1 dsieger 1825: this list can be downloaded
1826: automatically, and a security audit of all packages installed on a system
1827: can take place.
1828: </p>
1829: <p>
1.22 jakllsch 1830: There are two components to auditing. The first
1831: step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1832: is for downloading
1.1 dsieger 1833: the list of vulnerabilities from the NetBSD FTP site. The second
1.22 jakllsch 1834: step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1 dsieger 1835: installed packages are vulnerable. If a package is vulnerable, you
1836: will see output similar to the following:
1837: </p>
1838: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1839: http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1840: <p>
1.22 jakllsch 1841: You may wish to have the
1.10 hubertf 1842: <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22 jakllsch 1843: file downloaded daily so that
1844: it remains current. This may be done by adding an appropriate entry
1.29 dholland 1845: to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry. For example the entry
1.22 jakllsch 1846: </p>
1847: <pre class="screen">
1848: # download vulnerabilities file
1849: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1850: </pre>
1851: <p>
1852: will update the vulnerability list every day at 3AM. You may wish to do
1853: this more often than once a day.
1854:
1855: In addition, you may wish to run the package audit from the daily
1856: security script. This may be accomplished by adding the following
1857: line to <code class="filename">/etc/security.local</code>:
1858: </p>
1859: <pre class="screen">
1860: /usr/sbin/pkg_admin audit
1861: </pre>
1862: <p>
1.1 dsieger 1863: </p>
1864: </div>
1.41 asau 1865: <div class="sect2">
1.1 dsieger 1866: <div class="titlepage"><div><div><h3 class="title">
1867: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1868: <p>
1.12 weinem 1869: 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.23 wiz 1870: <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">“<span class="quote">-i</span>”</span>
1.1 dsieger 1871: argument to check if your packages are up-to-date, e.g.
1872: </p>
1873: <pre class="screen">
1874: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1875: ...
1876: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1877: </pre>
1.10 hubertf 1878: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1 dsieger 1879: package on your system and rebuild any dependencies.
1880: </p>
1881: </div>
1.41 asau 1882: <div class="sect2">
1.1 dsieger 1883: <div class="titlepage"><div><div><h3 class="title">
1884: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10 hubertf 1885: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1 dsieger 1886: administrative functions on the package system.</p>
1887: </div>
1.41 asau 1888: <div class="sect2">
1.1 dsieger 1889: <div class="titlepage"><div><div><h3 class="title">
1890: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1891: <p>Please pay very careful attention to the warnings
1.29 dholland 1892: expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1 dsieger 1893: inherent dangers of installing binary packages which you did
1894: not create yourself, and the security holes that can be
1895: introduced onto your system by indiscriminate adding of such
1896: files.</p>
1897: <p>The same warning of course applies to every package you
1898: install from source when you haven't completely read and
1899: understood the source code of the package, the compiler that
1900: is used to build the package and all the other tools that are
1901: involved.</p>
1902: </div>
1903: </div>
1.41 asau 1904: <div class="sect1">
1.1 dsieger 1905: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1906: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1907: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1908: directory now contains a set of packages, organized into
1909: categories. You can browse the online index of packages, or run
1.10 hubertf 1910: <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1 dsieger 1911: directory to build local <code class="filename">README.html</code> files for
1912: 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>
1913: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1914: is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1915: should do so by setting <code class="varname">LOCALBASE</code> in
1.10 hubertf 1916: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1 dsieger 1917: different <code class="varname">LOCALBASE</code> definitions on the same
1918: system (inside a chroot is an exception). </p>
1919: <p>The rest of this chapter assumes that the package is already
1.10 hubertf 1920: 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.1 dsieger 1921: instructions how to create your own packages.</p>
1.41 asau 1922: <div class="sect2">
1.1 dsieger 1923: <div class="titlepage"><div><div><h3 class="title">
1924: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1925: <p>To build packages from source, you need a working C
1926: compiler. On NetBSD, you need to install the
1.23 wiz 1927: <span class="quote">“<span class="quote">comp</span>”</span> and the <span class="quote">“<span class="quote">text</span>”</span> distribution
1.1 dsieger 1928: sets. If you want to build X11-related packages, the
1.23 wiz 1929: <span class="quote">“<span class="quote">xbase</span>”</span> and <span class="quote">“<span class="quote">xcomp</span>”</span> distribution
1.1 dsieger 1930: sets are required, too.</p>
1931: </div>
1.41 asau 1932: <div class="sect2">
1.1 dsieger 1933: <div class="titlepage"><div><div><h3 class="title">
1934: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1935: <p>The first step for building a package is downloading the
1936: distfiles (i.e. the unmodified source). If they have not yet been
1937: downloaded, pkgsrc will fetch them automatically.</p>
1938: <p>If you have all files that you need in the
1939: <code class="filename">distfiles</code> directory,
1940: you don't need to connect. If the distfiles are on CD-ROM, you can
1941: mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1942: </p>
1943: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1944: <p>
1.10 hubertf 1945: to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 1946: <p>By default a list of distribution sites will be randomly
1947: intermixed to prevent huge load on servers which holding popular
1948: packages (for example, SourceForge.net mirrors). Thus, every
1949: time when you need to fetch yet another distfile all the mirrors
1950: will be tried in new (random) order. You can turn this feature
1951: off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1952: <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1953: <p>You can overwrite some of the major distribution sites to
1954: fit to sites that are close to your own. By setting one or two
1955: variables you can modify the order in which the master sites are
1956: accessed. <code class="varname">MASTER_SORT</code> contains a whitespace
1957: delimited list of domain suffixes.
1958: <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1959: contains a whitespace delimited list of regular expressions. It
1960: has higher priority than <code class="varname">MASTER_SORT</code>. Have a
1961: look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1962: some examples. This may save some of your bandwidth and
1963: time.</p>
1964: <p>You can change these settings either in your shell's environment, or,
1965: if you want to keep the settings, by editing the
1.10 hubertf 1966: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1 dsieger 1967: and adding the definitions there.</p>
1968: <p>
1969: If a package depends on many other packages (such as
1970: <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
1971: alternate between periods of
1972: downloading source, and compiling. To ensure you have all the source
1973: downloaded initially you can run the command:
1974: </p>
1975: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1976: <p>
1977: which will output and run a set of shell commands to fetch the
1978: necessary files into the <code class="filename">distfiles</code> directory. You can
1979: also choose to download the files manually.
1980: </p>
1981: </div>
1.41 asau 1982: <div class="sect2">
1.1 dsieger 1983: <div class="titlepage"><div><div><h3 class="title">
1984: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1985: <p>
1986: Once the software has downloaded, any patches will be applied, then it
1987: will be compiled for you. This may take some time depending on your
1988: computer, and how many other packages the software depends on and their
1989: compile time.
1990: </p>
1.41 asau 1991: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 1992: <h3 class="title">Note</h3>
1993: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10 hubertf 1994: use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23 wiz 1995: <span class="quote">“<span class="quote">make</span>”</span> in the examples in this guide.</p>
1.1 dsieger 1996: </div>
1997: <p>For example, type</p>
1998: <pre class="screen">
1999: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2000: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
2001: </pre>
2002: <p>at the shell prompt to build the various components of the
2003: package.</p>
2004: <p>The next stage is to actually install the newly compiled
2005: program onto your system. Do this by entering:
2006:
2007: </p>
2008: <pre class="screen">
2009: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
2010: </pre>
2011: <p>
2012:
2013: while you are still in the directory for whatever package you
2014: are installing.</p>
2015: <p>Installing the package on your system may require you to
2016: be root. However, pkgsrc has a
2017: <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
2018: to only become root for the actual installation step.</p>
2019: <p>That's it, the software should now be installed and setup for use.
2020: You can now enter:
2021:
2022: </p>
2023: <pre class="screen">
2024: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
2025: </pre>
2026: <p>
2027:
2028: to remove the compiled files in the work directory, as you shouldn't need
2029: them any more. If other packages were also added to your system
2030: (dependencies) to allow your program to compile, you can tidy these up
2031: also with the command:</p>
2032: <pre class="screen">
2033: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
2034: </pre>
2035: <p>Taking the figlet utility as an example, we can install it on our
1.10 hubertf 2036: 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.1 dsieger 2037: <p>The program is installed under the default root of the
2038: packages tree - <code class="filename">/usr/pkg</code>. Should this not
2039: conform to your tastes, set the <code class="varname">LOCALBASE</code>
2040: variable in your environment, and it will use that value as the
2041: root of your packages tree. So, to use
2042: <code class="filename">/usr/local</code>, set
2043: <code class="varname">LOCALBASE=/usr/local</code> in your environment.
2044: Please note that you should use a directory which is dedicated to
2045: packages and not shared with other programs (i.e., do not try and
2046: use <code class="varname">LOCALBASE=/usr</code>). Also, you should not try
2047: to add any of your own files or directories (such as
2048: <code class="filename">src/</code>, <code class="filename">obj/</code>, or
2049: <code class="filename">pkgsrc/</code>) below the
2050: <code class="varname">LOCALBASE</code> tree. This is to prevent possible
2051: conflicts between programs and other files installed by the
2052: package system and whatever else may have been installed
2053: there.</p>
1.10 hubertf 2054: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 2055: alter some configuration options at build time. Have a look at
2056: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
2057: of what will be set there by default. Environment variables such
2058: as <code class="varname">LOCALBASE</code> can be set in
1.10 hubertf 2059: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1 dsieger 2060: set them each time you want to use pkgsrc.</p>
1.23 wiz 2061: <p>Occasionally, people want to <span class="quote">“<span class="quote">look under the
2062: covers</span>”</span> to see what is going on when a package is building
1.1 dsieger 2063: or being installed. This may be for debugging purposes, or out of
2064: simple curiosity. A number of utility values have been added to
2065: help with this.</p>
1.23 wiz 2066: <div class="orderedlist"><ol class="orderedlist" type="1">
2067: <li class="listitem">
1.29 dholland 2068: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1 dsieger 2069: <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
2070: information will be displayed. For example,</p>
2071: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
2072: <p>will show all the commands that are invoked, up to and
1.23 wiz 2073: including the <span class="quote">“<span class="quote">patch</span>”</span> stage.</p>
1.1 dsieger 2074: </li>
1.23 wiz 2075: <li class="listitem">
1.29 dholland 2076: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2077: definition, then the <code class="varname">VARNAME</code> definition
2078: should be used, in conjunction with the show-var
1.29 dholland 2079: target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 2080: variable <code class="varname">LOCALBASE</code>:</p>
2081: <pre class="screen">
2082: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
2083: /usr/pkg
2084: <code class="prompt">%</code>
2085: </pre>
2086: </li>
2087: </ol></div>
2088: <p>If you want to install a binary package that you've either
2089: created yourself (see next section), that you put into
2090: pkgsrc/packages manually or that is located on a remote FTP
2091: server, you can use the "bin-install" target. This target will
1.29 dholland 2092: install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10 hubertf 2093: else do a <span class="command"><strong>make package</strong></span>. The list of remote FTP
1.1 dsieger 2094: sites searched is kept in the variable
2095: <code class="varname">BINPKG_SITES</code>, which defaults to
1.29 dholland 2096: 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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1 dsieger 2097: can be put into <code class="varname">BIN_INSTALL_FLAGS</code>. See
2098: <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2099: details.</p>
2100: <p>A final word of warning: If you set up a system that has a
2101: non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2102: set that before any packages are installed, as you cannot use
2103: several directories for the same purpose. Doing so will result in
2104: pkgsrc not being able to properly detect your installed packages,
2105: and fail miserably. Note also that precompiled binary packages are
2106: usually built with the default <code class="varname">LOCALBASE</code> of
2107: <code class="filename">/usr/pkg</code>, and that you should
2108: <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2109: <code class="varname">LOCALBASE</code>.</p>
2110: </div>
2111: </div>
2112: </div>
1.41 asau 2113: <div class="chapter">
1.1 dsieger 2114: <div class="titlepage"><div><div><h2 class="title">
2115: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2116: <div class="toc">
2117: <p><b>Table of Contents</b></p>
2118: <dl>
2119: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2120: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9 rillig 2121: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4 rillig 2122: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1 dsieger 2123: <dd><dl>
1.4 rillig 2124: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23 wiz 2125: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2126: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1 dsieger 2127: </dl></dd>
1.4 rillig 2128: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2129: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1 dsieger 2130: </dl>
2131: </div>
1.4 rillig 2132: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1 dsieger 2133: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2134: that file depends on the installation. On NetBSD, when you use
1.29 dholland 2135: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1 dsieger 2136: <code class="filename">/etc/</code>. In all other cases the default location is
2137: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2138: bootstrap program to install the binary packages.</p>
2139: <p>During the bootstrap, an example configuration file is created. To
2140: use that, you have to create the directory
2141: <code class="filename">${PREFIX}/etc</code> and copy the example file
2142: there.</p>
2143: <p>The format of the configuration file is that of the usual
2144: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2145: is done by setting variables in this file. Note that you can define all
2146: kinds of variables, and no special error checking (for example for
2147: spelling mistakes) takes place, so you have to try it out to see if it
2148: works.</p>
1.41 asau 2149: <div class="sect1">
1.1 dsieger 2150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2151: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2152: <p>In this section, you can find some variables that apply to all
2153: pkgsrc packages. A complete list of the variables that can be
2154: configured by the user is available in
2155: <code class="filename">mk/defaults/mk.conf</code>, together with some
2156: comments that describe each variable's intent.</p>
1.41 asau 2157: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2158: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1 dsieger 2159: packages will be installed. The default is
2160: <code class="filename">/usr/pkg</code>. Do not mix binary packages
2161: with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23 wiz 2162: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2163: <span class="quote">“<span class="quote">cross</span>”</span> category packages will be
1.1 dsieger 2164: installed. The default is
2165: <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23 wiz 2166: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1 dsieger 2167: X11 is installed on the system. The default is
2168: <code class="filename">/usr/X11R6</code>.</p></li>
1.23 wiz 2169: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1 dsieger 2170: downloaded copies of the original source distributions used
2171: for building pkgsrc packages. The default is
2172: <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23 wiz 2173: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1 dsieger 2174: database about installed packages is stored. The default is
2175: <code class="filename">/var/db/pkg</code>.</p></li>
1.23 wiz 2176: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1 dsieger 2177: If set, override the packages'
2178: <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23 wiz 2179: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1 dsieger 2180: Backup location(s) for distribution files and patch files
2181: if not found locally or in
2182: <code class="filename">${MASTER_SITES}</code> or
2183: <code class="filename">${PATCH_SITES}</code> respectively.
2184: The defaults are
1.25 spz 2185: <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.1 dsieger 2186: and
2187: <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23 wiz 2188: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1 dsieger 2189: List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2190: <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23 wiz 2191: release (<span class="quote">“<span class="quote">2.0</span>”</span>, etc.) and architecture
2192: (<span class="quote">“<span class="quote">mipsel</span>”</span>, etc.).</p></li>
2193: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22 jakllsch 2194: List of acceptable licenses. License names are case-sensitive.
2195: Whenever you try to build a package whose license is not in this
2196: list, you will get an error message. If the license condition is
2197: simple enough, the error message will include specific
2198: instructions on how to change this variable.</p></li>
1.1 dsieger 2199: </ul></div>
2200: </div>
1.41 asau 2201: <div class="sect1">
1.1 dsieger 2202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2203: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2204: <p>XXX
2205: </p>
1.41 asau 2206: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2207: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1 dsieger 2208: directory for the binary packages. The default is
2209: <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23 wiz 2210: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1 dsieger 2211: The top level directory where, if defined, the separate
2212: working directories will get created, and symbolically
2213: linked to from <code class="filename">${WRKDIR}</code> (see below).
2214: This is useful for building packages on several
2215: architectures, then <code class="filename">${PKGSRCDIR}</code>
2216: can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2217: is local to every architecture. (It should be noted that
2218: <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14 jmcneill 2219: — it is an internal definition which refers to the
1.1 dsieger 2220: root of the pkgsrc tree. It is possible to have many
2221: pkgsrc tree instances.)</p></li>
1.23 wiz 2222: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1 dsieger 2223: Directory for local patches that aren't part of pkgsrc.
1.10 hubertf 2224: See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a> for more
1.1 dsieger 2225: information.</p></li>
1.23 wiz 2226: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10 hubertf 2227: the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1 dsieger 2228: BSD-style Makefile. If this is not set,
2229: <code class="varname">MAKECONF</code> is set to
2230: <code class="filename">/dev/null</code> to avoid picking up
2231: settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23 wiz 2232: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1 dsieger 2233: By default, dependencies are only installed, and no binary
2234: package is created for them. You can set this variable to
2235: <code class="literal">package</code> to automatically create binary
2236: packages after installing dependencies.</p></li>
2237: </ul></div>
2238: </div>
1.41 asau 2239: <div class="sect1">
1.1 dsieger 2240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9 rillig 2241: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.24 wiz 2242: <p>Most packages support installation into a
1.4 rillig 2243: subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2244: to be built, before the actual filesystem is touched. DESTDIR
2245: support exists in two variations:</p>
1.41 asau 2246: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2247: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24 wiz 2248: installation and packaging is still run as root.</p></li>
2249: <li class="listitem"><p>Full DESTDIR support can run the complete
2250: build, installation and packaging as normal user. Root
2251: privileges are only needed to add packages.</p></li>
2252: </ul></div>
2253: <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2254: you can set
2255: <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2256: so it's preferable to convert a package to DESTDIR instead.</p>
1.4 rillig 2257: <p>DESTDIR support changes the behaviour of various targets
2258: slightly. To install a package after building it, use
2259: <code class="literal">package-install</code>. <code class="literal">package</code> and
2260: <code class="literal">install</code> don't do that any
2261: longer. <code class="literal">package-install</code> can be used as
2262: <code class="varname">DEPENDS_TARGET</code>. <code class="literal">bin-install</code>
2263: will ask for the root password to install the package and fail,
2264: <code class="literal">package-install</code> will ask again.</p>
2265: <p>With basic DESTDIR support, <strong class="userinput"><code>make
2266: clean</code></strong> needs to be run as root.</p>
1.17 imil 2267: <p>Considering the <code class="filename">foo/bar</code> package,
2268: DESTDIR full support can be tested using the following commands
2269:
2270: </p>
2271: <pre class="programlisting">
2272: <code class="prompt">$</code> id
2273: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2274: <code class="prompt">$</code> mkdir $HOME/packages
2275: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2276: </pre>
2277: <p>
2278:
2279: Verify <code class="varname">DESTDIR</code> full support, no root privileges
2280: should be needed
2281:
2282: </p>
2283: <pre class="programlisting">
1.20 snj 2284: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.17 imil 2285: </pre>
2286: <p>
2287:
2288: Create a package without root privileges
2289:
2290: </p>
2291: <pre class="programlisting">
1.20 snj 2292: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.17 imil 2293: </pre>
2294: <p>
2295:
2296: For the following command, you must be able to gain root
1.29 dholland 2297: privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17 imil 2298:
2299: </p>
2300: <pre class="programlisting">
1.20 snj 2301: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.17 imil 2302: </pre>
2303: <p>
2304:
2305: Then, as a simple user
2306:
2307: </p>
2308: <pre class="programlisting">
2309: <code class="prompt">$</code> make clean
2310: </pre>
2311: <p>
2312:
2313: </p>
1.4 rillig 2314: </div>
1.41 asau 2315: <div class="sect1">
1.4 rillig 2316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2317: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41 asau 2318: <div class="sect2">
1.1 dsieger 2319: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2320: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1 dsieger 2321: <p>By default, pkgsrc will use GCC to build packages. This may be
2322: overridden by setting the following variables in /etc/mk.conf:</p>
1.41 asau 2323: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2324: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2325: <dd>
2326: <p>This is a list of values specifying the chain of
2327: compilers to invoke when building packages. Valid values
2328: are:</p>
1.41 asau 2329: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2330: <li class="listitem"><p><code class="varname">distcc</code>:
1.1 dsieger 2331: distributed C/C++ (chainable)</p></li>
1.23 wiz 2332: <li class="listitem"><p><code class="varname">ccache</code>:
1.1 dsieger 2333: compiler cache (chainable)</p></li>
1.23 wiz 2334: <li class="listitem"><p><code class="varname">gcc</code>:
1.1 dsieger 2335: GNU C/C++ Compiler</p></li>
1.23 wiz 2336: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2337: Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.23 wiz 2338: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1 dsieger 2339: Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23 wiz 2340: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1 dsieger 2341: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2342: </ul></div>
2343: <p>The default is
1.23 wiz 2344: <span class="quote">“<span class="quote"><code class="varname">gcc</code></span>”</span>. You can use
1.1 dsieger 2345: <code class="varname">ccache</code> and/or
2346: <code class="varname">distcc</code> with an appropriate
2347: <code class="varname">PKGSRC_COMPILER</code> setting,
1.23 wiz 2348: e.g. <span class="quote">“<span class="quote"><code class="varname">ccache gcc</code></span>”</span>. This
1.1 dsieger 2349: variable should always be terminated with a value for
2350: a real compiler. Note that only one real compiler
1.23 wiz 2351: should be listed (e.g. <span class="quote">“<span class="quote"><code class="varname">sunpro gcc</code></span>”</span>
1.1 dsieger 2352: is not allowed).</p>
2353: </dd>
2354: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2355: <dd><p>This specifies the minimum version of GCC to use
2356: when building packages. If the system GCC doesn't
2357: satisfy this requirement, then pkgsrc will build and
2358: install one of the GCC packages to use instead.</p></dd>
2359: </dl></div>
2360: </div>
1.41 asau 2361: <div class="sect2">
1.1 dsieger 2362: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2363: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2364: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2365: please make sure to use the <code class="literal">+=</code> operator
2366: instead of the <code class="literal">=</code> operator:</p>
2367: <pre class="programlisting">
2368: CFLAGS+= -your -flags
2369: </pre>
2370: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23 wiz 2371: <span class="quote">“<span class="quote">+</span>”</span>) may lead to problems with packages that
1.16 jnemeth 2372: need to add their own flags. You may want to take a look
2373: at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23 wiz 2374: package if you're interested in optimization specifically
2375: for the current CPU. </p>
1.1 dsieger 2376: </div>
1.41 asau 2377: <div class="sect2">
1.1 dsieger 2378: <div class="titlepage"><div><div><h3 class="title">
1.4 rillig 2379: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1 dsieger 2380: <p>If you want to pass flags to the linker, both in the configure
2381: step and the build step, you can do this in two ways. Either set
2382: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>. The difference
2383: between the two is that <code class="varname">LIBS</code> will be appended to
2384: the command line, while <code class="varname">LDFLAGS</code> come earlier.
2385: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2386: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2387: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>. As with
2388: <code class="varname">CFLAGS</code>, if you do not wish to override these
2389: settings, use the <code class="literal">+=</code> operator:</p>
2390: <pre class="programlisting">
2391: LDFLAGS+= -your -linkerflags
2392: </pre>
2393: </div>
2394: </div>
1.41 asau 2395: <div class="sect1">
1.1 dsieger 2396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2397: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1 dsieger 2398: <p>XXX
2399: </p>
1.41 asau 2400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2401: <li class="listitem">
1.1 dsieger 2402: <p><code class="varname">PKG_DEVELOPER</code>:
2403: Run some sanity checks that package developers want:
2404: </p>
1.41 asau 2405: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2406: <li class="listitem"><p>make sure patches apply with zero
1.1 dsieger 2407: fuzz</p></li>
1.23 wiz 2408: <li class="listitem"><p>run check-shlibs to see that all
1.1 dsieger 2409: binaries will find their shared libs.</p></li>
2410: </ul></div>
2411: <p>
2412: </p>
2413: </li>
1.23 wiz 2414: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1 dsieger 2415: of debugging output which is displayed whilst making and
2416: installing the package. The default value for this is 0,
2417: which will not display the commands as they are executed
2418: (normal, default, quiet operation); the value 1 will display
2419: all shell commands before their invocation, and the value 2
2420: will display both the shell commands before their invocation,
1.10 hubertf 2421: and their actual execution progress with <span class="command"><strong>set
1.1 dsieger 2422: -x</strong></span> will be displayed.</p></li>
2423: </ul></div>
2424: <p>
2425: </p>
2426: </div>
1.41 asau 2427: <div class="sect1">
1.1 dsieger 2428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4 rillig 2429: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1 dsieger 2430: <p>Some packages have build time options, usually to select
2431: between different dependencies, enable optional support for big
2432: dependencies or enable experimental features.</p>
2433: <p>To see which options, if any, a package supports, and which
1.10 hubertf 2434: options are mutually exclusive, run <span class="command"><strong>make
1.1 dsieger 2435: show-options</strong></span>, for example:</p>
2436: <pre class="programlisting">
2437: The following options are supported by this package:
2438: ssl Enable SSL support.
2439: Exactly one of the following gecko options is required:
2440: firefox Use firefox as gecko rendering engine.
2441: mozilla Use mozilla as gecko rendering engine.
2442: At most one of the following database options may be selected:
2443: mysql Enable support for MySQL database.
2444: pgsql Enable support for PostgreSQL database.
2445:
2446: These options are enabled by default: firefox
2447: These options are currently enabled: mozilla ssl
2448: </pre>
2449: <p>The following variables can be defined in
1.10 hubertf 2450: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1 dsieger 2451: enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2452: which can be used to select or disable options for all packages
2453: that support them, and
2454: <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2455: which can be used to select or disable options specifically for
2456: package <em class="replaceable"><code>pkgbase</code></em>. Options listed in
1.23 wiz 2457: these variables are selected, options preceded by <span class="quote">“<span class="quote">-</span>”</span>
1.1 dsieger 2458: are disabled. A few examples:</p>
2459: <pre class="screen">
1.10 hubertf 2460: <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.1 dsieger 2461: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2462: PKG_OPTIONS.kdebase= debug -sasl
2463: PKG_OPTIONS.apache= suexec </pre>
1.11 rillig 2464: <p>It is important to note that options that were specifically
1.18 snj 2465: suggested by the package maintainer must be explicitly removed if
1.11 rillig 2466: you do not wish to include the option. If you are unsure you can view
2467: the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1 dsieger 2468: <p>The following settings are consulted in the order given, and
2469: the last setting that selects or disables an option is
2470: used:</p>
1.23 wiz 2471: <div class="orderedlist"><ol class="orderedlist" type="1">
2472: <li class="listitem"><p>the default options as suggested by the package
1.1 dsieger 2473: maintainer</p></li>
1.23 wiz 2474: <li class="listitem"><p>the options implied by the settings of legacy
1.1 dsieger 2475: variables (see below)</p></li>
1.23 wiz 2476: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2477: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1 dsieger 2478: </ol></div>
2479: <p>For groups of mutually exclusive options, the last option
2480: selected is used, all others are automatically disabled. If an
2481: option of the group is explicitly disabled, the previously
2482: selected option, if any, is used. It is an error if no option
2483: from a required group of options is selected, and building the
2484: package will fail.</p>
2485: <p>Before the options framework was introduced, build options
2486: were selected by setting a variable (often named
2487: <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10 hubertf 2488: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option. To ease
1.1 dsieger 2489: transition to the options framework for the user, these legacy
2490: variables are converted to the appropriate options setting
2491: (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2492: automatically. A warning is issued to prompt the user to update
1.10 hubertf 2493: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1 dsieger 2494: directly. Support for the legacy variables will be removed
2495: eventually.</p>
2496: </div>
2497: </div>
1.41 asau 2498: <div class="chapter">
1.1 dsieger 2499: <div class="titlepage"><div><div><h2 class="title">
2500: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2501: <div class="toc">
2502: <p><b>Table of Contents</b></p>
2503: <dl>
2504: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2505: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2506: </dl>
2507: </div>
1.41 asau 2508: <div class="sect1">
1.1 dsieger 2509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2510: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2511: <p>Once you have built and installed a package, you can create
2512: a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.29 dholland 2513: another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1 dsieger 2514: the same package on a group of hosts and wasting CPU time. It also
2515: provides a simple means for others to install your package, should
2516: you distribute it.</p>
2517: <p>To create a binary package, change into the appropriate
1.10 hubertf 2518: directory in pkgsrc, and run <span class="command"><strong>make
1.1 dsieger 2519: package</strong></span>:</p>
2520: <pre class="screen">
2521: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2522: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2523: </pre>
2524: <p>This will build and install your package (if not already done),
2525: and then build a binary package from what was installed. You can
1.10 hubertf 2526: then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1 dsieger 2527: it. Binary packages are created by default in
2528: <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10 hubertf 2529: gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, “Packaging figlet”</a> for a
1.1 dsieger 2530: 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.10 hubertf 2531: <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.1 dsieger 2532: such a binary package.</p>
2533: </div>
1.41 asau 2534: <div class="sect1">
1.1 dsieger 2535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2536: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10 hubertf 2537: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, “Other helpful targets”</a>.</p>
1.6 rillig 2538: </div>
2539: </div>
1.41 asau 2540: <div class="chapter">
1.6 rillig 2541: <div class="titlepage"><div><div><h2 class="title">
2542: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2543: builds)</h2></div></div></div>
2544: <div class="toc">
2545: <p><b>Table of Contents</b></p>
2546: <dl>
2547: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2548: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2549: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2550: <dd><dl>
2551: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2552: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2553: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2554: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2555: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2556: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2557: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2558: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2559: </dl></dd>
2560: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15 rillig 2561: <dd><dl>
2562: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2563: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2564: </dl></dd>
1.6 rillig 2565: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2566: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2567: </dl>
2568: </div>
2569: <p>When you have multiple machines that should run the same packages,
2570: it is wasted time if they all build their packages themselves from
2571: source. There are two ways of getting a set of binary packages: The old
2572: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2573: system. This chapter describes how to set them up so that the packages
2574: are most likely to be usable later.</p>
1.41 asau 2575: <div class="sect1">
1.6 rillig 2576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2577: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2578: <p>Since a bulk build takes several days or even weeks to finish, you
2579: should think about the setup before you start everything. Pay attention
2580: to at least the following points:</p>
1.41 asau 2581: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2582: <li class="listitem">
1.6 rillig 2583: <p>If you want to upload the binary packages to
2584: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2585: packages:</p>
1.41 asau 2586: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23 wiz 2587: <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
1.6 rillig 2588: by a NetBSD developer on a trusted machine (that is, where you and only
2589: you have root access).</p></li>
1.23 wiz 2590: <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
1.21 snj 2591: the stable branches (like 2009Q1), so that users browsing the available
1.6 rillig 2592: collections can see at a glance how old the packages
2593: are.</p></li>
1.23 wiz 2594: <li class="listitem"><p>The packages must be built as root, since some packages
1.6 rillig 2595: require set-uid binaries at runtime, and creating those packages as
2596: unprivileged user doesn't work well at the moment.</p></li>
2597: </ul></div>
2598: </li>
1.23 wiz 2599: <li class="listitem"><p>Make sure that the bulk build cannot break anything in
1.6 rillig 2600: your system. Most bulk builds run as root, so they should be run at least
2601: in a chroot environment or something even more restrictive, depending on
2602: what the operating system provides. There have been numerous cases where
2603: certain packages tried to install files outside the
2604: <code class="filename">LOCALBASE</code> or wanted to edit some files in
2605: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2606: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2607: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2608: that you don't need any package during the build.</p></li>
2609: </ul></div>
2610: </div>
1.41 asau 2611: <div class="sect1">
1.6 rillig 2612: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2613: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2614: <p>A complete bulk build requires lots of disk space. Some of the
2615: disk space can be read-only, some other must be writable. Some can be on
2616: remote filesystems (such as NFS) and some should be local. Some can be
2617: temporary filesystems, others must survive a sudden reboot.</p>
1.41 asau 2618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2619: <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2620: <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2621: <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2622: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2623: <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2624: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
1.6 rillig 2625: </ul></div>
1.1 dsieger 2626: </div>
1.41 asau 2627: <div class="sect1">
1.1 dsieger 2628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 2629: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.41 asau 2630: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.15 rillig 2631: <h3 class="title">Note</h3>
2632: <p>There are two ways of doing a bulk build. The old-style
1.23 wiz 2633: one and the new-style <span class="quote">“<span class="quote">pbulk</span>”</span>. The latter is the recommended
1.15 rillig 2634: way.</p>
1.6 rillig 2635: </div>
1.41 asau 2636: <div class="sect2">
1.1 dsieger 2637: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2638: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.41 asau 2639: <div class="sect3">
1.1 dsieger 2640: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2641: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1 dsieger 2642: </h4></div></div></div>
2643: <p>The <code class="filename">build.conf</code> file is the main
2644: configuration file for bulk builds. You can configure how your
2645: copy of pkgsrc is kept up to date, how the distfiles are
2646: downloaded, how the packages are built and how the report is
2647: generated. You can find an annotated example file in
2648: <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2649: it, copy <code class="filename">build.conf-example</code> to
2650: <code class="filename">build.conf</code> and edit it, following the
2651: comments in that file.</p>
2652: </div>
1.41 asau 2653: <div class="sect3">
1.1 dsieger 2654: <div class="titlepage"><div><div><h4 class="title">
1.10 hubertf 2655: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4 rillig 2656: </h4></div></div></div>
1.10 hubertf 2657: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1 dsieger 2658: Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2659: details of the default settings. You will want to ensure that
2660: <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.22 jakllsch 2661: As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.4 rillig 2662: completely bypasses the license check.</p>
1.1 dsieger 2663: <pre class="programlisting">
2664: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2665: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2666: BSDSRCDIR= /usr/src
2667: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2668: OBJHOSTNAME?= yes # use work.`hostname`
2669: FAILOVER_FETCH= yes # insist on the correct checksum
2670: PKG_DEVELOPER?= yes
1.22 jakllsch 2671: SKIP_LICENSE_CHECK= yes
1.1 dsieger 2672: </pre>
2673: <p>Some options that are especially useful for bulk builds
2674: can be found at the top lines of the file
2675: <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2676: options of these are briefly described here.</p>
1.41 asau 2677: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2678: <li class="listitem"><p>If you are on a slow machine, you may want to
1.1 dsieger 2679: set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
1.23 wiz 2680: <span class="quote">“<span class="quote">no</span>”</span>.</p></li>
2681: <li class="listitem"><p>If you are doing bulk builds from a read-only
1.1 dsieger 2682: copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2683: to the directory where all log files are created. Otherwise the
2684: log files are created in the pkgsrc directory.</p></li>
1.23 wiz 2685: <li class="listitem"><p>Another important variable is
1.1 dsieger 2686: <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2687: should be always available while building other
2688: packages.</p></li>
2689: </ul></div>
2690: <p>Some other options are scattered in the pkgsrc
2691: infrastructure:</p>
1.41 asau 2692: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2693: <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2694: should be set to <code class="literal">yes</code>. The purpose of the
2695: bulk builds is creating binary packages, no matter if they
2696: are vulnerable or not. Leaving this variable unset would
2697: prevent the bulk build system from even trying to build
2698: them, so possible building errors would not show
2699: up.</p></li>
2700: <li class="listitem"><p><code class="varname">CHECK_FILES</code>
1.1 dsieger 2701: (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.23 wiz 2702: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed set of files
1.1 dsieger 2703: matches the <code class="filename">PLIST</code>.</p></li>
1.23 wiz 2704: <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
1.1 dsieger 2705: (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.23 wiz 2706: <span class="quote">“<span class="quote">yes</span>”</span> to check that the installed
2707: <span class="quote">“<span class="quote">#!</span>”</span>-scripts will find their
1.1 dsieger 2708: interpreter.</p></li>
1.23 wiz 2709: <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2710: set to <span class="quote">“<span class="quote"><code class="literal">yes</code></span>”</span> to run each
1.1 dsieger 2711: package's self-test before installing it. Note that some
1.23 wiz 2712: packages make heavy use of <span class="quote">“<span class="quote">good</span>”</span> random
1.1 dsieger 2713: numbers, so you need to assure that the machine on which you
2714: are doing the bulk builds is not completely idle. Otherwise
2715: some test programs will seem to hang, while they are just
2716: waiting for new random data to be
2717: available.</p></li>
2718: </ul></div>
2719: </div>
1.41 asau 2720: <div class="sect3">
1.1 dsieger 2721: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 2722: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1 dsieger 2723: </h4></div></div></div>
2724: <p>It is possible to configure the bulk build to perform
2725: certain site-specific tasks at the end of the pre-build
2726: stage. If the file
2727: <code class="filename">pre-build.local</code> exists in
2728: <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.29 dholland 2729: (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.1 dsieger 2730: stage. An example use of
2731: <code class="filename">pre-build.local</code> is to have the line:</p>
2732: <pre class="screen">echo "I do not have enough disk space to build this pig." \
2733: > misc/openoffice/$BROKENF</pre>
2734: <p>to prevent the system from trying to build a particular package
2735: which requires nearly 3 GB of disk space.</p>
2736: </div>
2737: </div>
1.41 asau 2738: <div class="sect2">
1.1 dsieger 2739: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2740: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1 dsieger 2741: <p>As <code class="filename">/usr/pkg</code> will be completely
2742: deleted at the start of bulk builds, make sure your login
2743: shell is placed somewhere else. Either drop it into
2744: <code class="filename">/usr/local/bin</code> (and adjust your login
2745: shell in the passwd file), or (re-)install it via
1.29 dholland 2746: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.1 dsieger 2747: you can login after a reboot (remember that your current
2748: process won't die if the package is removed, you just can't
2749: start any new instances of the shell any more). Also, if you
2750: use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2751: version of ssh for some reason, be sure to install ssh before
2752: starting it from <code class="filename">rc.local</code>:</p>
2753: <pre class="programlisting">
2754: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2755: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2756: /usr/pkg/etc/rc.d/sshd
2757: fi
2758: </pre>
2759: <p>Not doing so will result in you being not able to log in
2760: via ssh after the bulk build is finished or if the machine
2761: gets rebooted or crashes. You have been warned! :)</p>
2762: </div>
1.41 asau 2763: <div class="sect2">
1.1 dsieger 2764: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2765: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1 dsieger 2766: <p>Make sure you don't need any of the packages still
2767: installed.</p>
1.41 asau 2768: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 2769: <h3 class="title">Warning</h3>
2770: <p>During the bulk build, <span class="emphasis"><em>all packages, their
2771: configuration files and some more files from
2772: <code class="filename">/var</code>, <code class="filename">/home</code> and
2773: possibly other locations will be removed! So don't run a bulk
2774: build with privileges that might harm your
2775: system.</em></span></p>
2776: </div>
2777: <p>Be sure to remove all other things that might
2778: interfere with builds, like some libs installed in
2779: <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2780: <pre class="screen">
2781: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2782: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2783: </pre>
2784: <p>If for some reason your last build didn't complete (power
2785: failure, system panic, ...), you can continue it by
2786: running:</p>
2787: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2788: <p>At the end of the bulk build, you will get a summary via mail,
2789: and find build logs in the directory specified by
2790: <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2791: file.</p>
2792: </div>
1.41 asau 2793: <div class="sect2">
1.1 dsieger 2794: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2795: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1 dsieger 2796: <p>The bulk builds consist of three steps:</p>
1.41 asau 2797: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 2798: <dt><span class="term">1. pre-build</span></dt>
2799: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2800: cleans out any broken distfiles, and removes all
2801: packages installed.</p></dd>
2802: <dt><span class="term">2. the bulk build</span></dt>
1.23 wiz 2803: <dd><p>This is basically <span class="quote">“<span class="quote">make bulk-package</span>”</span> with
1.1 dsieger 2804: an optimised order in which packages will be
2805: built. Packages that don't require other packages will
2806: be built first, and packages with many dependencies will
2807: be built later.</p></dd>
2808: <dt><span class="term">3. post-build</span></dt>
2809: <dd><p>Generates a report that's placed in the directory
2810: specified in the <code class="filename">build.conf</code> file
2811: named <code class="filename">broken.html</code>, a short version
2812: of that report will also be mailed to the build's
2813: admin.</p></dd>
2814: </dl></div>
2815: <p>During the build, a list of broken packages will be compiled
2816: in <code class="filename">/usr/pkgsrc/.broken</code> (or
2817: <code class="filename">.../.broken.${MACHINE}</code> if
2818: <code class="varname">OBJMACHINE</code> is set), individual build logs
2819: of broken builds can be found in the package's
2820: directory. These files are used by the bulk-targets to mark
2821: broken builds to not waste time trying to rebuild them, and
2822: they can be used to debug these broken package builds
2823: later.</p>
2824: </div>
1.41 asau 2825: <div class="sect2">
1.1 dsieger 2826: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2827: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1 dsieger 2828: <p>Currently, roughly the following requirements are valid for
2829: NetBSD 2.0/i386:</p>
1.41 asau 2830: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2831: <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
2832: <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
2833: <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
1.1 dsieger 2834: </ul></div>
2835: <p>Note that all pkgs will be de-installed as soon as they are
2836: turned into a binary package, and that sources are removed,
2837: so there is no excessively huge demand to disk
2838: space. Afterwards, if the package is needed again, it will
1.29 dholland 2839: be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.1 dsieger 2840: there are no cycles wasted by recompiling.</p>
2841: </div>
1.41 asau 2842: <div class="sect2">
1.1 dsieger 2843: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2844: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1 dsieger 2845: <p>If you don't want all the packages nuked from a machine
2846: (rendering it useless for anything but pkg compiling), there
2847: is the possibility of doing the package bulk build inside a
2848: chroot environment.</p>
2849: <p>The first step is to set up a chroot sandbox,
2850: e.g. <code class="filename">/usr/sandbox</code>. This can be done by
2851: using null mounts, or manually.</p>
2852: <p>There is a shell script called
1.36 wiz 2853: <code class="filename">mksandbox</code> installed by the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mksandbox/README.html" target="_top"><code class="filename">pkgtools/mksandbox</code></a> package, which will set
1.1 dsieger 2854: up the sandbox environment using null mounts. It will also
2855: create a script called <code class="filename">sandbox</code> in the
2856: root of the sandbox environment, which will allow the null
1.10 hubertf 2857: mounts to be activated using the <span class="command"><strong>sandbox
1.1 dsieger 2858: mount</strong></span> command and deactivated using the
1.10 hubertf 2859: <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1 dsieger 2860: <p>To set up a sandbox environment by hand, after extracting all
1.10 hubertf 2861: the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1 dsieger 2862: distribution DESTDIR=/usr/sandbox</strong></span> in
2863: <code class="filename">/usr/src/etc</code>, be sure the following items
2864: are present and properly configured:</p>
1.23 wiz 2865: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 2866: <li class="step">
1.1 dsieger 2867: <p>Kernel</p>
2868: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2869: </li>
1.41 asau 2870: <li class="step">
1.1 dsieger 2871: <p><code class="filename">/dev/*</code></p>
2872: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2873: </li>
1.41 asau 2874: <li class="step">
1.1 dsieger 2875: <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>
2876: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2877: </li>
1.41 asau 2878: <li class="step">
1.1 dsieger 2879: <p>Working(!) mail config (hostname, sendmail.cf):</p>
2880: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2881: </li>
1.41 asau 2882: <li class="step">
1.1 dsieger 2883: <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>
2884: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2885: </li>
1.41 asau 2886: <li class="step">
1.1 dsieger 2887: <p><code class="filename">/usr/src</code> (system sources,
1.14 jmcneill 2888: e. g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.1 dsieger 2889: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2890: <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2891: </li>
1.41 asau 2892: <li class="step">
1.1 dsieger 2893: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2894: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2895: </li>
1.41 asau 2896: <li class="step">
1.1 dsieger 2897: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
2898: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2899: </li>
1.41 asau 2900: <li class="step">
1.1 dsieger 2901: <p>Checkout pkgsrc via cvs into
2902: <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2903: <pre class="screen">
2904: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2905: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2906: </pre>
2907: <p>Do not mount/link this to the copy of your pkgsrc tree
2908: you do development in, as this will likely cause problems!</p>
2909: </li>
1.41 asau 2910: <li class="step"><p>Make
1.1 dsieger 2911: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2912: <code class="filename">.../distfiles</code> point somewhere
2913: appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.41 asau 2914: <li class="step"><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>
2915: <li class="step"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.1 dsieger 2916: </ol></div>
2917: <p>When the chroot sandbox is set up, you can start
2918: the build with the following steps:</p>
2919: <pre class="screen">
2920: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2921: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2922: </pre>
2923: <p>This will just jump inside the sandbox and start building. At
2924: the end of the build, mail will be sent with the results of
2925: the build. Created binary pkgs will be in
2926: <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2927: (wherever that points/mounts to/from).</p>
2928: </div>
1.41 asau 2929: <div class="sect2">
1.1 dsieger 2930: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2931: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1 dsieger 2932: <p>In addition to building a complete set of all packages in
2933: pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2934: may be used to build a subset of the packages contained in
2935: pkgsrc. By setting <code class="varname">SPECIFIC_PKGS</code>
1.10 hubertf 2936: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.41 asau 2937: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 2938: <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2939: <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2940: <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2941: <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
1.1 dsieger 2942: </ul></div>
2943: <p>will define the set of packages which should be built.
2944: The bulk build code will also include any packages which are
2945: needed as dependencies for the explicitly listed packages.</p>
2946: <p>One use of this is to do a bulk build with
2947: <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2948: periodically to have a complete set of the binary packages
2949: needed for your site available without the overhead of
2950: building extra packages that are not needed.</p>
2951: </div>
1.41 asau 2952: <div class="sect2">
1.1 dsieger 2953: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 2954: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1 dsieger 2955: <p>This section describes how pkgsrc developers can upload binary
2956: pkgs built by bulk builds to ftp.NetBSD.org.</p>
2957: <p>If you would like to automatically create checksum files for the
2958: binary packages you intend to upload, remember to set
2959: <code class="varname">MKSUMS=yes</code> in your
2960: <code class="filename">mk/bulk/build.conf</code>.</p>
2961: <p>If you would like to PGP sign the checksum files (highly
2962: recommended!), remember to set
2963: <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2964: <code class="filename">mk/bulk/build.conf</code>. This will prompt you for
2965: your GPG password to sign the files before uploading everything.</p>
2966: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2967: set properly in your <code class="filename">mk/bulk/build.conf</code>
2968: file, i.e. adjust it to something like one of the following:</p>
1.25 spz 2969: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
2970: <p>Please use appropriate values for "20xxQy" (the branch),
2971: "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
1.1 dsieger 2972: is different from your local login, write your login directly
2973: into the variable, e.g. my local account is "feyrer", but for my
2974: login "hubertf", I use:</p>
1.25 spz 2975: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
1.1 dsieger 2976: <p>A separate <code class="filename">upload</code> directory is used
2977: here to allow "closing" the directory during upload. To do
2978: so, run the following command on ftp.NetBSD.org next:</p>
1.25 spz 2979: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</code></strong></pre>
1.1 dsieger 2980: <p>Before uploading the binary pkgs, ssh authentication needs
2981: to be set up. This example shows how to set up temporary keys
2982: for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2983: (assuming that no keys should be present there usually):</p>
2984: <pre class="screen">
2985: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
2986: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
1.25 spz 2987: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
2988: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
1.1 dsieger 2989: </pre>
1.25 spz 2990: <p>Now take the output of <code class="filename">id-rsa.pub</code> and
1.1 dsieger 2991: append it to your <code class="filename">~/.ssh/authorized_keys</code>
1.25 spz 2992: file on ftp.NetBSD.org. You should remove the key after the
1.1 dsieger 2993: upload is done!</p>
2994: <p>Next, test if your ssh connection really works:</p>
2995: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
2996: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2997: <p>Now after all this works, you can exit the sandbox and start
2998: the upload:</p>
2999: <pre class="screen">
3000: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
3001: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
3002: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
3003: </pre>
1.29 dholland 3004: <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
3005: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.1 dsieger 3006: upload. The upload script will take care of not uploading
1.23 wiz 3007: restricted packages.</p>
1.1 dsieger 3008: <p>After the upload has ended, first thing is to revoke ssh access:</p>
3009: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
3010: Gdd:x! </pre>
3011: <p>Use whatever is needed to remove the key you've entered
3012: before! Last, move the uploaded packages out of the
3013: <code class="filename">upload</code> directory to have them accessible
3014: to everyone:</p>
3015: <pre class="screen">
1.25 spz 3016: nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
1.1 dsieger 3017: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
3018: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.25 spz 3019: nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
3020: nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
1.1 dsieger 3021: </pre>
3022: </div>
3023: </div>
1.41 asau 3024: <div class="sect1">
1.1 dsieger 3025: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3026: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15 rillig 3027: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41 asau 3028: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3029: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
3030: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15 rillig 3031: </ul></div>
1.41 asau 3032: <div class="sect2">
1.15 rillig 3033: <div class="titlepage"><div><div><h3 class="title">
3034: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
3035: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
3036: <pre class="screen">
3037: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3038: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
3039: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
3040: </pre>
3041: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
1.41 asau 3042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3043: <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
3044: <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
3045: <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
3046: <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
3047: <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.15 rillig 3048: </ul></div>
3049: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
3050: <pre class="screen">
3051: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
3052: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
3053: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
3054: </pre>
3055: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
3056: </div>
1.41 asau 3057: <div class="sect2">
1.6 rillig 3058: <div class="titlepage"><div><div><h3 class="title">
1.15 rillig 3059: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14 jmcneill 3060: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15 rillig 3061: <p>TODO: continue writing</p>
1.6 rillig 3062: </div>
3063: </div>
1.41 asau 3064: <div class="sect1">
1.6 rillig 3065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3066: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1 dsieger 3067: <p>After your pkgsrc bulk-build has completed, you may wish to
3068: create a CD-ROM set of the resulting binary packages to assist
3069: in installing packages on other machines. The
3070: <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
3071: a simple tool for creating the ISO 9660 images.
1.10 hubertf 3072: <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1 dsieger 3073: way that keeps all the dependencies for a given package on the same
3074: CD as that package.</p>
1.41 asau 3075: <div class="sect2">
1.1 dsieger 3076: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 3077: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1 dsieger 3078: <p>Complete documentation for cdpack is found in the cdpack(1)
3079: man page. The following short example assumes that the binary
3080: packages are left in
3081: <code class="filename">/usr/pkgsrc/packages/All</code> and that
3082: sufficient disk space exists in <code class="filename">/u2</code> to
3083: hold the ISO 9660 images.</p>
3084: <pre class="screen">
3085: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
3086: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
3087: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
3088: </pre>
3089: <p>If you wish to include a common set of files
3090: (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
3091: etc.) on each CD in the collection, then you need to create a
3092: directory which contains these files. e.g.</p>
3093: <pre class="screen">
3094: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
3095: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" > /tmp/common/README</code></strong>
3096: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" > /tmp/common/COPYING</code></strong>
3097: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3098: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" > /tmp/common/bin/myscript</code></strong>
3099: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" >> /tmp/common/bin/myscript</code></strong>
3100: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3101: </pre>
3102: <p>Now create the images:</p>
3103: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3104: <p>Each image will contain <code class="filename">README</code>,
3105: <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3106: in their root directories.</p>
3107: </div>
3108: </div>
3109: </div>
1.41 asau 3110: <div class="chapter">
1.1 dsieger 3111: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3112: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1 dsieger 3113: <div class="toc">
3114: <p><b>Table of Contents</b></p>
3115: <dl>
1.23 wiz 3116: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3117: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1 dsieger 3118: </dl>
3119: </div>
3120: <p>The files that are installed by pkgsrc are organized in a way that
3121: is similar to what you find in the <code class="filename">/usr</code> directory
3122: of the base system. But some details are different. This is because
3123: pkgsrc initially came from FreeBSD and had adopted its file system
3124: hierarchy. Later it was largely influenced by NetBSD. But no matter
3125: which operating system you are using pkgsrc with, you can expect the
3126: same layout for pkgsrc.</p>
3127: <p>There are mainly four root directories for pkgsrc, which are all
3128: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3129: When pkgsrc has been installed as root, the default locations
3130: are:</p>
3131: <pre class="programlisting">
3132: LOCALBASE= /usr/pkg
3133: PKG_SYSCONFBASE= /usr/pkg/etc
3134: VARBASE= /var
3135: PKG_DBDIR= /var/db/pkg
3136: </pre>
3137: <p>In unprivileged mode (when pkgsrc has been installed as any other
3138: user), the default locations are:</p>
3139: <pre class="programlisting">
3140: LOCALBASE= ${HOME}/pkg
3141: PKG_SYSCONFBASE= ${HOME}/pkg/etc
3142: VARBASE= ${HOME}/pkg/var
3143: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
3144: </pre>
3145: <p>What these four directories are for, and what they look like is
3146: explained below.</p>
1.41 asau 3147: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3148: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1 dsieger 3149: <code class="filename">/usr</code> directory in the base system. It is the
1.23 wiz 3150: <span class="quote">“<span class="quote">main</span>”</span> directory where the files are installed and contains
1.1 dsieger 3151: the well-known subdirectories like <code class="filename">bin</code>,
3152: <code class="filename">include</code>, <code class="filename">lib</code>,
3153: <code class="filename">share</code> and
3154: <code class="filename">sbin</code>.</p></li>
1.23 wiz 3155: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1 dsieger 3156: <code class="filename">/var</code> in the base system. Some programs (especially
3157: games, network daemons) need write access to it during normal
3158: operation.</p></li>
1.23 wiz 3159: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1 dsieger 3160: <code class="filename">/etc</code> in the base system. It contains configuration
1.10 hubertf 3161: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1 dsieger 3162: itself.</p></li>
3163: </ul></div>
1.41 asau 3164: <div class="sect1">
1.1 dsieger 3165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3166: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1 dsieger 3167: </h2></div></div></div>
3168: <p>The following directories exist in a typical pkgsrc installation
3169: in <code class="filename">${LOCALBASE}</code>.</p>
1.41 asau 3170: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3171: <dt><span class="term"><code class="filename">bin</code></span></dt>
3172: <dd><p>Contains executable programs that are intended to be
3173: directly used by the end user.</p></dd>
3174: <dt><span class="term"><code class="filename">emul</code></span></dt>
3175: <dd><p>Contains files for the emulation layers of various other
3176: operating systems, especially for
3177: NetBSD.</p></dd>
3178: <dt><span class="term"><code class="filename">etc</code> (the usual location of
3179: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3180: <dd><p>Contains
3181: the configuration files.</p></dd>
3182: <dt><span class="term"><code class="filename">include</code></span></dt>
3183: <dd><p>Contains headers for the C and C++ programming
3184: languages.</p></dd>
3185: <dt><span class="term"><code class="filename">info</code></span></dt>
3186: <dd><p>Contains GNU info files of various
3187: packages.</p></dd>
3188: <dt><span class="term"><code class="filename">lib</code></span></dt>
3189: <dd><p>Contains shared and static
3190: libraries.</p></dd>
3191: <dt><span class="term"><code class="filename">libdata</code></span></dt>
3192: <dd><p>Contains data files that don't change after
3193: installation. Other data files belong into
3194: <code class="filename">${VARBASE}</code>.</p></dd>
3195: <dt><span class="term"><code class="filename">libexec</code></span></dt>
3196: <dd><p>Contains programs that are not intended to be used by
3197: end users, such as helper programs or network
3198: daemons.</p></dd>
3199: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3200: <dd><p>Contains programs that are intended to be executed as
3201: CGI scripts by a web server.</p></dd>
3202: <dt><span class="term"><code class="filename">man</code> (the usual value of
3203: <code class="filename">${PKGMANDIR}</code>)</span></dt>
3204: <dd><p>Contains brief
3205: documentation in form of manual pages.</p></dd>
3206: <dt><span class="term"><code class="filename">sbin</code></span></dt>
3207: <dd><p>Contains programs that are intended to be used only by
3208: the super-user.</p></dd>
3209: <dt><span class="term"><code class="filename">share</code></span></dt>
3210: <dd><p>Contains platform-independent data files that don't
3211: change after installation.</p></dd>
3212: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3213: <dd><p>Contains documentation files provided by the
3214: packages.</p></dd>
3215: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3216: <dd><p>Contains example files provided by the packages. Among
3217: others, the original configuration files are saved here and copied to
3218: <code class="filename">${PKG_SYSCONFDIR}</code> during
3219: installation.</p></dd>
3220: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3221: <dd><p>Contains the original files for rc.d
3222: scripts.</p></dd>
3223: <dt><span class="term"><code class="filename">var</code> (the usual location of
3224: <code class="filename">${VARBASE}</code>)</span></dt>
3225: <dd><p>Contains files
3226: that may be modified after
3227: installation.</p></dd>
3228: </dl></div>
3229: </div>
1.41 asau 3230: <div class="sect1">
1.1 dsieger 3231: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3232: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1 dsieger 3233: </h2></div></div></div>
1.41 asau 3234: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 3235: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3236: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3237: <dd><p>Contains
3238: information about the currently installed
3239: packages.</p></dd>
3240: <dt><span class="term"><code class="filename">games</code></span></dt>
3241: <dd><p>Contains highscore
3242: files.</p></dd>
3243: <dt><span class="term"><code class="filename">log</code></span></dt>
3244: <dd><p>Contains log files.</p></dd>
3245: <dt><span class="term"><code class="filename">run</code></span></dt>
3246: <dd><p>Contains informational files about daemons that are
3247: currently running.</p></dd>
3248: </dl></div>
3249: </div>
3250: </div>
1.41 asau 3251: <div class="chapter">
1.1 dsieger 3252: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3253: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 3254: <div class="toc">
3255: <p><b>Table of Contents</b></p>
3256: <dl>
1.6 rillig 3257: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3258: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3259: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3260: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3261: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3262: <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>
3263: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.23 wiz 3264: <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.6 rillig 3265: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.23 wiz 3266: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">“<span class="quote">Don't know how to make
3267: /usr/share/tmac/tmac.andoc</span>”</span> mean?</a></span></dt>
3268: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</a></span></dt>
1.6 rillig 3269: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3270: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3271: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.23 wiz 3272: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
1.6 rillig 3273: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build. What shall I do?</a></span></dt>
1.23 wiz 3274: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</a></span></dt>
1.1 dsieger 3275: </dl>
3276: </div>
3277: <p>This section contains hints, tips & tricks on special things in
3278: pkgsrc that we didn't find a better place for in the previous chapters, and
3279: it contains items for both pkgsrc users and developers.</p>
1.41 asau 3280: <div class="sect1">
1.1 dsieger 3281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3282: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1 dsieger 3283: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41 asau 3284: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3285: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1 dsieger 3286: This is a general purpose list for most issues regarding
3287: pkgsrc, regardless of platform, e.g. soliciting user help
3288: for pkgsrc configuration, unexpected build failures, using
3289: particular packages, upgrading pkgsrc installations,
3290: questions regarding the pkgsrc release branches, etc. General announcements or
3291: proposals for changes that impact the pkgsrc user community,
3292: e.g. major infrastructure changes, new features, package
3293: removals, etc., may also be posted.</p></li>
1.23 wiz 3294: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1 dsieger 3295: A list where the results of pkgsrc bulk builds are sent and
3296: discussed.</p></li>
1.23 wiz 3297: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1 dsieger 3298: This list is for those who are interested in getting a
3299: commit message for every change committed to pkgsrc. It is
3300: also available in digest form, meaning one daily message
3301: containing all commit messages for changes to the package
3302: source tree in that 24 hour period.</p></li>
3303: </ul></div>
3304: <p>To subscribe, do:</p>
3305: <pre class="programlisting">
3306: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3307: </pre>
3308: <p>Archives for all these mailing lists are available from
1.10 hubertf 3309: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1 dsieger 3310: </div>
1.41 asau 3311: <div class="sect1">
1.1 dsieger 3312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3313: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1 dsieger 3314: <p>Pkgviews is tightly integrated with buildlink. You can find a
3315: pkgviews User's guide in
3316: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3317: </div>
1.41 asau 3318: <div class="sect1">
1.1 dsieger 3319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3320: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1 dsieger 3321: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3322: a number of useful utilities for both users and developers of pkgsrc. This
3323: section attempts only to make the reader aware of the utilities and when
3324: they might be useful, and not to duplicate the documentation that comes
3325: with each package.</p>
3326: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.41 asau 3327: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><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.1 dsieger 3328: Symlinks for use by buildlink.</p></li></ul></div>
3329: <p>OS tool augmentation (automatically installed when needed):</p>
1.41 asau 3330: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3331: <li class="listitem"><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.1 dsieger 3332: Calculates various kinds of checksums (including SHA1).</p></li>
1.23 wiz 3333: <li class="listitem"><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.1 dsieger 3334: Compatibility library for pkgsrc tools.</p></li>
1.23 wiz 3335: <li class="listitem"><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.1 dsieger 3336: non-BSD systems due to lack of native mtree.</p></li>
1.23 wiz 3337: <li class="listitem"><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.1 dsieger 3338: Up-to-date replacement for
3339: <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3340: systems where pkg_install is not present.</p></li>
3341: </ul></div>
3342: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41 asau 3343: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3344: <li class="listitem"><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.1 dsieger 3345: Create a binary package from an
1.10 hubertf 3346: already-installed package. Used by <span class="command"><strong>make replace</strong></span> to
1.1 dsieger 3347: save the old package.</p></li>
1.23 wiz 3348: <li class="listitem"><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.1 dsieger 3349: Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3350: from multiple locations. It currently supports the following
3351: methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.23 wiz 3352: <li class="listitem"><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.1 dsieger 3353: packages someplace else (enabled by default).</p></li>
1.23 wiz 3354: <li class="listitem"><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
1.16 jnemeth 3355: the best compiler flags to optimise code for your current
1.23 wiz 3356: CPU and compiler. </p></li>
1.1 dsieger 3357: </ul></div>
3358: <p>Utilities for keeping track of installed packages, being up to date,
3359: etc:</p>
1.41 asau 3360: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3361: <li class="listitem"><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.1 dsieger 3362: packages whose installed versions do not match the latest pkgsrc
3363: entries.</p></li>
1.23 wiz 3364: <li class="listitem"><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.1 dsieger 3365: dependency graphs of packages, to aid in choosing a strategy for
3366: updating.</p></li>
1.23 wiz 3367: <li class="listitem"><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
1.1 dsieger 3368: 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>
1.23 wiz 3369: <li class="listitem"><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.12 weinem 3370: pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.23 wiz 3371: <li class="listitem"><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.1 dsieger 3372: does various checks on the complete pkgsrc system.</p></li>
1.23 wiz 3373: <li class="listitem"><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.1 dsieger 3374: packages you have installed.</p></li>
3375: </ul></div>
3376: <p>Utilities for people maintaining or creating individual packages:</p>
1.41 asau 3377: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3378: <li class="listitem"><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.1 dsieger 3379: making and maintaining patches for a package (includes pkgdiff,
3380: pkgvi, mkpatches, etc.).</p></li>
1.23 wiz 3381: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
1.1 dsieger 3382: <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
3383: converting to pkgsrc.</p></li>
1.23 wiz 3384: <li class="listitem"><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.1 dsieger 3385: pkgsrc to a Solaris package.</p></li>
3386: </ul></div>
3387: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3388: utilities)</p>
1.41 asau 3389: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3390: <li class="listitem"><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.1 dsieger 3391: packages in a chrooted area.</p></li>
1.23 wiz 3392: <li class="listitem"><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.1 dsieger 3393: kernel version for chrooted cross builds.</p></li>
3394: </ul></div>
3395: </div>
1.41 asau 3396: <div class="sect1">
1.1 dsieger 3397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3398: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1 dsieger 3399: <p>If you want to use pkgsrc as non-root user, you can set some
3400: variables to make pkgsrc work under these conditions. At the very least,
1.23 wiz 3401: you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">“<span class="quote">yes</span>”</span>; this
1.1 dsieger 3402: will turn on unprivileged mode and set multiple related variables to allow
3403: installation of packages as non-root.</p>
3404: <p>In case the defaults are not enough, you may want to tune some other
3405: variables used. For example, if the automatic user/group detection leads
3406: to incorrect values (or not the ones you would like to use), you can change
3407: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3408: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3409: <p>As regards bootstrapping, please note that the
1.10 hubertf 3410: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.23 wiz 3411: given the <span class="quote">“<span class="quote">--ignore-user-check</span>”</span> flag, as it will choose and
1.1 dsieger 3412: use multiple default directories under <code class="filename">~/pkg</code> as the
3413: installation targets. These directories can be overridden by the
1.23 wiz 3414: <span class="quote">“<span class="quote">--prefix</span>”</span> flag provided by the script, as well as some others
1.1 dsieger 3415: that allow finer tuning of the tree layout.</p>
3416: </div>
1.41 asau 3417: <div class="sect1">
1.1 dsieger 3418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3419: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1 dsieger 3420: <p>By default, resuming transfers in pkgsrc is disabled, but you can
3421: enable this feature by adding the option
3422: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10 hubertf 3423: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. If, during a fetch step, an incomplete
1.1 dsieger 3424: distfile is found, pkgsrc will try to resume it.</p>
3425: <p>You can also
1.29 dholland 3426: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.16 jnemeth 3427: <code class="varname">FETCH_USING</code> variable. You can specify the program by
3428: using of ftp, fetch, wget or curl. Alternatively, fetching can be disabled
3429: by using the value manual. A value of custom disables the system defaults
3430: and dependency tracking for the fetch program. In that case you have to
3431: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3432: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3433: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1 dsieger 3434: <p>For example, if you want to use
1.16 jnemeth 3435: <code class="filename">wget</code> to download, you'll have to use something
1.1 dsieger 3436: like:</p>
3437: <pre class="programlisting">
1.16 jnemeth 3438: FETCH_USING= wget
1.1 dsieger 3439: </pre>
3440: </div>
1.41 asau 3441: <div class="sect1">
1.1 dsieger 3442: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3443: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4 rillig 3444: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1 dsieger 3445: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3446: you will have to add the following line into
1.10 hubertf 3447: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1 dsieger 3448: <pre class="programlisting">
1.4 rillig 3449: X11_TYPE=modular
1.1 dsieger 3450: </pre>
1.41 asau 3451: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 3452: <h3 class="title">Note</h3>
1.4 rillig 3453: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3454: </p>
1.1 dsieger 3455: </div>
3456: </div>
1.41 asau 3457: <div class="sect1">
1.1 dsieger 3458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3459: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1 dsieger 3460: <p>If you are sitting behind a firewall which does not allow direct
3461: connections to Internet hosts (i.e. non-NAT), you may specify the
3462: relevant proxy hosts. This is done using an environment variable in the
3463: form of a URL, e.g. in Amdahl, the machine
1.23 wiz 3464: <span class="quote">“<span class="quote">orpheus.amdahl.com</span>”</span> is one of the firewalls, and it uses
1.1 dsieger 3465: port 80 as the proxy port number. So the proxy environment variables
3466: are:</p>
3467: <pre class="programlisting">
3468: ftp_proxy=ftp://orpheus.amdahl.com:80/
3469: http_proxy=http://orpheus.amdahl.com:80/
3470: </pre>
3471: </div>
1.41 asau 3472: <div class="sect1">
1.1 dsieger 3473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 3474: <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.1 dsieger 3475: <p>This depends on which utility is used to retrieve distfiles. From
3476: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3477: the first available command from the following list:</p>
1.41 asau 3478: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 3479: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3480: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1 dsieger 3481: </ul></div>
3482: <p>On a default NetBSD installation, this will be
3483: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3484: connections first, and falls back to active connections if the server
3485: refuses to do passive. For the other tools, add the following to your
1.10 hubertf 3486: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1 dsieger 3487: <code class="varname">PASSIVE_FETCH=1</code>.</p>
3488: <p>Having that option present will prevent
3489: <code class="filename">/usr/bin/ftp</code> from falling back to active
3490: transfers.</p>
3491: </div>
1.41 asau 3492: <div class="sect1">
1.1 dsieger 3493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3494: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1 dsieger 3495: <p>You would like to download all the distfiles in a single batch
1.10 hubertf 3496: from work or university, where you can't run a <span class="command"><strong>make
1.25 spz 3497: fetch</strong></span>. There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1 dsieger 3498: but downloading the entire directory may not be appropriate.</p>
1.10 hubertf 3499: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1 dsieger 3500: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3501: resulting list to your machine at work/school and use it there. If you
1.29 dholland 3502: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1 dsieger 3503: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3504: URL:</p>
3505: <p>At home:</p>
3506: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3507: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh</code></strong>
3508: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3509: <p>At work:</p>
3510: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3511: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3512: home.</p>
3513: <p>If you have a machine running NetBSD, and you want to get
3514: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3515: machine architecture), you can do so by using the above-mentioned
1.10 hubertf 3516: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1 dsieger 3517: directly by running:</p>
3518: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3519: <p>If you even decide to ignore
3520: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3521: by running:</p>
3522: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3523: </div>
1.41 asau 3524: <div class="sect1">
1.1 dsieger 3525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23 wiz 3526: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">“<span class="quote">Don't know how to make
3527: /usr/share/tmac/tmac.andoc</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3528: <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>
3529: package, you get the error from make that it doesn't know how to make
3530: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23 wiz 3531: you don't have installed the <span class="quote">“<span class="quote">text</span>”</span> set (nroff, ...) from
1.1 dsieger 3532: the NetBSD base distribution on your machine. It is recommended to do
3533: that to format man pages.</p>
3534: <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
3535: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10 hubertf 3536: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 3537: </div>
1.41 asau 3538: <div class="sect1">
1.1 dsieger 3539: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23 wiz 3540: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">“<span class="quote">Could not find bsd.own.mk</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3541: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3542: when you installed your NetBSD machine. Please get and install it, by
3543: extracting it in <code class="filename">/</code>:</p>
3544: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3545: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3546: <p><code class="filename">comp.tgz</code> is part of every NetBSD release. Get
1.10 hubertf 3547: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1 dsieger 3548: -r</strong></span>).</p>
3549: </div>
1.41 asau 3550: <div class="sect1">
1.1 dsieger 3551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3552: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1 dsieger 3553: <p>When installing packages as non-root user and using the just-in-time
1.29 dholland 3554: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1 dsieger 3555: password for each required package installed. To avoid this, the sudo
3556: package can be used, which does password caching over a limited time. To
3557: use it, install sudo (either as binary package or from
3558: <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.10 hubertf 3559: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1 dsieger 3560: <span class="emphasis"><em>after</em></span> the definition of the
3561: <code class="varname">LOCALBASE</code> variable:</p>
3562: <pre class="programlisting">
3563: .if exists(${LOCALBASE}/bin/sudo)
3564: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3565: .endif
3566: </pre>
3567: </div>
1.41 asau 3568: <div class="sect1">
1.1 dsieger 3569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3570: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1 dsieger 3571: <p>As the system administrator, you can choose where configuration files
3572: are installed. The default settings make all these files go into
3573: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3574: be suboptimal depending on your expectations (e.g., a read-only,
3575: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3576: configuration of the provided packages).</p>
3577: <p>In order to change the defaults, you can modify the
3578: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10 hubertf 3579: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1 dsieger 3580: directory; some common examples include <code class="filename">/etc</code> or
3581: <code class="filename">/etc/pkg</code>.</p>
3582: <p>Furthermore, you can change this value on a per-package basis by
3583: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3584: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3585: package you would like to modify, that is, the contents of
3586: <code class="varname">PKGBASE</code>.</p>
3587: <p>Note that after changing these settings, you must rebuild and
3588: reinstall any affected packages.</p>
3589: </div>
1.41 asau 3590: <div class="sect1">
1.1 dsieger 3591: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3592: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1 dsieger 3593: <p>Please be aware that there can often be bugs in third-party software,
3594: and some of these bugs can leave a machine vulnerable to exploitation by
3595: attackers. In an effort to lessen the exposure, the NetBSD packages team
3596: maintains a database of known-exploits to packages which have at one time
3597: been included in pkgsrc. The database can be downloaded automatically, and
3598: a security audit of all packages installed on a system can take place. To
1.14 jmcneill 3599: do this, refer to the following two tools (installed as part of the
3600: <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):</p>
1.23 wiz 3601: <div class="orderedlist"><ol class="orderedlist" type="1">
3602: <li class="listitem">
1.20 snj 3603: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1 dsieger 3604: download a list of the security vulnerabilities information. This list
1.25 spz 3605: is kept up to date by the pkgsrc security team, and is distributed
3606: from the NetBSD ftp server:</p>
3607: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1 dsieger 3608: </li>
1.23 wiz 3609: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3610: current machine, checking each known vulnerability. If a
1.1 dsieger 3611: vulnerable package is installed, it will be shown by output to stdout,
3612: including a description of the type of vulnerability, and a URL
3613: containing more information.</p></li>
3614: </ol></div>
1.14 jmcneill 3615: <p>Use of these tools is strongly recommended! After
1.23 wiz 3616: <span class="quote">“<span class="quote">pkg_install</span>”</span> is installed, please read
1.1 dsieger 3617: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14 jmcneill 3618: pkg_install</code></strong>.</p>
1.1 dsieger 3619: <p>If this package is installed, pkgsrc builds will use it to
1.10 hubertf 3620: 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.1 dsieger 3621: check.</p>
3622: </div>
1.41 asau 3623: <div class="sect1">
1.1 dsieger 3624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3625: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1 dsieger 3626: <p>When you add your own preferences to the
3627: <code class="varname">CFLAGS</code> variable in your
1.10 hubertf 3628: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1 dsieger 3629: environment variables to the <code class="filename">./configure</code>
1.29 dholland 3630: scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1 dsieger 3631: <code class="varname">CFLAGS</code> from the environment variable by
3632: overriding them in the <code class="filename">Makefile</code>s of their
3633: package.</p>
3634: <p>Currently there is no solution to this problem. If you
3635: really need the package to use your <code class="varname">CFLAGS</code>
1.10 hubertf 3636: you should run <span class="command"><strong>make patch</strong></span> in the package
1.1 dsieger 3637: directory and then inspect any <code class="filename">Makefile</code> and
3638: <code class="filename">Makefile.in</code> for whether they define
3639: <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23 wiz 3640: these lines. But be aware that some <span class="quote">“<span class="quote">smart</span>”</span>
1.1 dsieger 3641: programmers write so bad code that it only works for the
3642: specific combination of <code class="varname">CFLAGS</code> they have
3643: chosen.</p>
3644: </div>
1.41 asau 3645: <div class="sect1">
1.1 dsieger 3646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 3647: <a name="ufaq-fail"></a>9.16. A package does not build. What shall I do?</h2></div></div></div>
1.23 wiz 3648: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3649: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1 dsieger 3650: case that occurs often is that people only update pkgsrc in
3651: parts, because of performance reasons. Since pkgsrc is one large
3652: system, not a collection of many small systems, there are
3653: sometimes changes that only work when the whole pkgsrc tree is
3654: updated.</p></li>
1.41 asau 3655: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23 wiz 3656: Search for <span class="quote">“<span class="quote"><<<<<<</span>”</span> or
3657: <span class="quote">“<span class="quote">>>>>>></span>”</span> in all your pkgsrc
1.1 dsieger 3658: files.</p></li>
1.41 asau 3659: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10 hubertf 3660: extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1 dsieger 3661: verify this.</p></li>
1.41 asau 3662: <li class="step"><p>If the problem still exists, write a mail to the
1.1 dsieger 3663: <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3664: </ol></div>
3665: </div>
1.41 asau 3666: <div class="sect1">
1.1 dsieger 3667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.23 wiz 3668: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">“<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>”</span> mean?</h2></div></div></div>
1.1 dsieger 3669: <p>You have modified a file from pkgsrc, and someone else has
3670: modified that same file afterwards in the CVS repository. Both changes
3671: are in the same region of the file, so when you updated pkgsrc, the
3672: <code class="literal">cvs</code> command marked the conflicting changes in the
3673: file. Because of these markers, the file is no longer a valid
3674: <code class="filename">Makefile</code>.</p>
3675: <p>Have a look at that file, and if you don't need your local changes
1.10 hubertf 3676: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1 dsieger 3677: -dP</strong></span> in that directory to download the current version.</p>
3678: </div>
3679: </div>
3680: </div>
1.41 asau 3681: <div class="part">
1.1 dsieger 3682: <div class="titlepage"><div><div><h1 class="title">
3683: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41 asau 3684: <div class="partintro">
1.1 dsieger 3685: <div></div>
3686: <p>This part of the book deals with creating and
1.23 wiz 3687: modifying packages. It starts with a <span class="quote">“<span class="quote">HOWTO</span>”</span>-like
1.1 dsieger 3688: guide on creating a new package. The remaining chapters are more
3689: like a reference manual for pkgsrc.</p>
3690: <div class="toc">
3691: <p><b>Table of Contents</b></p>
3692: <dl>
1.6 rillig 3693: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1 dsieger 3694: <dd><dl>
1.6 rillig 3695: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3696: <dd><dl>
1.6 rillig 3697: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3698: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17 imil 3699: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3700: </dl></dd>
1.6 rillig 3701: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3702: <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>
3703: </dl></dd>
3704: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3705: <dd><dl>
1.23 wiz 3706: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3707: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 3708: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3709: <dd><dl>
3710: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3711: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3712: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3713: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3714: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3715: </dl></dd>
3716: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3717: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3718: <dd><dl>
3719: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3720: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3721: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3722: </dl></dd>
1.23 wiz 3723: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3724: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6 rillig 3725: </dl></dd>
1.23 wiz 3726: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6 rillig 3727: <dd><dl>
3728: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 3729: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 3730: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3731: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3732: <dd><dl>
3733: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3734: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3735: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3736: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3737: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3738: </dl></dd>
3739: </dl></dd>
3740: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3741: <dd><dl>
3742: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 3743: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3744: <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.6 rillig 3745: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3746: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 3747: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 3748: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3749: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3750: </dl></dd>
3751: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3752: <dd><dl>
3753: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 3754: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3755: <dd><dl>
3756: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 3757: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3758: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3759: and
3760: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3761: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6 rillig 3762: </dl></dd>
1.23 wiz 3763: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6 rillig 3764: <dd><dl>
1.23 wiz 3765: <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>
1.6 rillig 3766: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3767: </dl></dd>
3768: </dl></dd>
3769: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3770: <dd><dl>
3771: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3772: <dd><dl>
3773: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3774: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3775: </dl></dd>
3776: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3777: <dd><dl>
1.23 wiz 3778: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 3779: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3780: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3781: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3782: </dl></dd>
3783: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3784: <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>
3785: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3786: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3787: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3788: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3789: <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>
3790: </dl></dd>
3791: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3792: <dd><dl>
3793: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 3794: <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>
1.6 rillig 3795: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 3796: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6 rillig 3797: </dl></dd>
3798: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3799: <dd><dl>
3800: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3801: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3802: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3803: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 3804: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 3805: <dd><dl>
3806: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3807: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3808: </dl></dd>
1.23 wiz 3809: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3810: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3811: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3812: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3813: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3814: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3815: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3816: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3817: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3818: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 3819: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3820: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3821: </dl></dd>
3822: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3823: <dd><dl>
3824: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3825: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3826: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3827: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3828: </dl></dd>
3829: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3830: <dd><dl>
3831: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3832: <dd><dl>
3833: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 3834: <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>
1.6 rillig 3835: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3836: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3837: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3838: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3839: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3840: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3841: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3842: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3843: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3844: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3845: </dl></dd>
1.23 wiz 3846: <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>
1.6 rillig 3847: <dd><dl>
3848: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3849: <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>
3850: </dl></dd>
1.23 wiz 3851: <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>
1.6 rillig 3852: <dd><dl>
3853: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3854: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3855: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3856: </dl></dd>
3857: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3858: <dd><dl>
3859: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3860: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3861: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 3862: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
3863: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 3864: </dl></dd>
1.23 wiz 3865: <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>
1.6 rillig 3866: <dd><dl>
3867: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3868: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 3869: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 3870: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3871: </dl></dd>
1.23 wiz 3872: <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>
1.6 rillig 3873: <dd><dl>
3874: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3875: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3876: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3877: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3878: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3879: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3880: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3881: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 3882: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 3883: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 3884: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3885: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3886: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3887: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3888: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3889: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3890: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3891: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 3892: emulation</a></span></dt>
1.6 rillig 3893: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3894: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 3895: </dl></dd>
1.6 rillig 3896: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 3897: </dl></dd>
1.6 rillig 3898: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3899: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1 dsieger 3900: <dd><dl>
1.6 rillig 3901: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3902: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3903: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 3904: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 3905: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 3906: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3907: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.6 rillig 3908: </dl></dd>
3909: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3910: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3911: <dd><dl>
3912: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3913: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3914: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3915: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 3916: </dl></dd>
3917: </dl>
3918: </div>
3919: </div>
1.41 asau 3920: <div class="chapter">
1.1 dsieger 3921: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 3922: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1 dsieger 3923: <div class="toc">
3924: <p><b>Table of Contents</b></p>
3925: <dl>
1.6 rillig 3926: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1 dsieger 3927: <dd><dl>
1.6 rillig 3928: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3929: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17 imil 3930: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1 dsieger 3931: </dl></dd>
1.6 rillig 3932: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3933: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1 dsieger 3934: </dl>
3935: </div>
3936: <p>When you find a package that is not yet in pkgsrc, you
3937: most likely have a URL from where you can download the source
3938: code. Starting with this URL, creating a package involves only a
3939: few steps.</p>
1.23 wiz 3940: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 3941: <li class="step"><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>
3942: <li class="step"><p>Then, choose one of the top-level directories as the
1.1 dsieger 3943: category in which you want to place your package. You can also create a
3944: directory of your own (maybe called <code class="filename">local</code>). In that
3945: category directory, create another directory for your package and change
3946: into it.</p></li>
1.41 asau 3947: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1 dsieger 3948: you for a URL. Enter the URL of the distribution file (in most cases a
3949: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3950: of your package are created automatically. The distribution file is
3951: extracted automatically to fill in some details in the
3952: <code class="filename">Makefile</code> that would otherwise have to be done
3953: manually.</p></li>
1.41 asau 3954: <li class="step">
1.1 dsieger 3955: <p>Examine the extracted files to determine the dependencies of
3956: your package. Ideally, this is mentioned in some
3957: <code class="filename">README</code> file, but things may differ. For each of
3958: these dependencies, look where it exists in pkgsrc, and if there is a
3959: file called <code class="filename">buildlink3.mk</code> in that directory, add a
3960: line to your package <code class="filename">Makefile</code> which includes that
3961: file just before the last line. If the
1.25 spz 3962: <code class="filename">buildlink3.mk</code> file does not exist, it must be
3963: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3964: <p>If you just need binaries from a package, add a
1.1 dsieger 3965: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3966: version of the dependency and where it can be found in pkgsrc. This line
3967: should be placed in the third paragraph. If the dependency is only
3968: needed for building the package, but not when using it, use
3969: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3970: Your package may then look like this:</p>
3971: <pre class="programlisting">
3972: [...]
3973:
3974: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3975: DEPENDS+= screen-[0-9]*:../../misc/screen
3976: DEPENDS+= screen>=4.0:../../misc/screen
3977:
3978: [...]
3979:
3980: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3981: .include "../../devel/glib2/buildlink3.mk"
3982: .include "../../mk/bsd.pkg.mk"
3983: </pre>
3984: </li>
1.41 asau 3985: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23 wiz 3986: to be done to make your package a <span class="quote">“<span class="quote">good</span>”</span> one. If you don't
1.10 hubertf 3987: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3988: --explain</strong></span> or <span class="command"><strong>pkglint
1.1 dsieger 3989: -e</strong></span>, which outputs additional
3990: explanations.</p></li>
1.41 asau 3991: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10 hubertf 3992: 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.1 dsieger 3993: over there, you can hopefully continue here.</p></li>
1.41 asau 3994: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1 dsieger 3995: directory from the extracted files. Besides these files, a lot of cache
3996: files and other system information has been saved in the working
3997: directory, which may become wrong after you edited the
3998: <code class="filename">Makefile</code>.</p></li>
1.41 asau 3999: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10 hubertf 4000: 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.41 asau 4001: <li class="step"><p>When the package builds fine, the next step is to install
1.10 hubertf 4002: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1 dsieger 4003: everything works.</p></li>
1.41 asau 4004: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1 dsieger 4005: contains a list of the files that are installed by the package, is
1.10 hubertf 4006: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1 dsieger 4007: >PLIST</strong></span> to generate a probably correct list. Check
4008: the file using your preferred text editor to see if the list of
4009: files looks plausible.</p></li>
1.41 asau 4010: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1 dsieger 4011: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41 asau 4012: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1 dsieger 4013: has been registered in the database of installed files, but with an
1.10 hubertf 4014: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
4015: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1 dsieger 4016: registered with the list of files from
4017: <code class="filename">PLIST</code>.</p></li>
1.41 asau 4018: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1 dsieger 4019: package from the set of installed files.</p></li>
4020: </ol></div>
1.41 asau 4021: <div class="sect1">
1.1 dsieger 4022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4023: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41 asau 4024: <div class="sect2">
1.1 dsieger 4025: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4026: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1 dsieger 4027: <p>Simple Perl modules are handled automatically by
1.10 hubertf 4028: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1 dsieger 4029: </div>
1.41 asau 4030: <div class="sect2">
1.1 dsieger 4031: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4032: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1 dsieger 4033: <p>KDE applications should always include
4034: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
4035: settings that are typical of KDE packages.</p>
4036: </div>
1.41 asau 4037: <div class="sect2">
1.17 imil 4038: <div class="titlepage"><div><div><h3 class="title">
4039: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
4040: <p>Python modules and programs packages are easily created using a
4041: set of predefined variables.</p>
1.23 wiz 4042: <p>Most Python packages use either <span class="quote">“<span class="quote">distutils</span>”</span> or
4043: easy-setup (<span class="quote">“<span class="quote">eggs</span>”</span>).
4044: If the software uses <span class="quote">“<span class="quote">distutils</span>”</span>, set the
4045: <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">“<span class="quote">yes</span>”</span> so
1.17 imil 4046: pkgsrc will make use of this framework.
1.23 wiz 4047: <span class="quote">“<span class="quote">distutils</span>”</span> uses a script called <code class="filename">setup.py</code>,
4048: if the <span class="quote">“<span class="quote">distutils</span>”</span> driver is not called
1.17 imil 4049: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
4050: to the name of the script.</p>
4051: <p>
4052: If the default Python versions are not supported by the software, set the
4053: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
4054: the software is known to work with, from the most recent to the older
4055: one, e.g.
4056: </p>
4057: <pre class="programlisting">
1.39 wiz 4058: PYTHON_VERSIONS_ACCEPTED= 31 27 26
1.17 imil 4059: </pre>
4060: <p>
4061: If the packaged software is a Python module, include
1.23 wiz 4062: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>”</span>.
1.17 imil 4063: In this case, the package directory should be called
1.23 wiz 4064: <span class="quote">“<span class="quote">py-software</span>”</span> and <code class="varname">PKGNAME</code> should be set to
4065: <span class="quote">“<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>”</span>, e.g.
1.17 imil 4066: </p>
4067: <pre class="programlisting">
4068: DISTNAME= foopymodule-1.2.10
4069: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
4070: </pre>
4071: <p>If it is an application, also include
1.23 wiz 4072: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>”</span>
4073: before <span class="quote">“<span class="quote">extension.mk</span>”</span>.</p>
1.17 imil 4074: <p>If the packaged software, either it is an application or a module, is
4075: egg-aware, you only need to include
1.23 wiz 4076: <span class="quote">“<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>”</span>.</p>
1.17 imil 4077: <p>In order to correctly set the path to the Python interpreter, use the
4078: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35 wiz 4079: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
4080: For example :
1.17 imil 4081: </p>
4082: <pre class="programlisting">
1.35 wiz 4083: REPLACE_PYTHON= *.py
1.17 imil 4084: </pre>
4085: </div>
1.1 dsieger 4086: </div>
1.41 asau 4087: <div class="sect1">
1.1 dsieger 4088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4089: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41 asau 4090: <div class="sect2">
1.1 dsieger 4091: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4092: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41 asau 4093: <div class="sect3">
1.1 dsieger 4094: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4095: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1 dsieger 4096: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23 wiz 4097: that the <span class="quote">“<span class="quote">nvu</span>”</span> package has not yet been imported into
1.1 dsieger 4098: pkgsrc. As the description says it has to do with the web, the obvious
1.23 wiz 4099: choice for the category is <span class="quote">“<span class="quote">www</span>”</span>.</p>
1.1 dsieger 4100: <pre class="programlisting">
4101: <code class="prompt">$</code> mkdir www/nvu
4102: <code class="prompt">$</code> cd www/nvu
4103: </pre>
4104: <p>The web site says that the sources are available as a tar file, so
1.10 hubertf 4105: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1 dsieger 4106: <pre class="programlisting">
4107: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4108: </pre>
4109: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4110: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23 wiz 4111: not have the word <span class="quote">“<span class="quote">sources</span>”</span> in it. I also filled in the
1.1 dsieger 4112: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4113: <code class="varname">COMMENT</code> fields. Then the package
4114: <code class="filename">Makefile</code> looked like that:</p>
4115: <pre class="programlisting">
4116: # $NetBSD$
4117: #
4118:
4119: DISTNAME= nvu-1.0-sources
4120: PKGNAME= nvu-1.0
4121: CATEGORIES= www
4122: MASTER_SITES= http://cvs.nvu.com/download/
4123: EXTRACT_SUFX= .tar.bz2
4124:
4125: MAINTAINER= rillig@NetBSD.org
4126: HOMEPAGE= http://cvs.nvu.com/
4127: COMMENT= Web Authoring System
4128:
4129: # url2pkg-marker (please do not remove this line.)
4130: .include "../../mk/bsd.pkg.mk"
4131: </pre>
4132: <p>Then, I quit the editor and watched pkgsrc downloading a large
4133: source archive:</p>
4134: <pre class="programlisting">
4135: url2pkg> Running "make makesum" ...
4136: => Required installed package digest>=20010302: digest-20060826 found
4137: => Fetching nvu-1.0-sources.tar.bz2
4138: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4139: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4140: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4141: url2pkg> Running "make extract" ...
4142: => Required installed package digest>=20010302: digest-20060826 found
4143: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4144: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4145: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4146: ===> Installing dependencies for nvu-1.0
4147: ===> Overriding tools for nvu-1.0
4148: ===> Extracting for nvu-1.0
4149: url2pkg> Adjusting the Makefile.
4150:
4151: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4152:
4153: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4154: </pre>
4155: </div>
1.41 asau 4156: <div class="sect3">
1.1 dsieger 4157: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4158: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1 dsieger 4159: <p>Now that the package has been extracted, let's see what's inside
4160: it. The package has a <code class="filename">README.txt</code>, but that only
4161: says something about mozilla, so it's probably useless for seeing what
4162: dependencies this package has. But since there is a GNU configure script
4163: in the package, let's hope that it will complain about everything it
4164: needs.</p>
4165: <pre class="programlisting">
4166: <code class="prompt">$</code> bmake
4167: => Required installed package digest>=20010302: digest-20060826 found
4168: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4169: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4170: ===> Patching for nvu-1.0
4171: ===> Creating toolchain wrappers for nvu-1.0
4172: ===> Configuring for nvu-1.0
4173: [...]
4174: configure: error: Perl 5.004 or higher is required.
4175: [...]
4176: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4177: [...]
4178: </pre>
4179: <p>That worked quite well. So I opened the package Makefile in my
4180: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23 wiz 4181: just appended <span class="quote">“<span class="quote">perl</span>”</span> to it. Since the dependencies of the
1.1 dsieger 4182: package have changed now, and since a perl wrapper is automatically
1.23 wiz 4183: installed in the <span class="quote">“<span class="quote">tools</span>”</span> phase, I need to build the package
1.1 dsieger 4184: from scratch.</p>
4185: <pre class="programlisting">
4186: <code class="prompt">$</code> bmake clean
4187: ===> Cleaning for nvu-1.0
4188: <code class="prompt">$</code> bmake
4189: [...]
4190: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4191: GNU Make. You will not be able to build Mozilla without GNU Make.
4192: [...]
4193: </pre>
1.23 wiz 4194: <p>So I added <span class="quote">“<span class="quote">gmake</span>”</span> to the
1.1 dsieger 4195: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4196: <pre class="programlisting">
4197: [...]
4198: checking for GTK - version >= 1.2.0... no
4199: *** Could not run GTK test program, checking why...
4200: [...]
4201: </pre>
4202: <p>Now to the other dependencies. The first question is: Where is the
4203: GTK package hidden in pkgsrc?</p>
4204: <pre class="programlisting">
4205: <code class="prompt">$</code> echo ../../*/gtk*
4206: [many packages ...]
4207: <code class="prompt">$</code> echo ../../*/gtk
4208: ../../x11/gtk
4209: <code class="prompt">$</code> echo ../../*/gtk2
4210: ../../x11/gtk2
4211: <code class="prompt">$</code> echo ../../*/gtk2/bui*
4212: ../../x11/gtk2/buildlink3.mk
4213: </pre>
4214: <p>The first try was definitely too broad. The second one had exactly
4215: one result, which is very good. But there is one pitfall with GNOME
4216: packages. Before GNOME 2 had been released, there were already many
4217: GNOME 1 packages in pkgsrc. To be able to continue to use these
4218: packages, the GNOME 2 packages were imported as separate packages, and
1.23 wiz 4219: their names usually have a <span class="quote">“<span class="quote">2</span>”</span> appended. So I checked
1.1 dsieger 4220: whether this was the case here, and indeed it was.</p>
4221: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4222: file, adding the dependency is very easy. I just inserted an
4223: <code class="literal">.include</code> line before the last line of the package
4224: <code class="filename">Makefile</code>, so that it now looks like this:</p>
4225: <pre class="programlisting">
4226: [...]
4227: .include "../../x11/gtk2/buildlink3.mk"
4228: .include "../../mk/bsd.pkg.mk
4229: </pre>
1.10 hubertf 4230: <p>After another <span class="command"><strong>bmake clean && bmake</strong></span>, the answer
1.1 dsieger 4231: was:</p>
4232: <pre class="programlisting">
4233: [...]
4234: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4235: checking for GTK - version >= 1.2.0... no
4236: *** Could not run GTK test program, checking why...
4237: *** The test program failed to compile or link. See the file config.log for the
4238: *** exact error that occured. This usually means GTK was incorrectly installed
4239: *** or that you have moved GTK since it was installed. In the latter case, you
4240: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4241: configure: error: Test for GTK failed.
4242: [...]
4243: </pre>
1.23 wiz 4244: <p>In this particular case, the assumption that <span class="quote">“<span class="quote">every package
4245: prefers GNOME 2</span>”</span> had been wrong. The first of the lines above
1.1 dsieger 4246: told me that this package really wanted to have the GNOME 1 version of
4247: GTK. If the package had looked for GTK2, it would have looked for
1.10 hubertf 4248: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1 dsieger 4249: So I changed the <code class="literal">x11/gtk2</code> to
4250: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4251: and tried again.</p>
4252: <pre class="programlisting">
4253: [...]
4254: 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
4255: In file included from xpidl.c:42:
4256: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4257: In file included from xpidl.c:42:
4258: xpidl.h:132: error: parse error before "IDL_ns"
4259: [...]
4260: </pre>
4261: <p>The package still does not find all of its dependencies. Now the
4262: question is: Which package provides the
4263: <code class="filename">libIDL/IDL.h</code> header file?</p>
4264: <pre class="programlisting">
4265: <code class="prompt">$</code> echo ../../*/*idl*
4266: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4267: <code class="prompt">$</code> echo ../../*/*IDL*
4268: ../../net/libIDL
4269: </pre>
4270: <p>Let's take the one from the second try. So I included the
4271: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4272: again. But the error didn't change. After digging through some of the
4273: code, I concluded that the build process of the package was broken and
4274: couldn't have ever worked, but since the Mozilla source tree is quite
4275: large, I didn't want to fix it. So I added the following to the package
4276: <code class="filename">Makefile</code> and tried again:</p>
4277: <pre class="programlisting">
4278: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4279: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
4280: </pre>
4281: <p>The latter line is needed because the package expects the library
4282: <code class="filename">libIDL.so</code>, but only
4283: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4284: wrapper to rewrite that on the fly.</p>
4285: <p>The next problem was related to a recent change of the FreeType
4286: 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>
4287: which patch files were relevant for this issue and copied them to the
4288: <code class="filename">patches</code> directory. Then I retried, fixed the
4289: patches so that they applied cleanly and retried again. This time,
4290: everything worked.</p>
4291: </div>
1.41 asau 4292: <div class="sect3">
1.1 dsieger 4293: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 4294: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1 dsieger 4295: <pre class="programlisting">
4296: <code class="prompt">$</code> bmake CHECK_FILES=no install
4297: [...]
4298: <code class="prompt">$</code> bmake print-PLIST >PLIST
4299: <code class="prompt">$</code> bmake deinstall
4300: <code class="prompt">$</code> bmake install
4301: </pre>
4302: </div>
4303: </div>
4304: </div>
4305: </div>
1.41 asau 4306: <div class="chapter">
1.1 dsieger 4307: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4308: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1 dsieger 4309: <div class="toc">
4310: <p><b>Table of Contents</b></p>
4311: <dl>
1.23 wiz 4312: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4313: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.6 rillig 4314: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4315: <dd><dl>
4316: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4317: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4318: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4319: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4320: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4321: </dl></dd>
4322: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4323: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4324: <dd><dl>
4325: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4326: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4327: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1 dsieger 4328: </dl></dd>
1.23 wiz 4329: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4330: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1 dsieger 4331: </dl>
4332: </div>
4333: <p>Whenever you're preparing a package, there are a number of
4334: files involved which are described in the following
4335: sections.</p>
1.41 asau 4336: <div class="sect1">
1.1 dsieger 4337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4338: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1 dsieger 4339: </h2></div></div></div>
4340: <p>Building, installation and creation of a binary package are all
4341: controlled by the package's <code class="filename">Makefile</code>.
4342: The <code class="filename">Makefile</code> describes various things about
4343: a package, for example from where to get it, how to configure,
4344: build, and install it.</p>
4345: <p>A package <code class="filename">Makefile</code> contains several
4346: sections that describe the package.</p>
4347: <p>In the first section there are the following variables, which
4348: should appear exactly in the order given here. The order and
4349: grouping of the variables is mostly historical and has no further
4350: meaning.</p>
1.41 asau 4351: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4352: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1 dsieger 4353: distribution file to be downloaded from the package's
4354: website.</p></li>
1.23 wiz 4355: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.1 dsieger 4356: package, as used by pkgsrc. You only need to provide it if
4357: <code class="varname">DISTNAME</code> (which is the default) is not a good
4358: name for the package in pkgsrc. Usually it is the pkgsrc
4359: directory name together with the version number. It must match the
4360: regular expression
4361: <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4362: starts with a letter or digit, and contains only letters, digits,
4363: dashes, underscores, dots and plus signs.</p></li>
1.23 wiz 4364: <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
1.1 dsieger 4365: the package file to create if the <code class="varname">PKGNAME</code>
4366: isn't unique on a SVR4 system. The default is
4367: <code class="varname">PKGNAME</code>, which may be shortened when you use
4368: <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
4369: <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4370: does not produce an unique package name on a SVR4 system.
4371: The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4372: characters.</p></li>
1.23 wiz 4373: <li class="listitem">
1.1 dsieger 4374: <p><code class="varname">CATEGORIES</code> is a list of categories
4375: which the package fits in. You can choose any of the top-level
4376: directories of pkgsrc for it.</p>
4377: <p>Currently the following values are available for
4378: <code class="varname">CATEGORIES</code>. If more than
4379: one is used, they need to be separated by spaces:</p>
4380: <pre class="programlisting">
4381: archivers cross geography meta-pkgs security
4382: audio databases graphics misc shells
4383: benchmarks devel ham multimedia sysutils
4384: biology editors inputmethod net textproc
4385: cad emulators lang news time
4386: chat finance mail parallel wm
4387: comms fonts math pkgtools www
4388: converters games mbone print x11
4389: </pre>
4390: </li>
1.23 wiz 4391: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1 dsieger 4392: <code class="varname">DYNAMIC_MASTER_SITES</code>,
4393: <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4394: and <code class="varname">DISTFILES</code> are discussed in detail in
1.23 wiz 4395: <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.1 dsieger 4396: </ul></div>
4397: <p>The second section contains information about separately
4398: downloaded patches, if any.
4399: </p>
1.41 asau 4400: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4401: <li class="listitem"><p><code class="varname">PATCHFILES:</code>
1.1 dsieger 4402: Name(s) of additional files that contain distribution patches.
4403: There is no default. pkgsrc will look for them at
4404: <code class="varname">PATCH_SITES</code>.
4405: They will automatically be uncompressed before patching if
4406: the names end with <code class="filename">.gz</code> or
4407: <code class="filename">.Z</code>.</p></li>
1.23 wiz 4408: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1 dsieger 4409: Primary location(s) for distribution patch files (see
4410: <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4411: </ul></div>
4412: <p>The third section contains the following variables.
4413: </p>
1.41 asau 4414: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4415: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14 jmcneill 4416: address of the person who feels responsible for this package,
4417: and who is most likely to look at problems or questions regarding
1.29 dholland 4418: this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14 jmcneill 4419: Other developers may contact the <code class="varname">MAINTAINER</code>
4420: before making changes to the package, but are not required to
4421: do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4422: to yourself. If you really can't maintain the package for future
4423: updates, set it to
1.10 hubertf 4424: <code class="email"><<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>></code>.</p></li>
1.23 wiz 4425: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14 jmcneill 4426: of <code class="varname">MAINTAINER</code> when you do not want other
4427: developers to update or change the package without contacting
4428: you first. A package Makefile should contain one of
4429: <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4430: not both. </p></li>
1.23 wiz 4431: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1 dsieger 4432: find more information about the package.</p></li>
1.23 wiz 4433: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1 dsieger 4434: description of the package (should not include the package
4435: name).</p></li>
4436: </ul></div>
4437: <p>Other variables that affect the build:
4438: </p>
1.41 asau 4439: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4440: <p><code class="varname">WRKSRC</code>: The directory where the
4441: interesting distribution files of the package are found. The
4442: default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4443: works for most packages.</p>
4444: <p>If a package doesn't create a subdirectory for itself
4445: (most GNU software does, for instance), but extracts itself in
4446: the current directory, you should set
4447: <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4448: <p>If a package doesn't create a subdirectory with the
4449: name of <code class="varname">DISTNAME</code> but some different name,
4450: set <code class="varname">WRKSRC</code> to point to the proper name in
4451: <code class="filename">${WRKDIR}</code>, for example
4452: <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4453: <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>
4454: <p>The name of the working directory created by pkgsrc is
4455: taken from the <code class="varname">WRKDIR_BASENAME</code>
4456: variable. By default, its value is
4457: <code class="filename">work</code>. If you want to use the same
4458: pkgsrc tree for building different kinds of binary packages,
4459: you can change the variable according to your needs. Two
4460: other variables handle common cases of setting
4461: <code class="varname">WRKDIR_BASENAME</code> individually. If
4462: <code class="varname">OBJHOSTNAME</code> is defined in
1.10 hubertf 4463: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1 dsieger 4464: the host's name is attached to the directory name. If
4465: <code class="varname">OBJMACHINE</code> is defined, the platform name
4466: is attached, which might look like
4467: <code class="filename">work.i386</code> or
4468: <code class="filename">work.sparc</code>.</p>
4469: </li></ul></div>
4470: <p>Please pay attention to the following gotchas:</p>
1.41 asau 4471: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4472: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1 dsieger 4473: installed in compressed form by the package. For packages using
4474: BSD-style makefiles which honor MANZ, there is
4475: <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23 wiz 4476: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4477: <span class="quote">“<span class="quote">${PREFIX}</span>”</span> in all files (see patches,
1.1 dsieger 4478: below).</p></li>
1.23 wiz 4479: <li class="listitem"><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.1 dsieger 4480: </ul></div>
4481: </div>
1.41 asau 4482: <div class="sect1">
1.1 dsieger 4483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4484: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1 dsieger 4485: </h2></div></div></div>
4486: <p>The <code class="filename">distinfo</code> file contains the message
4487: digest, or checksum, of each distfile needed for the package. This
4488: ensures that the distfiles retrieved from the Internet have not been
4489: corrupted during transfer or altered by a malign force to introduce
4490: a security hole. Due to recent rumor about weaknesses of digest
4491: algorithms, all distfiles are protected using both SHA1 and RMD160
4492: message digests, as well as the file size.</p>
4493: <p>The <code class="filename">distinfo</code> file also contains the
4494: checksums for all the patches found in the
1.10 hubertf 4495: <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, “patches/*”</a>).</p>
1.1 dsieger 4496: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10 hubertf 4497: <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1 dsieger 4498: command.</p>
4499: <p>Some packages have different sets of distfiles depending on
1.23 wiz 4500: the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.1 dsieger 4501: <code class="filename">distinfo</code> file and care should be taken when
4502: upgrading such a package to ensure distfile information is not
4503: lost.</p>
4504: </div>
1.41 asau 4505: <div class="sect1">
1.1 dsieger 4506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4507: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1 dsieger 4508: <p>Many packages still don't work out-of-the box on the various
4509: platforms that are supported by pkgsrc. Therefore, a number of custom
4510: patch files are needed to make the package work. These patch files are
4511: found in the <code class="filename">patches/</code> directory.</p>
4512: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4513: applied to the files in <code class="varname">WRKSRC</code> directory after
1.10 hubertf 4514: 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.24 wiz 4515: order</a>.</p>
1.41 asau 4516: <div class="sect2">
1.1 dsieger 4517: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4518: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1 dsieger 4519: <p>The <code class="filename">patch-*</code> files should be in
1.10 hubertf 4520: <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1 dsieger 4521: problems. (To force patches to apply with fuzz you can set
4522: <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4523: should contain only changes for a single file, and no file should be
4524: patched by more than one patch file. This helps to keep future
4525: modifications simple.</p>
4526: <p>Each patch file is structured as follows: In the first line,
4527: there is the RCS Id of the patch itself. The second line should be
4528: empty for aesthetic reasons. After that, there should be a comment for
4529: each change that the patch does. There are a number of standard
4530: cases:</p>
1.41 asau 4531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 4532: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1 dsieger 4533: mention the vulnerability ID (CAN, CVE).</p></li>
1.23 wiz 4534: <li class="listitem"><p>Patches that change source code should mention the
1.1 dsieger 4535: platform and other environment (for example, the compiler) that the
4536: patch is needed for.</p></li>
4537: </ul></div>
1.24 wiz 4538: <p>In all, the patch should be commented so that any
1.1 dsieger 4539: developer who knows the code of the application can make some use of
4540: the patch. Special care should be taken for the upstream developers,
4541: since we generally want that they accept our patches, so we have less
4542: work in the future.</p>
4543: </div>
1.41 asau 4544: <div class="sect2">
1.1 dsieger 4545: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4546: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1 dsieger 4547: <p>One important thing to mention is to pay attention that no RCS
4548: IDs get stored in the patch files, as these will cause problems when
4549: later checked into the NetBSD CVS tree. Use the
1.10 hubertf 4550: <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.1 dsieger 4551: problems.</p>
4552: <p>For even more automation, we recommend using
1.10 hubertf 4553: <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1 dsieger 4554: whole set of patches. You just have to backup files before you
4555: edit them to <code class="filename">filename.orig</code>, e.g. with
1.10 hubertf 4556: <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4557: using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1 dsieger 4558: you upgrade a package this way, you can easily compare the new
4559: set of patches with the previously existing one with
1.24 wiz 4560: <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4561: are replaced by new files, so carefully check if you want to take all
4562: the changes.</p>
1.1 dsieger 4563: <p>When you have finished a package, remember to generate
1.10 hubertf 4564: the checksums for the patch files by using the <span class="command"><strong>make
1.23 wiz 4565: 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.1 dsieger 4566: <p>When adding a patch that corrects a problem in the
4567: distfile (rather than e.g. enforcing pkgsrc's view of where
4568: man pages should go), send the patch as a bug report to the
4569: maintainer. This benefits non-pkgsrc users of the package,
4570: and usually makes it possible to remove the patch in future
4571: version.</p>
1.2 rillig 4572: <p>The file names of the patch files are usually of the form
1.24 wiz 4573: <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4574: Many packages still use the previous convention
4575: <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4576: but new patches should be of the form containing the filename.
4577: <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
4578: automatically.</p>
1.1 dsieger 4579: </div>
1.41 asau 4580: <div class="sect2">
1.1 dsieger 4581: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4582: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1 dsieger 4583: <p>If you want to share patches between multiple packages
4584: in pkgsrc, e.g. because they use the same distfiles, set
4585: <code class="varname">PATCHDIR</code> to the path where the patch files
4586: can be found, e.g.:</p>
4587: <pre class="programlisting">
4588: PATCHDIR= ${.CURDIR}/../xemacs/patches
4589: </pre>
4590: <p>Patch files that are distributed by the author or other
4591: maintainers can be listed in
4592: <code class="varname">PATCHFILES</code>.</p>
4593: <p>If it is desired to store any patches that should not be
4594: committed into pkgsrc, they can be kept outside the pkgsrc
4595: tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4596: directory tree there is expected to have the same
1.23 wiz 4597: <span class="quote">“<span class="quote">category/package</span>”</span> structure as pkgsrc, and
1.1 dsieger 4598: patches are expected to be stored inside these dirs (also
4599: known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4600: example, if you want to keep a private patch for
4601: <code class="filename">pkgsrc/graphics/png</code>, keep it in
4602: <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4603: files in the named directory are expected to be patch files,
4604: and <span class="emphasis"><em>they are applied after pkgsrc patches are
4605: applied</em></span>.</p>
4606: </div>
1.41 asau 4607: <div class="sect2">
1.1 dsieger 4608: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4609: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1 dsieger 4610: <p>When fixing a portability issue in the code do not use
4611: preprocessor magic to check for the current operating system nor
4612: platform. Doing so hurts portability to other platforms because
4613: the OS-specific details are not abstracted appropriately.</p>
4614: <p>The general rule to follow is: instead of checking for the
4615: operating system the application is being built on, check for the
4616: specific <span class="emphasis"><em>features</em></span> you need. For example,
4617: instead of assuming that kqueue is available under NetBSD and
4618: using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14 jmcneill 4619: kqueue support, add a check that detects kqueue itself —
1.1 dsieger 4620: yes, this generally involves patching the
1.10 hubertf 4621: <span class="command"><strong>configure</strong></span> script. There is absolutely nothing
1.1 dsieger 4622: that prevents some OSes from adopting interfaces from other OSes
4623: (e.g. Linux implementing kqueue), something that the above checks
4624: cannot take into account.</p>
4625: <p>Of course, checking for features generally involves more
4626: work on the developer's side, but the resulting changes are
4627: cleaner and there are chances they will work on many other
4628: platforms. Not to mention that there are higher chances of being
4629: later integrated into the mainstream sources. Remember:
4630: <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4631: <p>Some typical examples:</p>
4632: <div class="table">
1.6 rillig 4633: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1 dsieger 4634: <div class="table-contents"><table summary="Patching examples" border="1">
4635: <colgroup>
4636: <col>
4637: <col>
4638: <col>
4639: </colgroup>
4640: <thead><tr>
4641: <th>Where</th>
4642: <th>Incorrect</th>
4643: <th>Correct</th>
4644: </tr></thead>
4645: <tbody>
4646: <tr>
4647: <td>configure script</td>
4648: <td>
4649: <pre class="programlisting">
4650: case ${target_os} in
4651: netbsd*) have_kvm=yes ;;
4652: *) have_kvm=no ;;
4653: esac
4654: </pre>
4655: </td>
4656: <td>
4657: <pre class="programlisting">
4658: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4659: </pre>
4660: </td>
4661: </tr>
4662: <tr>
4663: <td>C source file</td>
4664: <td>
4665: <pre class="programlisting">
4666: #if defined(__NetBSD__)
4667: # include <sys/event.h>
4668: #endif
4669: </pre>
4670: </td>
4671: <td>
4672: <pre class="programlisting">
4673: #if defined(HAVE_SYS_EVENT_H)
4674: # include <sys/event.h>
4675: #endif
4676: </pre>
4677: </td>
4678: </tr>
4679: <tr>
4680: <td>C source file</td>
4681: <td>
4682: <pre class="programlisting">
4683: int
4684: monitor_file(...)
4685: {
4686: #if defined(__NetBSD__)
4687: int fd = kqueue();
4688: ...
4689: #else
4690: ...
4691: #endif
4692: }
4693: </pre>
4694: </td>
4695: <td>
4696: <pre class="programlisting">
4697: int
4698: monitor_file(...)
4699: {
4700: #if defined(HAVE_KQUEUE)
4701: int fd = kqueue();
4702: ...
4703: #else
4704: ...
4705: #endif
4706: }
4707: </pre>
4708: </td>
4709: </tr>
4710: </tbody>
4711: </table></div>
4712: </div>
4713: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10 hubertf 4714: 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
4715: 1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1 dsieger 4716: 2</a>). It summarizes multiple details on how to make
4717: software easier to package; all the suggestions in it were
4718: collected from our experience in pkgsrc work, so they are possibly
4719: helpful when creating patches too.</p>
4720: </div>
1.41 asau 4721: <div class="sect2">
1.1 dsieger 4722: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4723: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1 dsieger 4724: <p>Always, always, <span class="strong"><strong>always</strong></span>
4725: feed back any <span class="emphasis"><em>portability fixes</em></span> or
4726: improvements you do to a package to the mainstream developers.
4727: This is the only way to get their attention on portability issues
4728: and to ensure that future versions can be built out-of-the box on
4729: NetBSD. Furthermore, any user that gets newer distfiles will get
4730: the fixes straight from the packaged code.</p>
4731: <p>This generally involves cleaning up the patches
4732: (because sometimes the patches that are
1.40 wiz 4733: added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 4734: appropriate trackers for the projects and working with the
4735: mainstream authors to accept your changes. It is
4736: <span class="emphasis"><em>extremely important</em></span> that you do it so that
4737: the packages in pkgsrc are kept simple and thus further changes
4738: can be done without much hassle.</p>
1.24 wiz 4739: <p>When you have done this, please add a URL to the upstream
4740: bug report to the patch comment.</p>
1.1 dsieger 4741: <p>Support the idea of free software!</p>
4742: </div>
4743: </div>
1.41 asau 4744: <div class="sect1">
1.1 dsieger 4745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4746: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41 asau 4747: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4748: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4749: <dd><p>A multi-line description of the piece of software. This should include
4750: any credits where they are due. Please bear in mind that others do not
4751: share your sense of humour (or spelling idiosyncrasies), and that others
4752: will read everything that you write here.</p></dd>
4753: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4754: <dd><p>This file governs the files that are installed on your
4755: system: all the binaries, manual pages, etc. There are other
4756: directives which may be entered in this file, to control the
4757: creation and deletion of directories, and the location of
1.10 hubertf 4758: inserted files. See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1 dsieger 4759: information.</p></dd>
4760: </dl></div>
4761: </div>
1.41 asau 4762: <div class="sect1">
1.1 dsieger 4763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4764: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41 asau 4765: <div class="sect2">
1.1 dsieger 4766: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4767: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41 asau 4768: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4769: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28 wiz 4770: <dd>
1.29 dholland 4771: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1 dsieger 4772: First time after package extraction and before files are
4773: moved in place, the second time after the files to install
4774: are moved in place. This can be used to do any custom
4775: procedures not possible with @exec commands in
1.29 dholland 4776: <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
4777: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><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>.
1.28 wiz 4778: Please note that you can modify variables in it easily by using
4779: <code class="varname">FILES_SUBST</code> in the package's
4780: <code class="filename">Makefile</code>:</p>
4781: <pre class="programlisting">
4782: FILES_SUBST+= SOMEVAR="somevalue"
4783: </pre>
4784: <p>replaces "@SOMEVAR@" with <span class="quote">“<span class="quote">somevalue</span>”</span> in the
4785: <code class="filename">INSTALL</code>. By default, substitution is
4786: performed for <code class="varname">PREFIX</code>,
4787: <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
4788: <code class="varname">VARBASE</code>, and a few others, type
4789: <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
4790: complete list.</p>
4791: </dd>
1.1 dsieger 4792: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4793: <dd><p>This script is executed before and after any files are removed. It is
4794: this script's responsibility to clean up any additional messy details
4795: around the package's installation, since all pkg_delete knows is how to
4796: delete the files created in the original distribution.
1.29 dholland 4797: See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
4798: and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28 wiz 4799: The same methods to replace variables can be used as for
4800: the <code class="filename">INSTALL</code> file.</p></dd>
1.1 dsieger 4801: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4802: <dd>
4803: <p>This file is displayed after installation of the package.
4804: Useful for things like legal notices on almost-free
4805: software and hints for updating config files after
4806: installing modules for apache, PHP etc.
4807: Please note that you can modify variables in it easily by using
4808: <code class="varname">MESSAGE_SUBST</code> in the package's
4809: <code class="filename">Makefile</code>:</p>
4810: <pre class="programlisting">
4811: MESSAGE_SUBST+= SOMEVAR="somevalue"
4812: </pre>
1.23 wiz 4813: <p>replaces "${SOMEVAR}" with <span class="quote">“<span class="quote">somevalue</span>”</span> in
1.1 dsieger 4814: <code class="filename">MESSAGE</code>. By default, substitution is
4815: performed for <code class="varname">PKGNAME</code>,
4816: <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4817: <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4818: <code class="varname">X11BASE</code>,
4819: <code class="varname">PKG_SYSCONFDIR</code>,
4820: <code class="varname">ROOT_GROUP</code>, and
1.16 jnemeth 4821: <code class="varname">ROOT_USER</code>.</p>
1.1 dsieger 4822: <p>You can display a different or additional files by
4823: setting the <code class="varname">MESSAGE_SRC</code> variable. Its
4824: default is <code class="filename">MESSAGE</code>, if the file
4825: exists.</p>
4826: </dd>
4827: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4828: <dd><p>FIXME: There is no documentation on the
4829: alternatives framework.</p></dd>
4830: </dl></div>
4831: </div>
1.41 asau 4832: <div class="sect2">
1.1 dsieger 4833: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4834: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41 asau 4835: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4836: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4837: <dd><p>This file contains arbitrary things that could
4838: also go into a <code class="filename">Makefile</code>, but its purpose is
4839: to be used by more than one package. This file should only be
4840: used when the packages that will use the file are known in
4841: advance. For other purposes it is often better to write a
4842: <code class="filename">*.mk</code> file and give it a good name that
4843: describes what it does.</p></dd>
4844: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4845: <dd><p>This file contains the dependency information
1.10 hubertf 4846: 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.1 dsieger 4847: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4848: <dd><p>This file contains workarounds for compiler bugs
4849: and similar things. It is included automatically by the pkgsrc
4850: infrastructure, so you don't need an extra
4851: <code class="literal">.include</code> line for
4852: it.</p></dd>
4853: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4854: <dd><p>This file contains the code for the
1.10 hubertf 4855: 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.1 dsieger 4856: selected by the user. If a package has only one or two options,
4857: it is equally acceptable to put the code directly into the
4858: <code class="filename">Makefile</code>.</p></dd>
4859: </dl></div>
4860: </div>
1.41 asau 4861: <div class="sect2">
1.1 dsieger 4862: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 4863: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41 asau 4864: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 4865: <dt><span class="term"><code class="filename">README*</code></span></dt>
4866: <dd><p>These files do not take place in the creation of
4867: a package and thus are purely informative to the package
4868: developer.</p></dd>
4869: <dt><span class="term"><code class="filename">TODO</code></span></dt>
4870: <dd><p>This file contains things that need to be done
4871: to make the package even
4872: better.</p></dd>
4873: </dl></div>
4874: </div>
4875: </div>
1.41 asau 4876: <div class="sect1">
1.1 dsieger 4877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4878: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1 dsieger 4879: </h2></div></div></div>
1.10 hubertf 4880: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1 dsieger 4881: unpacked into the directory denoted by
4882: <code class="varname">WRKDIR</code>. It can be removed by running
1.10 hubertf 4883: <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1 dsieger 4884: directory is also used to keep various timestamp files.
4885: The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4886: The default is <code class="filename">${.CURDIR}/work</code>
4887: or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4888: if <code class="varname">OBJMACHINE</code> is set.</p>
4889: </div>
1.41 asau 4890: <div class="sect1">
1.1 dsieger 4891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4892: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1 dsieger 4893: </h2></div></div></div>
4894: <p>If you have any files that you wish to be placed in the package prior
4895: to configuration or building, you could place these files here and use
1.10 hubertf 4896: a <span class="command"><strong>${CP}</strong></span> command in the
1.23 wiz 4897: <span class="quote">“<span class="quote">pre-configure</span>”</span> target to achieve
1.1 dsieger 4898: this. Alternatively, you could simply diff the file against
4899: <code class="filename">/dev/null</code> and use the patch mechanism to manage
4900: the creation of this file.</p>
4901: <p>If you want to share files in this way with other
4902: packages, set the <code class="varname">FILESDIR</code> variable to point
4903: to the other package's <code class="filename">files</code> directory,
4904: e.g.:</p>
4905: <pre class="programlisting">
4906: FILESDIR=${.CURDIR}/../xemacs/files
4907: </pre>
4908: </div>
4909: </div>
1.41 asau 4910: <div class="chapter">
1.1 dsieger 4911: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 4912: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1 dsieger 4913: <div class="toc">
4914: <p><b>Table of Contents</b></p>
4915: <dl>
1.6 rillig 4916: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23 wiz 4917: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6 rillig 4918: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4919: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4920: <dd><dl>
4921: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4922: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4923: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4924: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4925: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1 dsieger 4926: </dl></dd>
4927: </dl>
4928: </div>
4929: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4930: each of which forms a well-defined part of the pkgsrc system. Using
1.29 dholland 4931: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1 dsieger 4932: like pkgsrc requires some discipline to keep the code correct and
4933: understandable.</p>
4934: <p>The basic ingredients for <code class="filename">Makefile</code>
4935: programming are variables (which are actually macros) and shell
4936: commands. Among these shell commands may even be more complex ones
1.29 dholland 4937: like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1 dsieger 4938: as intended it is necessary to quote all variables correctly when they
4939: are used.</p>
4940: <p>This chapter describes some patterns, that appear quite often in
4941: <code class="filename">Makefile</code>s, including the pitfalls that come along
4942: with them.</p>
1.41 asau 4943: <div class="sect1">
1.1 dsieger 4944: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4945: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41 asau 4946: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1 dsieger 4947: <p>When you are creating a file as a
4948: target of a rule, always write the data to a temporary file first
4949: and finally rename that file. Otherwise there might occur an error
4950: in the middle of generating the file, and when the user runs
1.29 dholland 4951: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1 dsieger 4952: regenerated properly. Example:</p>
4953: <pre class="programlisting">
4954: wrong:
4955: @echo "line 1" > ${.TARGET}
4956: @echo "line 2" >> ${.TARGET}
4957: @false
4958:
4959: correct:
4960: @echo "line 1" > ${.TARGET}.tmp
4961: @echo "line 2" >> ${.TARGET}.tmp
4962: @false
4963: @mv ${.TARGET}.tmp ${.TARGET}
4964: </pre>
1.10 hubertf 4965: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1 dsieger 4966: <code class="filename">wrong</code> will exist, although there was an error
1.10 hubertf 4967: message in the first run. On the other hand, running <span class="command"><strong>make
1.1 dsieger 4968: correct</strong></span> gives an error message twice, as expected.</p>
1.29 dholland 4969: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1 dsieger 4970: <code class="literal">${.TARGET}</code> in case of error, but this only
4971: happens when it is interrupted, for example by pressing
4972: <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.29 dholland 4973: when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1 dsieger 4974: </li></ul></div>
4975: </div>
1.41 asau 4976: <div class="sect1">
1.1 dsieger 4977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 4978: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1 dsieger 4979: <p><code class="filename">Makefile</code> variables contain strings that
4980: can be processed using the five operators ``='', ``+='', ``?='',
1.29 dholland 4981: ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1 dsieger 4982: page.</p>
4983: <p>When a variable's value is parsed from a
4984: <code class="filename">Makefile</code>, the hash character ``#'' and the
4985: backslash character ``\'' are handled specially. If a backslash is
4986: followed by a newline, any whitespace immediately in front of the
4987: backslash, the backslash, the newline, and any whitespace
4988: immediately behind the newline are replaced with a single space. A
4989: backslash character and an immediately following hash character are
4990: replaced with a single hash character. Otherwise, the backslash is
4991: passed as is. In a variable assignment, any hash character that is
4992: not preceded by a backslash starts a comment that continues upto the
4993: end of the logical line.</p>
4994: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4995: the only way to create a variable consisting of a single backslash
4996: is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4997: <p>So far for defining variables. The other thing you can do with
4998: variables is evaluating them. A variable is evaluated when it is
4999: part of the right side of the ``:='' or the ``!='' operator, or
5000: directly before executing a shell command which the variable is part
1.29 dholland 5001: of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.1 dsieger 5002: is, variables are not evaluated until there's no other way. The
5003: ``modifiers'' mentioned in the man page also evaluate the
5004: variable.</p>
5005: <p>Some of the modifiers split the string into words and then
5006: operate on the words, others operate on the string as a whole. When
5007: a string is split into words, it is split as you would expect
1.29 dholland 5008: it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.14 jmcneill 5009: <p>No rule without exception—the <span class="command"><strong>.for</strong></span>
1.1 dsieger 5010: loop does not follow the shell quoting rules but splits at sequences
5011: of whitespace.</p>
5012: <p>There are several types of variables that should be handled
5013: differently. Strings and two types of lists.</p>
1.41 asau 5014: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5015: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1 dsieger 5016: characters. Nevertheless, you should restrict yourself to only
5017: using printable characters. Examples are
5018: <code class="varname">PREFIX</code> and
5019: <code class="varname">COMMENT</code>.</p></li>
1.23 wiz 5020: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1 dsieger 5021: are never exported to any shell command. Their elements are
5022: separated by whitespace. Therefore, the elements themselves cannot
5023: have embedded whitespace. Any other characters are allowed.
1.10 hubertf 5024: Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1 dsieger 5025: Examples are <code class="varname">DEPENDS</code> and
5026: <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23 wiz 5027: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1 dsieger 5028: may be exported to a shell command. Their elements can contain any
5029: characters, including whitespace. That's why they cannot be used
1.10 hubertf 5030: in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1 dsieger 5031: <code class="varname">DISTFILES</code> and
5032: <code class="varname">MASTER_SITES</code>.</p></li>
5033: </ul></div>
1.41 asau 5034: <div class="sect2">
1.1 dsieger 5035: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5036: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41 asau 5037: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5038: <li class="listitem"><p>All variable names starting with an underscore
1.1 dsieger 5039: are reserved for use by the pkgsrc infrastructure. They shall
5040: not be used by package
5041: <code class="filename">Makefile</code>s.</p></li>
1.23 wiz 5042: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1 dsieger 5043: lowercase variable names for the iteration
5044: variables.</p></li>
1.23 wiz 5045: <li class="listitem"><p>All list variables should have a ``plural''
1.1 dsieger 5046: name, e.g. <code class="varname">PKG_OPTIONS</code> or
5047: <code class="varname">DISTFILES</code>.</p></li>
5048: </ul></div>
5049: </div>
5050: </div>
1.41 asau 5051: <div class="sect1">
1.1 dsieger 5052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5053: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1 dsieger 5054: <p>This section presents you with some code snippets you should
5055: use in your own code. If you don't find anything appropriate here,
5056: you should test your code and add it here.</p>
1.41 asau 5057: <div class="sect2">
1.1 dsieger 5058: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5059: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1 dsieger 5060: <pre class="programlisting">
5061: STRING= foo * bar `date`
5062: INT_LIST= # empty
5063: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
5064: EXT_LIST= # empty
5065: ANOTHER_EXT_LIST= a=b c=d
5066:
5067: INT_LIST+= ${STRING} # 1
5068: INT_LIST+= ${ANOTHER_INT_LIST} # 2
5069: EXT_LIST+= ${STRING:Q} # 3
5070: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
5071: </pre>
5072: <p>When you add a string to an external list (example 3), it
5073: must be quoted. In all other cases, you must not add a quoting
5074: level. You must not merge internal and external lists, unless you
5075: are sure that all entries are correctly interpreted in both
5076: lists.</p>
5077: </div>
1.41 asau 5078: <div class="sect2">
1.1 dsieger 5079: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5080: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1 dsieger 5081: <pre class="programlisting">
5082: EXT_LIST= # empty
5083: .for i in ${INT_LIST}
5084: EXT_LIST+= ${i:Q}""
5085: .endfor
5086: </pre>
5087: <p>This code converts the internal list
5088: <code class="varname">INT_LIST</code> into the external list
5089: <code class="varname">EXT_LIST</code>. As the elements of an internal list
5090: are unquoted they must be quoted here. The reason for appending
5091: <code class="varname">""</code> is explained below.</p>
5092: </div>
1.41 asau 5093: <div class="sect2">
1.1 dsieger 5094: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5095: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1 dsieger 5096: <p>Sometimes you may want to print an arbitrary string. There
5097: are many ways to get it wrong and only few that can handle every
5098: nastiness.</p>
5099: <pre class="programlisting">
5100: STRING= foo bar < > * `date` $$HOME ' "
5101: EXT_LIST= string=${STRING:Q} x=second\ item
5102:
5103: all:
5104: echo ${STRING} # 1
5105: echo "${STRING}" # 2
5106: echo "${STRING:Q}" # 3
5107: echo ${STRING:Q} # 4
5108: echo x${STRING:Q} | sed 1s,.,, # 5
5109: printf "%s\\n" ${STRING:Q}"" # 6
5110: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
5111: </pre>
5112: <p>Example 1 leads to a syntax error in the shell, as the
5113: characters are just copied.</p>
5114: <p>Example 2 leads to a syntax error too, and if you leave out
5115: the last " character from <code class="varname">${STRING}</code>,
1.29 dholland 5116: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.1 dsieger 5117: variable would be evaluated, too.</p>
5118: <p>Example 3 outputs each space character preceded by a
5119: backslash (or not), depending on the implementation of the
1.29 dholland 5120: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.1 dsieger 5121: <p>Example 4 handles correctly every string that does not start
5122: with a dash. In that case, the result depends on the
1.29 dholland 5123: implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.1 dsieger 5124: guarantee that your input does not start with a dash, this form is
5125: appropriate.</p>
5126: <p>Example 5 handles even the case of a leading dash
5127: correctly.</p>
5128: <p>Example 6 also works with every string and is the
5129: light-weight solution, since it does not involve a pipe, which has
5130: its own problems.</p>
5131: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5132: because the quoting has already been done when adding elements to
5133: the list.</p>
5134: <p>As internal lists shall not be passed to the shell, there is
5135: no example for it.</p>
5136: </div>
1.41 asau 5137: <div class="sect2">
1.1 dsieger 5138: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5139: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1 dsieger 5140: <p>There are many possible sources of wrongly quoted variables.
5141: This section lists some of the commonly known ones.</p>
1.41 asau 5142: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5143: <li class="listitem">
1.1 dsieger 5144: <p>Whenever you use the value of a list, think
5145: about what happens to leading or trailing whitespace. If the
5146: list is a well-formed shell expression, you can apply the
5147: <code class="varname">:M*</code> modifier to strip leading and trailing
5148: whitespace from each word. The <code class="varname">:M</code> operator
5149: first splits its argument according to the rules of the shell,
5150: and then creates a new list consisting of all words that match
5151: the shell glob expression <code class="varname">*</code>, that is: all.
5152: One class of situations where this is needed is when adding a
5153: variable like <code class="varname">CPPFLAGS</code> to
5154: <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5155: invokes other configure scripts, it strips the leading and
5156: trailing whitespace from the variable and then passes it to the
5157: other configure scripts. But these configure scripts expect the
5158: (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5159: the parent <code class="varname">CPPFLAGS</code>. That's why we better
5160: pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5161: here is how we do it:</p>
5162: <pre class="programlisting">
5163: CPPFLAGS= # empty
5164: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
5165: CPPFLAGS+= ${MY_CPPFLAGS}
5166:
5167: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
5168:
5169: all:
5170: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
5171: echo x${CONFIGURE_ARGS}x # properly trimmed
5172: </pre>
5173: </li>
1.23 wiz 5174: <li class="listitem"><p>The example above contains one bug: The
1.1 dsieger 5175: <code class="varname">${PREFIX}</code> is a properly quoted shell
5176: expression, but there is the C compiler after it, which also
5177: expects a properly quoted string (this time in C syntax). The
5178: version above is therefore only correct if
5179: <code class="varname">${PREFIX}</code> does not have embedded backslashes
5180: or double quotes. If you want to allow these, you have to add
5181: another layer of quoting to each variable that is used as a C
5182: string literal. You cannot use the <code class="varname">:Q</code>
5183: operator for it, as this operator only works for the
5184: shell.</p></li>
1.23 wiz 5185: <li class="listitem">
1.1 dsieger 5186: <p>Whenever a variable can be empty, the
5187: <code class="varname">:Q</code> operator can have surprising results. Here
5188: are two completely different cases which can be solved with the
5189: same trick.</p>
5190: <pre class="programlisting">
5191: EMPTY= # empty
5192: empty_test:
5193: for i in a ${EMPTY:Q} c; do \
5194: echo "$$i"; \
5195: done
5196:
5197: for_test:
5198: .for i in a:\ a:\test.txt
5199: echo ${i:Q}
5200: echo "foo"
5201: .endfor
5202: </pre>
5203: <p>The first example will only print two of the three lines
5204: we might have expected. This is because
5205: <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5206: the shell cannot see. The workaround is to write
5207: <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5208: as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5209: -f ${FNAME:Q}</code> (both of these are wrong).</p>
5210: <p>The second example will only print three lines instead of
5211: four. The first line looks like <code class="varname">a:\ echo foo</code>.
5212: This is because the backslash of the value
5213: <code class="varname">a:\</code> is interpreted as a line-continuation by
1.29 dholland 5214: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
5215: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.1 dsieger 5216: <code class="varname">${i:Q}""</code>.</p>
5217: </li>
5218: </ul></div>
5219: </div>
1.41 asau 5220: <div class="sect2">
1.1 dsieger 5221: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5222: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1 dsieger 5223: <p>The pkgsrc bmake program does not handle the following
5224: assignment correctly. In case <code class="varname">_othervar_</code>
5225: contains a ``-'' character, one of the closing braces is included
5226: in <code class="varname">${VAR}</code> after this code executes.</p>
5227: <pre class="programlisting">
5228: VAR:= ${VAR:N${_othervar_:C/-//}}
5229: </pre>
5230: <p>For a more complex code snippet and a workaround, see the
5231: 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
5232: <code class="varname">bug1</code>.</p>
5233: </div>
5234: </div>
5235: </div>
1.41 asau 5236: <div class="chapter">
1.1 dsieger 5237: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5238: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1 dsieger 5239: <div class="toc">
5240: <p><b>Table of Contents</b></p>
5241: <dl>
1.6 rillig 5242: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23 wiz 5243: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5244: <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.6 rillig 5245: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5246: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23 wiz 5247: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.6 rillig 5248: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5249: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1 dsieger 5250: </dl>
5251: </div>
5252: <p>The <code class="filename">PLIST</code> file contains a package's
1.23 wiz 5253: <span class="quote">“<span class="quote">packing list</span>”</span>, i.e. a list of files that belong to
1.1 dsieger 5254: the package (relative to the <code class="filename">${PREFIX}</code>
5255: directory it's been installed in) plus some additional statements
1.29 dholland 5256: - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1 dsieger 5257: This chapter addresses some issues that need attention when
5258: dealing with the <code class="filename">PLIST</code> file (or files, see
5259: below!).</p>
1.41 asau 5260: <div class="sect1">
1.1 dsieger 5261: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5262: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1 dsieger 5263: <p>Be sure to add a RCS ID line as the first thing in any
5264: <code class="filename">PLIST</code> file you write:</p>
5265: <pre class="programlisting">
5266: @comment $NetBSD$
5267: </pre>
5268: </div>
1.41 asau 5269: <div class="sect1">
1.1 dsieger 5270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5271: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10 hubertf 5272: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1 dsieger 5273: to output a PLIST that matches any new files since the package
1.10 hubertf 5274: 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.1 dsieger 5275: more information on this target.</p>
5276: </div>
1.41 asau 5277: <div class="sect1">
1.1 dsieger 5278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10 hubertf 5279: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 5280: </h2></div></div></div>
5281: <p>If you have used any of the *-dirs packages, as explained in
1.10 hubertf 5282: <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
5283: <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1 dsieger 5284: <code class="varname">@comment</code>s instead of real
5285: <code class="varname">@dirrm</code> lines. You can also do this for
5286: specific directories and files, so that the results of that
5287: command are very close to reality. This helps <span class="emphasis"><em>a
5288: lot</em></span> during the update of packages.</p>
5289: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5290: of AWK patterns and actions that are used to filter the output of
5291: print-PLIST. You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5292: scripting you like to it, but be careful with quoting.</p>
5293: <p>For example, to get all files inside the
5294: <code class="filename">libdata/foo</code> directory removed from the
5295: resulting PLIST:</p>
5296: <pre class="programlisting">
5297: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
5298: </pre>
5299: <p>And to get all the <code class="varname">@dirrm</code> lines referring
5300: to a specific (shared) directory converted to
5301: <code class="varname">@comment</code>s:</p>
5302: <pre class="programlisting">
5303: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5304: </pre>
5305: </div>
1.41 asau 5306: <div class="sect1">
1.1 dsieger 5307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5308: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1 dsieger 5309: <p>A number of variables are substituted automatically in
5310: PLISTs when a package is installed on a system. This includes the
5311: following variables:</p>
1.41 asau 5312: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 5313: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5314: <dd>
5315: <p>Some packages like emacs and perl embed information
5316: about which architecture they were built on into the
5317: pathnames where they install their files. To handle this
5318: case, PLIST will be preprocessed before actually used, and
5319: the symbol
1.23 wiz 5320: <span class="quote">“<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>”</span> will be
1.10 hubertf 5321: replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1 dsieger 5322: same is done if the string
5323: <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5324: PLIST somewhere - use this on packages that have GNU
5325: autoconf-created configure scripts.</p>
1.41 asau 5326: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 5327: <h3 class="title">Legacy note</h3>
5328: <p>There used to be a symbol
1.23 wiz 5329: <span class="quote">“<span class="quote"><code class="varname">$ARCH</code></span>”</span> that
1.10 hubertf 5330: was replaced by the output of <span class="command"><strong>uname
1.1 dsieger 5331: -m</strong></span>, but that's no longer supported and has
5332: been removed.</p>
5333: </div>
5334: </dd>
5335: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5336: <dd>
5337: <p>Some packages want to embed the OS name and version
5338: into some paths. To do this, use these variables in the
5339: <code class="filename">PLIST</code>:
5340: </p>
1.41 asau 5341: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5342: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">“<span class="quote"><span class="command"><strong>uname -s</strong></span></span>”</span></p></li>
5343: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">“<span class="quote">solaris</span>”</span>)</p></li>
5344: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">“<span class="quote"><span class="command"><strong>uname -r</strong></span></span>”</span></p></li>
1.1 dsieger 5345: </ul></div>
5346: </dd>
5347: </dl></div>
5348: <p>For a complete list of values which are replaced by
5349: default, please look in <code class="filename">bsd.pkg.mk</code> (and
5350: search for <code class="varname">PLIST_SUBST</code>).</p>
5351: <p>If you want to change other variables not listed above, you
5352: can add variables and their expansions to this variable in the
1.10 hubertf 5353: 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.1 dsieger 5354: <pre class="programlisting">
5355: PLIST_SUBST+= SOMEVAR="somevalue"
5356: </pre>
1.23 wiz 5357: <p>This replaces all occurrences of <span class="quote">“<span class="quote">${SOMEVAR}</span>”</span>
1.1 dsieger 5358: in the <code class="filename">PLIST</code> with
1.23 wiz 5359: <span class="quote">“<span class="quote">somevalue</span>”</span>.</p>
1.18 snj 5360: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
5361: the common case of conditionally including some
5362: <code class="filename">PLIST</code> entries. It can be done by adding
5363: <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
5364: setting the corresponding <code class="varname">PLIST.foo</code> variable
5365: to <code class="literal">yes</code> if the entry should be included.
1.23 wiz 5366: This will substitute <span class="quote">“<span class="quote"><code class="varname">${PLIST.foo}</code></span>”</span>
1.18 snj 5367: in the <code class="filename">PLIST</code> with either
1.23 wiz 5368: <span class="quote">“<span class="quote"><code class="literal">""</code></span>”</span> or
5369: <span class="quote">“<span class="quote"><code class="literal">"@comment "</code></span>”</span>.
1.18 snj 5370: For example, in <code class="filename">Makefile</code>:</p>
5371: <pre class="programlisting">
5372: PLIST_VARS+= foo
5373: .if <em class="replaceable"><code>condition</code></em>
5374: PLIST.foo= yes
5375: .else
5376: </pre>
5377: <p>And then in <code class="filename">PLIST</code>:</p>
5378: <pre class="programlisting">
5379: @comment $NetBSD$
5380: bin/bar
5381: man/man1/bar.1
5382: ${PLIST.foo}bin/foo
5383: ${PLIST.foo}man/man1/foo.1
5384: ${PLIST.foo}share/bar/foo.data
5385: ${PLIST.foo}@dirrm share/bar
5386: </pre>
1.1 dsieger 5387: </div>
1.41 asau 5388: <div class="sect1">
1.1 dsieger 5389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5390: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1 dsieger 5391: <p>Man pages should be installed in compressed form if
5392: <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5393: and uncompressed otherwise. To handle this in the
1.23 wiz 5394: <code class="filename">PLIST</code> file, the suffix <span class="quote">“<span class="quote">.gz</span>”</span> is
1.1 dsieger 5395: appended/removed automatically for man pages according to
5396: <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5397: or not, see above for details. This modification of the
5398: <code class="filename">PLIST</code> file is done on a copy of it, not
5399: <code class="filename">PLIST</code> itself.</p>
5400: </div>
1.41 asau 5401: <div class="sect1">
1.1 dsieger 5402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5403: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1 dsieger 5404: </h2></div></div></div>
5405: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5406: in generating the binary package, set the variable
5407: <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.29 dholland 5408: The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1 dsieger 5409: important. The default for <code class="varname">PLIST_SRC</code> is
5410: <code class="filename">${PKGDIR}/PLIST</code>.</p>
5411: </div>
1.41 asau 5412: <div class="sect1">
1.1 dsieger 5413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5414: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1 dsieger 5415: <p>Some packages decide to install a different set of files based on
5416: the operating system being used. These differences can be
5417: automatically handled by using the following files:</p>
1.41 asau 5418: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5419: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5420: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5421: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5422: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5423: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1 dsieger 5424: </ul></div>
5425: </div>
1.41 asau 5426: <div class="sect1">
1.1 dsieger 5427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5428: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.23 wiz 5429: <p>A <span class="quote">“<span class="quote">shared directory</span>”</span> is a directory where
1.1 dsieger 5430: multiple (and unrelated) packages install files. These
1.22 jakllsch 5431: directories were problematic because you had to add special
5432: tricks in the PLIST to conditionally remove them, or have some
1.1 dsieger 5433: centralized package handle them.</p>
1.22 jakllsch 5434: <p>In pkgsrc, it is now easy: Each package should create
5435: directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5436: will remove any directories left empty after uninstalling a
5437: package.</p>
5438: <p>If a package needs an empty directory to work, create
5439: the directory during installation as usual, and also add an
5440: entry to the PLIST:
5441: </p>
1.1 dsieger 5442: <pre class="programlisting">
1.22 jakllsch 5443: @pkgdir path/to/empty/directory
1.1 dsieger 5444: </pre>
1.22 jakllsch 5445: <p>
5446: </p>
1.1 dsieger 5447: </div>
5448: </div>
1.41 asau 5449: <div class="chapter">
1.1 dsieger 5450: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5451: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1 dsieger 5452: <div class="toc">
5453: <p><b>Table of Contents</b></p>
5454: <dl>
1.6 rillig 5455: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23 wiz 5456: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5457: <dd><dl>
1.6 rillig 5458: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26 wiz 5459: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5460: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5461: and
5462: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5463: in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1 dsieger 5464: </dl></dd>
1.23 wiz 5465: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1 dsieger 5466: <dd><dl>
1.23 wiz 5467: <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>
1.6 rillig 5468: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1 dsieger 5469: </dl></dd>
5470: </dl>
5471: </div>
5472: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5473: are seen by a package's configure and build processes. This is implemented
5474: in a two step process:</p>
1.23 wiz 5475: <div class="orderedlist"><ol class="orderedlist" type="1">
5476: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1 dsieger 5477: <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5478: of <code class="varname">WRKDIR</code>.</p></li>
1.23 wiz 5479: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1 dsieger 5480: tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5481: <code class="option">-L${LOCALBASE}/lib</code> into references to
5482: <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5483: native compiler on some operating systems look like GCC, so that
5484: packages that expect GCC won't require modifications to build with
5485: those native compilers.</p></li>
5486: </ol></div>
5487: <p>This normalizes the environment in which a package is built so that the
5488: package may be built consistently despite what other software may be
5489: installed. Please note that the normal system header and library paths,
5490: e.g. <code class="filename">/usr/include</code>,
5491: <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5492: designed to insulate the package build from non-system-supplied
5493: software.</p>
1.41 asau 5494: <div class="sect1">
1.1 dsieger 5495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5496: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1 dsieger 5497: <p>The process of converting packages to use the buildlink3
1.23 wiz 5498: framework (<span class="quote">“<span class="quote">bl3ifying</span>”</span>) is fairly straightforward.
1.1 dsieger 5499: The things to keep in mind are:</p>
1.23 wiz 5500: <div class="orderedlist"><ol class="orderedlist" type="1">
5501: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1 dsieger 5502: instead of the actual toolchain. Some packages are tricky,
5503: and the only way to know for sure is the check
5504: <code class="filename">${WRKDIR}/.work.log</code> to see if the
5505: wrappers are being invoked.</p></li>
1.23 wiz 5506: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1 dsieger 5507: the package Makefile, e.g. Java VMs, standalone shells,
5508: etc., because the code to symlink files into
5509: <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23 wiz 5510: relative to <span class="quote">“<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>”</span>.
1.1 dsieger 5511: </p></li>
1.23 wiz 5512: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1 dsieger 5513: <code class="filename">buildlink3.mk</code> files that you list in a
5514: package's Makefile are added as dependencies for that package.
5515: </p></li>
5516: </ol></div>
5517: <p>If a dependency on a particular package is required for its libraries and
5518: headers, then we replace:</p>
5519: <pre class="programlisting">
5520: DEPENDS+= foo>=1.1.0:../../category/foo
5521: </pre>
5522: <p>with</p>
5523: <pre class="programlisting">
5524: .include "../../category/foo/buildlink3.mk"
5525: </pre>
5526: <p>The buildlink3.mk files usually define the required dependencies.
5527: If you need a newer version of the dependency when using buildlink3.mk
5528: files, then you can define it in your Makefile; for example:</p>
5529: <pre class="programlisting">
5530: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5531: .include "../../category/foo/buildlink3.mk"
5532: </pre>
5533: <p>There are several <code class="filename">buildlink3.mk</code>
5534: files in <code class="filename">pkgsrc/mk</code>
5535: that handle special package issues:</p>
1.41 asau 5536: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5537: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1 dsieger 5538: the native or a pkgsrc Berkeley DB implementation based on
5539: the values of <code class="varname">BDB_ACCEPTED</code> and
5540: <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23 wiz 5541: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1 dsieger 5542: comes with neither Curses nor NCurses, this will take care
5543: 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.23 wiz 5544: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1 dsieger 5545: of <code class="varname">KRB5_ACCEPTED</code> to choose between
5546: adding a dependency on Heimdal or MIT-krb5 for packages that
5547: require a Kerberos 5 implementation.</p></li>
1.23 wiz 5548: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1 dsieger 5549: system-provided Motif installation or adds a dependency on
1.45 obache 5550: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</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.23 wiz 5551: <code class="varname">MOTIF_TYPE</code> to <span class="quote">“<span class="quote">dt</span>”</span>,
1.45 obache 5552: <span class="quote">“<span class="quote">lesstif</span>”</span>, <span class="quote">“<span class="quote">motif</span>”</span> or
5553: <span class="quote">“<span class="quote">openmotif</span>”</span> to choose
1.1 dsieger 5554: which Motif version will be used.</p></li>
1.55 ryoon 5555: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56 wiz 5556: system-provided GNU readline or editline (libedit) installation,
1.55 ryoon 5557: or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
5558: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
5559: <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
5560: If your package really needs GNU readline library, its Makefile
5561: should include <code class="filename">devel/readline/buildlink3.mk</code>
5562: instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23 wiz 5563: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1 dsieger 5564: variables that may be used by packages that use the
5565: Open Sound System (OSS) API.</p></li>
1.23 wiz 5566: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35 wiz 5567: any of the Postgres versions in the variable
5568: <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
5569: the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1 dsieger 5570: the file for more information.</p></li>
1.23 wiz 5571: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1 dsieger 5572: <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5573: 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.23 wiz 5574: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1 dsieger 5575: <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5576: library.</p></li>
5577: </ul></div>
5578: <p>The comments in those <code class="filename">buildlink3.mk</code>
5579: files provide a more complete
5580: description of how to use them properly.</p>
5581: </div>
1.41 asau 5582: <div class="sect1">
1.1 dsieger 5583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5584: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7 rillig 5585: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1 dsieger 5586: included by Makefiles to indicate the need to compile and link
5587: against header files and libraries provided by the package. A
5588: <code class="filename">buildlink3.mk</code> file should always provide
5589: enough information to add the correct type of dependency
5590: relationship and include any other
5591: <code class="filename">buildlink3.mk</code> files that it needs to find
5592: headers and libraries that it needs in turn.</p>
5593: <p>To generate an initial <code class="filename">buildlink3.mk</code>
5594: 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>
5595: package is highly recommended. For most packages, the following
5596: command will generate a good starting point for
5597: <code class="filename">buildlink3.mk</code> files:</p>
5598: <pre class="screen">
5599: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5600: <code class="prompt">%</code> createbuildlink >buildlink3.mk</code></strong>
5601: </pre>
1.41 asau 5602: <div class="sect2">
1.1 dsieger 5603: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5604: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1 dsieger 5605: <p>The following real-life example
5606: <code class="filename">buildlink3.mk</code> is taken
5607: from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5608: <pre class="programlisting">
1.18 snj 5609: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 5610:
1.18 snj 5611: BUILDLINK_TREE+= tiff
1.1 dsieger 5612:
1.18 snj 5613: .if !defined(TIFF_BUILDLINK3_MK)
5614: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5615:
1.18 snj 5616: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5617: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5618: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5619:
5620: .include "../../devel/zlib/buildlink3.mk"
5621: .include "../../graphics/jpeg/buildlink3.mk"
1.18 snj 5622: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5623:
1.18 snj 5624: BUILDLINK_TREE+= -tiff
1.1 dsieger 5625: </pre>
5626: <p>The header and footer manipulate
1.18 snj 5627: <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1 dsieger 5628: <code class="filename">buildlink3.mk</code> files and is used to track
1.18 snj 5629: the dependency tree.</p>
5630: <p>The main section is protected from multiple inclusion
1.1 dsieger 5631: and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5632: added. Several important variables are set in the section:</p>
1.41 asau 5633: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5634: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5635: is the actual dependency recorded in the installed
5636: package; this should always be set using
1.10 hubertf 5637: <span class="command"><strong>+=</strong></span> to ensure that
1.1 dsieger 5638: we're appending to any pre-existing list of values. This
5639: variable should be set to the first version of the
1.26 wiz 5640: package that had an backwards-incompatible API change.
1.1 dsieger 5641: </p></li>
1.23 wiz 5642: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5643: is the location of the <em class="replaceable"><code>pkg</code></em>
5644: pkgsrc directory.</p></li>
1.23 wiz 5645: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5646: (not shown above) controls whether we use
5647: <code class="varname">BUILD_DEPENDS</code> or
5648: <code class="varname">DEPENDS</code> to add the dependency on
5649: <em class="replaceable"><code>pkg</code></em>. The build dependency is
5650: selected by setting
5651: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5652: to <span class="quote">“<span class="quote">build</span>”</span>. By default, the full dependency is
1.1 dsieger 5653: used.</p></li>
1.23 wiz 5654: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5655: and
5656: <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5657: (not shown above) are lists of subdirectories of
5658: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5659: to add to the header and library search paths. These
1.23 wiz 5660: default to <span class="quote">“<span class="quote">include</span>”</span> and <span class="quote">“<span class="quote">lib</span>”</span>
1.1 dsieger 5661: respectively.</p></li>
1.23 wiz 5662: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5663: (not shown above) is the list of preprocessor flags to add
5664: to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23 wiz 5665: configure and build phases. The <span class="quote">“<span class="quote">-I</span>”</span> option
1.1 dsieger 5666: should be avoided and instead be handled using
5667: <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5668: above.</p></li>
5669: </ul></div>
5670: <p>The following variables are all optionally defined within
5671: this second section (protected against multiple inclusion) and
5672: control which package files are symlinked into
5673: <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5674: transformed during the symlinking:</p>
1.41 asau 5675: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5676: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5677: (not shown above) is a shell glob pattern relative to
5678: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5679: to be symlinked into
5680: <code class="filename">${BUILDLINK_DIR}</code>,
5681: e.g. <code class="filename">include/*.h</code>.</p></li>
1.23 wiz 5682: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5683: (not shown above) is a shell pipeline that
5684: outputs to stdout a list of files relative to
5685: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5686: The resulting files are to be symlinked
5687: into <code class="filename">${BUILDLINK_DIR}</code>. By default,
5688: this takes the <code class="filename">+CONTENTS</code> of a
5689: <em class="replaceable"><code>pkg</code></em> and filters it through
5690: <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23 wiz 5691: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5692: (not shown above) is a filter command that filters
5693: <code class="filename">+CONTENTS</code> input into a list of files
5694: relative to
5695: <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5696: on stdout. By default for overwrite packages,
5697: <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5698: outputs the contents of the <code class="filename">include</code>
5699: and <code class="filename">lib</code> directories in the package
5700: <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5701: it outputs any libtool archives in
5702: <code class="filename">lib</code> directories.</p></li>
1.23 wiz 5703: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1 dsieger 5704: (not shown above) is a list of sed arguments used to
5705: transform the name of the source filename into a
1.10 hubertf 5706: destination filename, e.g. <span class="command"><strong>-e
1.1 dsieger 5707: "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5708: </ul></div>
1.18 snj 5709: <p>This section can additionally include any
1.1 dsieger 5710: <code class="filename">buildlink3.mk</code> needed for
5711: <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5712: Including these <code class="filename">buildlink3.mk</code> files
5713: means that the headers and libraries for these
5714: dependencies are also symlinked into
5715: <code class="filename">${BUILDLINK_DIR}</code>
5716: whenever the <em class="replaceable"><code>pkg</code></em>
5717: <code class="filename">buildlink3.mk</code>
1.18 snj 5718: file is included. Dependencies are only added for directly
5719: include <code class="filename">buildlink3.mk</code> files.</p>
1.47 wiz 5720: <p>When providing a <code class="filename">buildlink3.mk</code> and
5721: including other <code class="filename">buildlink3.mk</code> files in it,
1.50 wiz 5722: please only add necessary ones, i.e., those whose libraries or
1.47 wiz 5723: header files are automatically exposed when the package is
5724: use.</p>
5725: <p>In particular, if only an executable
5726: (<code class="filename">bin/foo</code>) is linked against a library, that
5727: library does not need to be propagated in the
5728: <code class="filename">buildlink3.mk</code> file.</p>
5729: <p>The following steps should help you decide if a
5730: <code class="filename">buildlink3.mk</code> file needs to be included:
5731: </p>
5732: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
5733: <li class="listitem"><p>Look at the installed header files: What
5734: headers do they include? The packages providing these files
5735: must be buildlinked.</p></li>
1.49 wiz 5736: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
5737: libraries and look against what other libraries they link.
5738: Some of the packages providing these probably need to be
5739: buildlinked; however, it's not automatic, since e.g. GTK on
5740: some systems pulls in the X libraries, so they will show up in
5741: the <code class="filename">ldd</code> output, while on others (like OS
1.50 wiz 5742: X) it won't. <code class="filename">ldd</code> output can thus only be
1.49 wiz 5743: used as a hint.</p></li>
1.47 wiz 5744: </ul></div>
5745: <p>
5746: </p>
1.1 dsieger 5747: </div>
1.41 asau 5748: <div class="sect2">
1.1 dsieger 5749: <div class="titlepage"><div><div><h3 class="title">
1.26 wiz 5750: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1 dsieger 5751: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5752: and
5753: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5754: in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5755: <p>These two variables differ in that one describes source
5756: compatibility (API) and the other binary compatibility (ABI).
5757: The difference is that a change in the API breaks compilation of
5758: programs while changes in the ABI stop compiled programs from
5759: running.</p>
5760: <p>Changes to the
1.27 wiz 5761: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26 wiz 5762: variable in a <code class="filename">buildlink3.mk</code> file happen
5763: very rarely. One possible reason is that all packages depending
5764: on this already need a newer version. In case it is bumped see
5765: the description below.</p>
5766: <p>The most common example of an ABI change is that the major
5767: version of a shared library is increased. In this case,
5768: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5769: should be adjusted to require at least the new package version.
5770: Then the packages that depend on this package need their
5771: <code class="varname">PKGREVISION</code>s increased and, if they have
5772: <code class="filename">buildlink3.mk</code> files, their
5773: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5774: adjusted, too. This is needed so pkgsrc will require the correct
5775: package dependency and not settle for an older one when building
5776: the source.</p>
1.10 hubertf 5777: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, “Handling dependencies”</a> for
1.26 wiz 5778: more information about dependencies on other packages,
5779: including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1 dsieger 5780: <code class="varname">ABI_DEPENDS</code> definitions.</p>
5781: <p>Please take careful consideration before adjusting
5782: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5783: or
5784: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5785: as we don't want to cause unneeded package deletions and
5786: rebuilds. In many cases, new versions of packages work just
5787: fine with older dependencies.</p>
5788: <p>Also it is not needed to set
1.26 wiz 5789: <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5790: when it is identical to
1.1 dsieger 5791: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5792: </div>
5793: </div>
1.41 asau 5794: <div class="sect1">
1.1 dsieger 5795: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5796: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1 dsieger 5797: <p>Some packages in pkgsrc install headers and libraries that
5798: coincide with headers and libraries present in the base system.
5799: Aside from a <code class="filename">buildlink3.mk</code> file, these
5800: packages should also include a <code class="filename">builtin.mk</code>
5801: file that includes the necessary checks to decide whether using
5802: the built-in software or the pkgsrc software is
5803: appropriate.</p>
5804: <p>The only requirements of a builtin.mk file for
5805: <em class="replaceable"><code>pkg</code></em> are:</p>
1.23 wiz 5806: <div class="orderedlist"><ol class="orderedlist" type="1">
5807: <li class="listitem"><p>It should set
1.1 dsieger 5808: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5809: to either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>
1.1 dsieger 5810: after it is included.</p></li>
1.23 wiz 5811: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1 dsieger 5812: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5813: which is already set before the
5814: <code class="filename">builtin.mk</code> file is included.</p></li>
1.23 wiz 5815: <li class="listitem"><p>It should be written to allow multiple inclusion. This
1.1 dsieger 5816: is <span class="emphasis"><em>very</em></span> important and takes careful
5817: attention to <code class="filename">Makefile</code> coding.</p></li>
5818: </ol></div>
1.41 asau 5819: <div class="sect2">
1.1 dsieger 5820: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5821: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1 dsieger 5822: <p>The following is the recommended template for builtin.mk
5823: files:</p>
5824: <pre class="programlisting">
5825: .if !defined(IS_BUILTIN.foo)
5826: #
5827: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5828: # genuinely exists in the system or not.
5829: #
5830: IS_BUILTIN.foo?= no
5831:
5832: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5833: # version can be determined.
5834: #
5835: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5836: BUILTIN_PKG.foo?= foo-1.0
5837: . endif
5838: .endif # IS_BUILTIN.foo
5839:
5840: .if !defined(USE_BUILTIN.foo)
5841: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5842: . if defined(BUILTIN_PKG.foo)
5843: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5844: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5845: USE_BUILTIN.foo!= \
5846: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5847: && ${ECHO} "yes" || ${ECHO} "no"
5848: . endif
5849: . endfor
5850: . endif
5851: .endif # USE_BUILTIN.foo
5852:
5853: CHECK_BUILTIN.foo?= no
5854: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5855: #
5856: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5857: # "yes" or "no".
5858: #
5859: .endif # CHECK_BUILTIN.foo
5860: </pre>
5861: <p>The first section sets
5862: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5863: depending on if <em class="replaceable"><code>pkg</code></em> really exists
5864: in the base system. This should not be a base system software
5865: with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23 wiz 5866: it should only be <span class="quote">“<span class="quote">yes</span>”</span> if the actual package is
1.1 dsieger 5867: included as part of the base system. This variable is only
5868: used internally within the <code class="filename">builtin.mk</code>
5869: file.</p>
5870: <p>The second section sets
5871: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5872: to the version of <em class="replaceable"><code>pkg</code></em> in the base
5873: system if it exists (if
5874: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5875: is <span class="quote">“<span class="quote">yes</span>”</span>). This variable is only used internally
1.1 dsieger 5876: within the <code class="filename">builtin.mk</code> file.</p>
5877: <p>The third section sets
5878: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5879: and is <span class="emphasis"><em>required</em></span> in all
5880: <code class="filename">builtin.mk</code> files. The code in this
5881: section must make the determination whether the built-in
5882: software is adequate to satisfy the dependencies listed in
5883: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5884: This is typically done by comparing
5885: <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5886: against each of the dependencies in
5887: <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5888: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5889: <span class="emphasis"><em>must</em></span> be set to the correct value by the
5890: end of the <code class="filename">builtin.mk</code> file. Note that
5891: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5892: may be <span class="quote">“<span class="quote">yes</span>”</span> even if
1.1 dsieger 5893: <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23 wiz 5894: is <span class="quote">“<span class="quote">no</span>”</span> because we may make the determination
1.1 dsieger 5895: that the built-in version of the software is similar enough to
5896: be used as a replacement.</p>
5897: <p>The last section is guarded by
5898: <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5899: and includes code that uses the value of
5900: <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5901: set in the previous section. This typically includes, e.g.,
5902: adding additional dependency restrictions and listing additional
5903: files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5904: <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5905: </div>
1.41 asau 5906: <div class="sect2">
1.1 dsieger 5907: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 5908: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1 dsieger 5909: <p>When building packages, it's possible to choose whether to set
5910: a global preference for using either the built-in (native)
5911: version or the pkgsrc version of software to satisfy a
5912: dependency. This is controlled by setting
5913: <code class="varname">PREFER_PKGSRC</code> and
5914: <code class="varname">PREFER_NATIVE</code>. These variables take values
1.23 wiz 5915: of either <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">no</span>”</span>, or a list of
1.1 dsieger 5916: packages. <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5917: use the pkgsrc versions of software, while
5918: <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5919: built-in versions. Preferences are determined by the most
5920: specific instance of the package in either
5921: <code class="varname">PREFER_PKGSRC</code> or
5922: <code class="varname">PREFER_NATIVE</code>. If a package is specified
5923: in neither or in both variables, then
5924: <code class="varname">PREFER_PKGSRC</code> has precedence over
5925: <code class="varname">PREFER_NATIVE</code>. For example, to require
5926: using pkgsrc versions of software for all but the most basic
5927: bits on a NetBSD system, you can set:</p>
5928: <pre class="programlisting">
5929: PREFER_PKGSRC= yes
5930: PREFER_NATIVE= getopt skey tcp_wrappers
5931: </pre>
5932: <p>A package <span class="emphasis"><em>must</em></span> have a
5933: <code class="filename">builtin.mk</code>
5934: file to be listed in <code class="varname">PREFER_NATIVE</code>,
5935: otherwise it is simply ignored in that list.</p>
5936: </div>
5937: </div>
5938: </div>
1.41 asau 5939: <div class="chapter">
1.1 dsieger 5940: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 5941: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1 dsieger 5942: <div class="toc">
5943: <p><b>Table of Contents</b></p>
5944: <dl>
1.6 rillig 5945: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1 dsieger 5946: <dd><dl>
1.6 rillig 5947: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5948: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1 dsieger 5949: </dl></dd>
1.6 rillig 5950: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1 dsieger 5951: <dd><dl>
1.23 wiz 5952: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.6 rillig 5953: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5954: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5955: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5956: </dl></dd>
5957: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5958: <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>
5959: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5960: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5961: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5962: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5963: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1 dsieger 5964: </dl>
5965: </div>
5966: <p>This chapter describes the framework known as
5967: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41 asau 5968: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 5969: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1 dsieger 5970: outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23 wiz 5971: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1 dsieger 5972: provided that packages are correctly designed.</p></li>
1.23 wiz 5973: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5974: <li class="listitem"><p>Registration of system users and groups.</p></li>
5975: <li class="listitem"><p>Registration of system shells.</p></li>
5976: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1 dsieger 5977: </ul></div>
5978: <p>The following sections inspect each of the above points in detail.</p>
5979: <p>You may be thinking that many of the things described here could be
5980: easily done with simple code in the package's post-installation target
5981: (<code class="literal">post-install</code>). <span class="emphasis"><em>This is incorrect</em></span>,
5982: as the code in them is only executed when building from source. Machines
5983: using binary packages could not benefit from it at all (as the code itself
5984: could be unavailable). Therefore, the only way to achieve any of the items
5985: described above is by means of the installation scripts, which are
5986: automatically generated by pkginstall.</p>
1.41 asau 5987: <div class="sect1">
1.1 dsieger 5988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 5989: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1 dsieger 5990: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5991: of files and directories that belong to a package. The names used in it
5992: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5993: which means that it cannot register files outside this directory (absolute
5994: path names are not allowed). Despite this restriction, some packages need
5995: to install files outside this location; e.g., under
5996: <code class="filename">${VARBASE}</code> or
5997: <code class="filename">${PKG_SYSCONFDIR}</code>. The only way to achieve this
5998: is to create such files during installation time by using
5999: installation scripts.</p>
6000: <p>The generic installation scripts are shell scripts that can
6001: contain arbitrary code. The list of scripts to execute is taken from
6002: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
6003: <code class="filename">INSTALL</code>. A similar variable exists for package
6004: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
6005: <code class="filename">DEINSTALL</code>). These scripts can run arbitrary
6006: commands, so they have the potential to create and manage files
6007: anywhere in the file system.</p>
6008: <p>Using these general installation files is not recommended, but
6009: may be needed in some special cases. One reason for avoiding them is
6010: that the user has to trust the packager that there is no unwanted or
6011: simply erroneous code included in the installation script. Also,
6012: previously there were many similar scripts for the same functionality,
6013: and fixing a common error involved finding and changing all of
6014: them.</p>
6015: <p>The pkginstall framework offers another, standardized way. It
6016: provides generic scripts to abstract the manipulation of such files
6017: and directories based on variables set in the package's
6018: <code class="filename">Makefile</code>. The rest of this section describes
6019: these variables.</p>
1.41 asau 6020: <div class="sect2">
1.1 dsieger 6021: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6022: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1 dsieger 6023: <p>The following variables can be set to request the creation of
6024: directories anywhere in the file system:</p>
1.41 asau 6025: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6026: <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1 dsieger 6027: contain a list of directories that should be created and should attempt
6028: to be destroyed by the installation scripts. The difference between
6029: the two is that the latter prompts the administrator to remove any
6030: directories that may be left after deinstallation (because they were
6031: not empty), while the former does not.</p></li>
1.23 wiz 6032: <li class="listitem">
1.1 dsieger 6033: <p><code class="varname">MAKE_DIRS_PERMS</code> and
6034: <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
6035: which directories should be created and should attempt to be destroyed
6036: by the installation scripts. Each tuple holds the following values,
6037: separated by spaces: the directory name, its owner, its group and its
6038: numerical mode. For example:</p>
6039: <pre class="programlisting">
6040: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
6041: </pre>
6042: <p>The difference between the two is exactly the same as their
6043: non-<code class="varname">PERMS</code> counterparts.</p>
6044: </li>
6045: </ul></div>
6046: </div>
1.41 asau 6047: <div class="sect2">
1.1 dsieger 6048: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6049: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1 dsieger 6050: <p>Creating non-empty files outside the installation prefix is tricky
6051: because the <code class="filename">PLIST</code> forces all files to be inside it.
6052: To overcome this problem, the only solution is to extract the file in the
6053: known place (i.e., inside the installation prefix) and copy it to the
6054: appropriate location during installation (done by the installation scripts
6055: generated by pkginstall). We will call the former the <span class="emphasis"><em>master
6056: file</em></span> in the following paragraphs, which describe the variables
6057: that can be used to automatically and consistently handle files outside the
6058: installation prefix:</p>
1.41 asau 6059: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6060: <li class="listitem">
1.1 dsieger 6061: <p><code class="varname">CONF_FILES</code> and
1.30 wiz 6062: <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1 dsieger 6063: During installation time, the master file is copied to the target one
6064: if and only if the latter does not exist. Upon deinstallation, the
6065: target file is removed provided that it was not modified by the
6066: installation.</p>
6067: <p>The difference between the two is that the latter prompts the
6068: administrator to remove any files that may be left after
6069: deinstallation (because they were not empty), while the former does
6070: not.</p>
6071: </li>
1.23 wiz 6072: <li class="listitem">
1.1 dsieger 6073: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30 wiz 6074: <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1 dsieger 6075: files as well as their target locations. For each of them, it also
6076: specifies their owner, their group and their numeric permissions, in
6077: this order. For example:</p>
6078: <pre class="programlisting">
1.30 wiz 6079: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1 dsieger 6080: </pre>
6081: <p>The difference between the two is exactly the same as their
6082: non-<code class="varname">PERMS</code> counterparts.</p>
6083: </li>
6084: </ul></div>
6085: </div>
6086: </div>
1.41 asau 6087: <div class="sect1">
1.1 dsieger 6088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6089: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1 dsieger 6090: <p>Configuration files are special in the sense that they are installed
6091: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
6092: need special treatment during installation (most of which is automated by
6093: pkginstall). The main concept you must bear in mind is that files marked
6094: as configuration files are automatically copied to the right place (somewhere
6095: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
6096: and only if</em></span> they didn't exist before. Similarly, they will not
6097: be removed if they have local modifications. This ensures that
6098: administrators never lose any custom changes they may have made.</p>
1.41 asau 6099: <div class="sect2">
1.1 dsieger 6100: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6101: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1 dsieger 6102: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
6103: specifies where configuration files shall be installed. Its contents are
6104: set based upon the following variables:</p>
1.41 asau 6105: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6106: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1 dsieger 6107: directory. Defaults to <code class="filename">${PREFIX}/etc</code> although it may
6108: be overridden by the user to point to his preferred location (e.g.,
6109: <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
6110: Packages must not use it directly.</p></li>
1.23 wiz 6111: <li class="listitem">
1.1 dsieger 6112: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
6113: <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
6114: for the package being built shall be installed. The definition of this
6115: variable only makes sense in the package's
6116: <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
6117: <p>As an example, consider the Apache package,
6118: <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
6119: configuration files under the
6120: <code class="filename">httpd/</code> subdirectory of
6121: <code class="varname">PKG_SYSCONFBASE</code>. This should be set in the package
6122: Makefile.</p>
6123: </li>
1.23 wiz 6124: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1 dsieger 6125: variable that holds this package's configuration directory (if
6126: different from <code class="varname">PKG_SYSCONFBASE</code>). It defaults to
6127: <code class="varname">PKGBASE</code>'s value, and is always prefixed with
6128: <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23 wiz 6129: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1 dsieger 6130: directory where the configuration files for the package identified by
6131: <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
6132: </ul></div>
6133: <p>Based on the above variables, pkginstall determines the value of
6134: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
6135: variable that can be used within a package to refer to its configuration
6136: directory. The algorithm used to set its value is basically the
6137: following:</p>
1.23 wiz 6138: <div class="orderedlist"><ol class="orderedlist" type="1">
6139: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1 dsieger 6140: its value is used.</p></li>
1.23 wiz 6141: <li class="listitem"><p>If the previous variable is not defined but
1.1 dsieger 6142: <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
6143: <code class="filename">Makefile</code>, the resulting value is
6144: <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23 wiz 6145: <li class="listitem"><p>Otherwise, it is set to
1.1 dsieger 6146: <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
6147: </ol></div>
6148: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16 jnemeth 6149: 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. This does not apply to
6150: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
6151: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1 dsieger 6152: </div>
1.41 asau 6153: <div class="sect2">
1.1 dsieger 6154: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6155: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1 dsieger 6156: <p>Given that pkgsrc (and users!) expect configuration files to be in a
6157: known place, you need to teach each package where it shall install its
6158: files. In some cases you will have to patch the package Makefiles to
6159: achieve it. If you are lucky, though, it may be as easy as passing an
6160: extra flag to the configuration script; this is the case of GNU Autoconf-
6161: generated files:</p>
6162: <pre class="programlisting">
6163: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
6164: </pre>
6165: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6166: for</em></span> its configuration files, not where they will be originally
6167: installed (although the difference is never explicit,
6168: unfortunately).</p>
6169: </div>
1.41 asau 6170: <div class="sect2">
1.1 dsieger 6171: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6172: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1 dsieger 6173: <p>As said before, pkginstall automatically handles configuration files.
6174: This means that <span class="strong"><strong>the packages themselves must not
6175: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6176: directly</strong></span>. Bad news is that many software installation scripts
6177: will, out of the box, mess with the contents of that directory. So what is
6178: the correct procedure to fix this issue?</p>
6179: <p>You must teach the package (usually by manually patching it) to
6180: install any configuration files under the examples hierarchy,
6181: <code class="filename">share/examples/${PKGBASE}/</code>. This way, the
6182: <code class="filename">PLIST</code> registers them and the administrator always
6183: has the original copies available.</p>
6184: <p>Once the required configuration files are in place (i.e., under the
6185: examples hierarchy), the pkginstall framework can use them as master copies
6186: during the package installation to update what is in
6187: <code class="filename">${PKG_SYSCONFDIR}</code>. To achieve this, the variables
6188: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10 hubertf 6189: 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.1 dsieger 6190: about their syntax and their purpose. Here is an example, taken from the
6191: <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>
6192: <pre class="programlisting">
6193: EGDIR= ${PREFIX}/share/doc/mutt/samples
6194: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6195: </pre>
6196: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6197: package and has no meaning outside it.</p>
6198: </div>
1.41 asau 6199: <div class="sect2">
1.1 dsieger 6200: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6201: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1 dsieger 6202: <p>The automatic copying of config files can be toggled by setting the
6203: environment variable <code class="varname">PKG_CONFIG</code> prior to package
6204: installation.</p>
6205: </div>
6206: </div>
1.41 asau 6207: <div class="sect1">
1.1 dsieger 6208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6209: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1 dsieger 6210: <p>System startup scripts are special files because they must be
6211: installed in a place known by the underlying OS, usually outside the
1.10 hubertf 6212: 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.1 dsieger 6213: can be used. However, pkginstall provides a special mechanism to handle
6214: these files.</p>
6215: <p>In order to provide system startup scripts, the package has
6216: to:</p>
1.23 wiz 6217: <div class="orderedlist"><ol class="orderedlist" type="1">
6218: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1 dsieger 6219: the <code class="literal">.sh</code> suffix appended. Considering the
6220: <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
6221: <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23 wiz 6222: <li class="listitem">
1.1 dsieger 6223: <p>Tell pkginstall to handle it, appending the name of the script,
6224: without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6225: Continuing the previous example:</p>
6226: <pre class="programlisting">
6227: RCD_SCRIPTS+= cupsd
6228: </pre>
6229: </li>
6230: </ol></div>
6231: <p>Once this is done, pkginstall will do the following steps for each
6232: script in an automated fashion:</p>
1.23 wiz 6233: <div class="orderedlist"><ol class="orderedlist" type="1">
6234: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1 dsieger 6235: substitutions described in the <code class="filename">FILES_SUBST</code>
6236: variable.</p></li>
1.23 wiz 6237: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1 dsieger 6238: hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>. Note
6239: that this master file must be explicitly registered in the
6240: <code class="filename">PLIST</code>.</p></li>
1.23 wiz 6241: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1 dsieger 6242: from the examples hierarchy into the system-wide startup scripts
6243: directory.</p></li>
6244: </ol></div>
1.41 asau 6245: <div class="sect2">
1.1 dsieger 6246: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6247: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1 dsieger 6248: <p>The automatic copying of config files can be toggled by setting the
6249: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6250: installation. Note that the scripts will be always copied inside the
6251: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6252: matter what the value of this variable is.</p>
6253: </div>
6254: </div>
1.41 asau 6255: <div class="sect1">
1.1 dsieger 6256: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6257: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1 dsieger 6258: <p>If a package needs to create special users and/or groups during
6259: installation, it can do so by using the pkginstall framework.</p>
6260: <p>Users can be created by adding entries to the
6261: <code class="varname">PKG_USERS</code> variable. Each entry has the following
6262: syntax:</p>
6263: <pre class="programlisting">
6264: user:group
6265: </pre>
6266: <p>Further specification of user details may be done by setting
6267: per-user variables.
6268: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6269: numeric UID for the user.
6270: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6271: user's description or comment.
6272: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6273: user's home directory, and defaults to
6274: <code class="filename">/nonexistent</code> if not specified.
6275: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6276: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6277: not specified.</p>
6278: <p>Similarly, groups can be created by adding entries to the
6279: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6280: <pre class="programlisting">
6281: group
6282: </pre>
6283: <p>The numeric GID of the group may be set by defining
6284: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6285: <p>If a package needs to create the users and groups at an earlier
6286: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6287: either <code class="literal">configure</code> or <code class="literal">build</code> to
6288: indicate the phase before which the users and groups are created. In
6289: this case, the numeric UIDs and GIDs of the created users and groups
6290: are automatically hardcoded into the final installation scripts.</p>
6291: </div>
1.41 asau 6292: <div class="sect1">
1.1 dsieger 6293: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6294: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1 dsieger 6295: <p>Packages that install system shells should register them in the shell
6296: database, <code class="filename">/etc/shells</code>, to make things easier to the
6297: administrator. This must be done from the installation scripts to keep
6298: binary packages working on any system. pkginstall provides an easy way to
6299: accomplish this task.</p>
6300: <p>When a package provides a shell interpreter, it has to set the
6301: <code class="varname">PKG_SHELL</code> variable to its absolute file name. This will
6302: add some hooks to the installation scripts to handle it. Consider the
6303: 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>
6304: <pre class="programlisting">
6305: PKG_SHELL= ${PREFIX}/bin/zsh
6306: </pre>
1.41 asau 6307: <div class="sect2">
1.1 dsieger 6308: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6309: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1 dsieger 6310: <p>The automatic registration of shell interpreters can be disabled by
6311: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6312: environment variable to <code class="literal">NO</code>.</p>
6313: </div>
6314: </div>
1.41 asau 6315: <div class="sect1">
1.1 dsieger 6316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6317: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1 dsieger 6318: <p>Packages that install X11 fonts should update the database files
6319: that index the fonts within each fonts directory. This can easily be
6320: accomplished within the pkginstall framework.</p>
6321: <p>When a package installs X11 fonts, it must list the directories in
6322: which fonts are installed in the
6323: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23 wiz 6324: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">“<span class="quote">ttf</span>”</span>,
6325: <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>. This will add hooks to the
1.1 dsieger 6326: installation scripts to run the appropriate commands to update the fonts
6327: database files within each of those directories. For convenience, if the
6328: directory path is relative, it is taken to be relative to the package's
6329: 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>
6330: <pre class="programlisting">
6331: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6332: </pre>
1.41 asau 6333: <div class="sect2">
1.1 dsieger 6334: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6335: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1 dsieger 6336: <p>The automatic update of fonts databases can be disabled by
6337: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6338: environment variable to <code class="literal">NO</code>.</p>
6339: </div>
6340: </div>
6341: </div>
1.41 asau 6342: <div class="chapter">
1.1 dsieger 6343: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6344: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1 dsieger 6345: <div class="toc">
6346: <p><b>Table of Contents</b></p>
6347: <dl>
1.6 rillig 6348: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23 wiz 6349: <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>
1.6 rillig 6350: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7 rillig 6351: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1 dsieger 6352: </dl>
6353: </div>
6354: <p>Many packages have the ability to be built to support different
6355: sets of features. <code class="filename">bsd.options.mk</code> is a framework
6356: in pkgsrc that provides generic handling of those options that
6357: determine different ways in which the packages can be built. It's
6358: possible for the user to specify exactly which sets of options will be
6359: built into a package or to allow a set of global default options
6360: apply.</p>
1.7 rillig 6361: <p>There are two broad classes of behaviors that one might want to
6362: control via options. One is whether some particular feature is
6363: enabled in a program that will be built anyway, often by including or
6364: not including a dependency on some other package. The other is
6365: whether or not an additional program will be built as part of the
6366: package. Generally, it is better to make a split package for such
6367: additional programs instead of using options, because it enables
6368: binary packages to be built which can then be added separately. For
6369: example, the foo package might have minimal dependencies (those
6370: packages without which foo doesn't make sense), and then the foo-gfoo
6371: package might include the GTK frontend program gfoo. This is better
6372: than including a gtk option to foo that adds gfoo, because either that
6373: option is default, in which case binary users can't get foo without
6374: gfoo, or not default, in which case they can't get gfoo. With split
6375: packages, they can install foo without having GTK, and later decide to
6376: install gfoo (pulling in GTK at that time). This is an advantage to
6377: source users too, avoiding the need for rebuilds.</p>
6378: <p>Plugins with widely varying dependencies should usually be split
6379: instead of options.</p>
6380: <p>It is often more work to maintain split packages, especially if
6381: the upstream package does not support this. The decision of split
6382: vs. option should be made based on the likelihood that users will want
6383: or object to the various pieces, the size of the dependencies that are
6384: included, and the amount of work.</p>
6385: <p>A further consideration is licensing. Non-free parts, or parts
6386: that depend on non-free dependencies (especially plugins) should
6387: almost always be split if feasible.</p>
1.41 asau 6388: <div class="sect1">
1.1 dsieger 6389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6390: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1 dsieger 6391: <p>Global default options are listed in
6392: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6393: that should be built into every package if that option is supported.
1.10 hubertf 6394: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1 dsieger 6395: </div>
1.41 asau 6396: <div class="sect1">
1.1 dsieger 6397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6398: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1 dsieger 6399: </h2></div></div></div>
6400: <p>The following example shows how
6401: <code class="filename">bsd.options.mk</code> should be used
6402: by the hypothetical ``wibble'' package, either in the package
6403: <code class="filename">Makefile</code>, or in a file,
6404: e.g. <code class="filename">options.mk</code>, that is included by the
6405: main package <code class="filename">Makefile</code>.</p>
6406: <pre class="programlisting">
6407: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
6408: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
6409: PKG_OPTIONS_OPTIONAL_GROUPS= database
6410: PKG_OPTIONS_GROUP.database= mysql pgsql
6411: PKG_SUGGESTED_OPTIONS= wibble-foo
6412: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
6413: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
6414:
6415: .include "../../mk/bsd.prefs.mk"
6416:
6417: # this package was previously named wibble2
6418: .if defined(PKG_OPTIONS.wibble2)
6419: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
6420: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6421: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6422: .endif
6423:
6424: .include "../../mk/bsd.options.mk"
6425:
6426: # Package-specific option-handling
6427:
6428: ###
6429: ### FOO support
6430: ###
6431: .if !empty(PKG_OPTIONS:Mwibble-foo)
6432: CONFIGURE_ARGS+= --enable-foo
6433: .endif
6434:
6435: ###
6436: ### LDAP support
6437: ###
6438: .if !empty(PKG_OPTIONS:Mldap)
6439: . include "../../databases/openldap-client/buildlink3.mk"
6440: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6441: .endif
6442:
6443: ###
6444: ### database support
6445: ###
6446: .if !empty(PKG_OPTIONS:Mmysql)
6447: . include "../../mk/mysql.buildlink3.mk"
6448: .endif
6449: .if !empty(PKG_OPTIONS:Mpgsql)
6450: . include "../../mk/pgsql.buildlink3.mk"
6451: .endif
6452: </pre>
6453: <p>The first section contains the information about which build
6454: options are supported by the package, and any default options settings
6455: if needed.</p>
1.23 wiz 6456: <div class="orderedlist"><ol class="orderedlist" type="1">
6457: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.29 dholland 6458: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1 dsieger 6459: options. It should be set to
6460: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6461: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6462: at the point where the options are processed.</p></li>
1.23 wiz 6463: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1 dsieger 6464: build options supported by the package.</p></li>
1.23 wiz 6465: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1 dsieger 6466: list of names of groups of mutually exclusive options. The options in
6467: each group are listed in
6468: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6469: The most specific setting of any option from the group takes
6470: precedence over all other options in the group. Options from the
6471: groups will be automatically added to
6472: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23 wiz 6473: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1 dsieger 6474: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6475: packages will fail if no option from the group is
6476: selected.</p></li>
1.23 wiz 6477: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1 dsieger 6478: of names of sets of options. At least one option from each set must
6479: be selected. The options in each set are listed in
6480: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6481: Options from the sets will be automatically added to
6482: <code class="varname">PKG_SUPPORTED_OPTIONS</code>. Building the package will
6483: fail if no option from the set is selected.</p></li>
1.23 wiz 6484: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1 dsieger 6485: build options which are enabled by default.</p></li>
1.23 wiz 6486: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1 dsieger 6487: of
1.23 wiz 6488: <span class="quote">“<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>”</span>
1.10 hubertf 6489: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1 dsieger 6490: their option counterparts. Pairs should be added with
1.23 wiz 6491: <span class="quote">“<span class="quote">+=</span>”</span> to keep the listing of global legacy variables. A
1.1 dsieger 6492: warning will be issued if the user uses a legacy
6493: variable.</p></li>
1.23 wiz 6494: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1 dsieger 6495: of
1.23 wiz 6496: <span class="quote">“<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>”</span>
1.1 dsieger 6497: pairs that map options that have been renamed to their new
1.23 wiz 6498: counterparts. Pairs should be added with <span class="quote">“<span class="quote">+=</span>”</span> to keep
1.1 dsieger 6499: the listing of global legacy options. A warning will be issued if
6500: the user uses a legacy option.</p></li>
1.23 wiz 6501: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1 dsieger 6502: options implied by deprecated variables used. This can be used for
6503: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6504: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6505: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23 wiz 6506: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1 dsieger 6507: a list of warnings about deprecated variables or options used, and
6508: what to use instead.</p></li>
6509: </ol></div>
6510: <p>A package should never modify
6511: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6512: <code class="varname">PKG_OPTIONS_VAR</code>. These are strictly user-settable.
6513: To suggest a default set of options, use
6514: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6515: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6516: including <code class="filename">bsd.options.mk</code>. If none of
6517: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6518: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6519: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6520: happen with platform-specific options if none of them is supported on
6521: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6522: empty list and the package is otherwise treated as not using the
6523: options framework.</p>
6524: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6525: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6526: build options, properly filtered to remove unsupported and duplicate
6527: options.</p>
6528: <p>The remaining sections contain the logic that is specific to
6529: each option. The correct way to check for an option is to check
6530: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6531: <pre class="programlisting">
6532: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6533: </pre>
6534: </div>
1.41 asau 6535: <div class="sect1">
1.1 dsieger 6536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6537: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1 dsieger 6538: <p>Options that enable similar features in different packages (like
6539: optional support for a library) should use a common name in all
6540: packages that support it (like the name of the library). If another
6541: package already has an option with the same meaning, use the same
6542: name.</p>
6543: <p>Options that enable features specific to one package, where it's
6544: unlikely that another (unrelated) package has the same (or a similar)
6545: optional feature, should use a name prefixed with
6546: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6547: <p>If a group of related packages share an optional feature
6548: specific to that group, prefix it with the name of the
1.23 wiz 6549: <span class="quote">“<span class="quote">main</span>”</span> package
1.1 dsieger 6550: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6551: <p>For new options, add a line to
6552: <code class="filename">mk/defaults/options.description</code>. Lines have two
6553: fields, separated by tab. The first field is the option name, the
6554: second its description. The description should be a whole sentence
6555: (starting with an uppercase letter and ending with a period) that
1.23 wiz 6556: describes what enabling the option does. E. g. <span class="quote">“<span class="quote">Enable ispell
6557: support.</span>”</span> The file is sorted by option names.</p>
1.1 dsieger 6558: </div>
1.41 asau 6559: <div class="sect1">
1.7 rillig 6560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6561: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10 hubertf 6562: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7 rillig 6563: different dependencies based on the options with which the package was
6564: built. For querying these options, the file
6565: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6566: typical example looks like this:</p>
6567: <pre class="programlisting">
6568: pkgbase := libpurple
6569: .include "../../mk/pkg-build-options.mk"
6570:
6571: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6572: ...
6573: .endif
6574: </pre>
6575: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6576: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6577: options of the libpurple package, which can then be queried like
6578: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6579: file. See the file <code class="filename">pkg-build-options.mk</code> for more
6580: details.</p>
6581: </div>
1.1 dsieger 6582: </div>
1.41 asau 6583: <div class="chapter">
1.1 dsieger 6584: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 6585: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1 dsieger 6586: <div class="toc">
6587: <p><b>Table of Contents</b></p>
6588: <dl>
1.6 rillig 6589: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6590: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6591: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6592: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23 wiz 6593: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6 rillig 6594: <dd><dl>
6595: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6596: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6597: </dl></dd>
1.23 wiz 6598: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6599: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6600: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6601: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6602: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6603: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6604: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6605: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6606: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6607: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6 rillig 6608: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6609: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1 dsieger 6610: </dl>
6611: </div>
1.41 asau 6612: <div class="sect1">
1.1 dsieger 6613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6614: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1 dsieger 6615: <p>This chapter gives a detailed description on how a package is
6616: built. Building a package is separated into different
6617: <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6618: <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18 snj 6619: described in the following sections. Each phase is split into
1.1 dsieger 6620: so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6621: containing phase, prefixed by one of <code class="varname">pre-</code>,
6622: <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6623: <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6624: of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6625: <p>Never override the regular targets (like
6626: <code class="varname">fetch</code>), if you have to, override the
6627: <code class="varname">do-*</code> ones instead.</p>
6628: <p>The basic steps for building a program are always the same. First
6629: the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6630: the local system and then extracted. After any pkgsrc-specific patches
6631: to compile properly are applied, the software can be configured, then
6632: built (usually by compiling), and finally the generated binaries, etc.
6633: can be put into place on the system.</p>
6634: <p>To get more details about what is happening at each step,
6635: you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6636: <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6637: in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6638: </div>
1.41 asau 6639: <div class="sect1">
1.1 dsieger 6640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6641: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1 dsieger 6642: <p>Before outlining the process performed by the NetBSD package system in
6643: the next section, here's a brief discussion on where programs are
6644: installed, and which variables influence this.</p>
6645: <p>The automatic variable <code class="varname">PREFIX</code> indicates
6646: where all files of the final program shall be installed. It is
6647: usually set to <code class="varname">LOCALBASE</code>
6648: (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6649: for pkgs in the <code class="filename">cross</code> category. The value of
6650: <code class="varname">PREFIX</code> needs to be put
6651: into the various places in the program's source where paths to
1.10 hubertf 6652: 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.1 dsieger 6653: <p>When choosing which of these variables to use,
6654: follow the following rules:</p>
1.41 asau 6655: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 6656: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1 dsieger 6657: where the current pkg will be installed. When referring to a
6658: pkg's own installation path, use
1.23 wiz 6659: <span class="quote">“<span class="quote">${PREFIX}</span>”</span>.</p></li>
6660: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1 dsieger 6661: are installed. If you need to construct a -I or -L argument
6662: to the compiler to find includes and libraries installed by
1.23 wiz 6663: another non-X11 pkg, use <span class="quote">“<span class="quote">${LOCALBASE}</span>”</span>. The name
1.1 dsieger 6664: <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6665: installed all packages in <code class="filename">/usr/local</code>. As
6666: pkgsrc leaves <code class="filename">/usr/local</code> for the system
6667: administrator, this variable is a misnomer.</p></li>
1.23 wiz 6668: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1 dsieger 6669: distribution (from xsrc, etc.) is installed. When looking for
6670: <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23 wiz 6671: installed by a package), use <span class="quote">“<span class="quote">${X11BASE}</span>”</span>.</p></li>
6672: <li class="listitem">
1.1 dsieger 6673: <p>X11-based packages are special in that they may be
6674: installed in either <code class="varname">X11BASE</code> or
6675: <code class="varname">LOCALBASE</code>.</p>
6676: <p>Usually, X11 packages should be installed under
6677: <code class="varname">LOCALBASE</code> whenever possible. Note that you
6678: will need to include
6679: <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6680: request the presence of X11 and to get the right compilation
6681: flags.</p>
6682: <p>Even though, there are some packages that cannot be installed
6683: under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6684: files. These packages are special and they must be placed under
6685: <code class="varname">X11BASE</code>. To accomplish this, set either
6686: <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6687: your package.</p>
6688: <p>Some notes: If you need
6689: to find includes or libraries installed by a pkg that has
6690: <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6691: its pkg <code class="filename">Makefile</code>, you need to look in
6692: <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6693: <code class="filename">${LOCALBASE}</code>. To force installation of
6694: all X11 packages in <code class="varname">LOCALBASE</code>, the
6695: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6696: is enabled by default.</p>
6697: </li>
1.23 wiz 6698: <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
1.1 dsieger 6699: the installed location of an X11
6700: package. <code class="varname">X11PREFIX</code> will be set to
6701: <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6702: to <code class="varname">LOCALBASE</code> if xpkgwedge is
6703: installed.</p></li>
1.23 wiz 6704: <li class="listitem">
1.1 dsieger 6705: <p>If xpkgwedge is installed, it is possible to have some
6706: packages installed in <code class="varname">X11BASE</code> and some in
6707: <code class="varname">LOCALBASE</code>. To determine the prefix of an
6708: installed package, the <code class="varname">EVAL_PREFIX</code>
6709: definition can be used. It takes pairs in the format
1.29 dholland 6710: <span class="quote">“<span class="quote">DIRNAME=<package></span>”</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1 dsieger 6711: variable <code class="varname">DIRNAME</code> will be set to the prefix
6712: of the installed package <package>, or
1.23 wiz 6713: <span class="quote">“<span class="quote">${X11PREFIX}</span>”</span> if the package is not
1.1 dsieger 6714: installed.</p>
6715: <p>This is best illustrated by example.</p>
6716: <p>The following lines are taken from
6717: <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6718: <pre class="programlisting">
6719: EVAL_PREFIX+= GTKDIR=gtk+
6720: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
6721: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
6722: CONFIGURE_ARGS+= --enable-multibyte
6723: </pre>
6724: <p>Specific defaults can be defined for the packages
6725: evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6726: definition of the form:</p>
6727: <pre class="programlisting">
6728: GTKDIR_DEFAULT= ${LOCALBASE}
6729: </pre>
6730: <p>where <code class="varname">GTKDIR</code> corresponds
6731: to the first definition in
6732: the <code class="varname">EVAL_PREFIX</code> pair.</p>
6733: </li>
1.23 wiz 6734: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.29 dholland 6735: install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1 dsieger 6736: manual pages go into <code class="filename">${PREFIX}/man</code>, not
6737: <code class="filename">${PREFIX}/share/man</code>.</p></li>
6738: </ul></div>
6739: </div>
1.41 asau 6740: <div class="sect1">
1.1 dsieger 6741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6742: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14 jmcneill 6743: <p>When building a package, various directories are used to store
1.1 dsieger 6744: source files, temporary files, pkgsrc-internal files, and so on. These
6745: directories are explained here.</p>
6746: <p>Some of the directory variables contain relative pathnames. There
6747: are two common base directories for these relative directories:
6748: <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6749: pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6750: inside the package itself.</p>
1.41 asau 6751: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6752: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6753: <dd><p>This is an absolute pathname that points to the pkgsrc
6754: root directory. Generally, you don't need
6755: it.</p></dd>
6756: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6757: <dd><p>This is an absolute pathname that points to the
6758: current package.</p></dd>
6759: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6760: <dd><p>This is a pathname relative to
6761: <code class="varname">PKGSRCDIR</code> that points to the current
6762: package.</p></dd>
6763: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6764: <dd><p>This is an absolute pathname pointing to the directory
6765: where all work takes place. The distfiles are extracted to this
6766: directory. It also contains temporary directories and log files used by
6767: the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6768: the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6769: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6770: <dd><p>This is an absolute pathname pointing to the directory
6771: where the distfiles are extracted. It is usually a direct subdirectory
6772: of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6773: that isn't hidden. This variable may be changed by a package
6774: <code class="filename">Makefile</code>.</p></dd>
6775: </dl></div>
1.14 jmcneill 6776: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6777: the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15 rillig 6778: to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14 jmcneill 6779: <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6780: If users would like to have their pkgsrc trees behave in a
6781: read-only manner, then the value of
6782: <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6783: <span class="emphasis"><em>no</em></span>.</p>
1.1 dsieger 6784: </div>
1.41 asau 6785: <div class="sect1">
1.1 dsieger 6786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6787: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10 hubertf 6788: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1 dsieger 6789: phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6790: phase. This will automatically run all phases that are required for this
6791: phase. The default phase is <code class="varname">build</code>, that is, when you
1.10 hubertf 6792: run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1 dsieger 6793: the package will be built, but not installed.</p>
6794: </div>
1.41 asau 6795: <div class="sect1">
1.1 dsieger 6796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6797: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1 dsieger 6798: <p>The first step in building a package is to fetch the
6799: distribution files (distfiles) from the sites that are providing
6800: them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6801: phase.</p>
1.41 asau 6802: <div class="sect2">
1.1 dsieger 6803: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6804: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1 dsieger 6805: <p>In simple cases, <code class="varname">MASTER_SITES</code>
6806: defines all URLs from where the distfile, whose name is
6807: derived from the <code class="varname">DISTNAME</code> variable, is
6808: fetched. The more complicated cases are described
6809: below.</p>
6810: <p>The variable <code class="varname">DISTFILES</code> specifies
6811: the list of distfiles that have to be fetched. Its value
6812: defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6813: so that most packages don't need to define it at all.
6814: <code class="varname">EXTRACT_SUFX</code> is
6815: <code class="literal">.tar.gz</code> by default, but can be changed
6816: freely. Note that if your package requires additional
6817: distfiles to the default one, you cannot just append the
6818: additional filenames using the <code class="literal">+=</code>
6819: operator, but you have write for example:</p>
6820: <pre class="programlisting">
6821: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6822: </pre>
6823: <p>Each distfile is fetched from a list of sites, usually
6824: <code class="varname">MASTER_SITES</code>. If the package has multiple
6825: <code class="varname">DISTFILES</code> or multiple
6826: <code class="varname">PATCHFILES</code> from different sites, you can
6827: set
6828: <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6829: to the list of URLs where the file
6830: <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6831: (including the suffix) can be found.</p>
6832: <pre class="programlisting">
6833: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
6834: DISTFILES+= foo-file.tar.gz
6835: SITES.foo-file.tar.gz= \
6836: http://www.somewhere.com/somehow/ \
6837: http://www.somewhereelse.com/mirror/somehow/
6838: </pre>
6839: <p>When actually fetching the distfiles, each item from
6840: <code class="varname">MASTER_SITES</code> or
6841: <code class="varname">SITES.*</code> gets the name of each distfile
6842: appended to it, without an intermediate slash. Therefore,
6843: all site values have to end with a slash or other separator
6844: character. This allows for example to set
6845: <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6846: that gets the name of the distfile as a parameter. In this
6847: case, the definition would look like:</p>
6848: <pre class="programlisting">
6849: MASTER_SITES= http://www.example.com/download.cgi?file=
6850: </pre>
1.22 jakllsch 6851: <p> The exception to this rule are URLs starting with a dash.
6852: In that case the URL is taken as is, fetched and the result stored
6853: under the name of the distfile.</p>
1.1 dsieger 6854: <p>There are some predefined values for
6855: <code class="varname">MASTER_SITES</code>, which can be used in
6856: packages. The names of the variables should speak for
6857: themselves.</p>
6858: <pre class="programlisting">
6859: ${MASTER_SITE_APACHE}
6860: ${MASTER_SITE_BACKUP}
6861: ${MASTER_SITE_CYGWIN}
6862: ${MASTER_SITE_DEBIAN}
6863: ${MASTER_SITE_FREEBSD}
6864: ${MASTER_SITE_FREEBSD_LOCAL}
6865: ${MASTER_SITE_GENTOO}
6866: ${MASTER_SITE_GNOME}
6867: ${MASTER_SITE_GNU}
6868: ${MASTER_SITE_GNUSTEP}
6869: ${MASTER_SITE_IFARCHIVE}
6870: ${MASTER_SITE_KDE}
6871: ${MASTER_SITE_MOZILLA}
6872: ${MASTER_SITE_MYSQL}
6873: ${MASTER_SITE_OPENOFFICE}
6874: ${MASTER_SITE_PERL_CPAN}
6875: ${MASTER_SITE_PGSQL}
6876: ${MASTER_SITE_R_CRAN}
6877: ${MASTER_SITE_SOURCEFORGE}
6878: ${MASTER_SITE_SOURCEFORGE_JP}
6879: ${MASTER_SITE_SUNSITE}
6880: ${MASTER_SITE_SUSE}
6881: ${MASTER_SITE_TEX_CTAN}
6882: ${MASTER_SITE_XCONTRIB}
6883: ${MASTER_SITE_XEMACS}
6884: </pre>
6885: <p>Some explanations for the less self-explaining ones:
6886: <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26 wiz 6887: for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>. <code class="varname">MASTER_SITE_LOCAL</code> contains local
1.25 spz 6888: package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
1.1 dsieger 6889: <p>If you choose one of these predefined sites, you may
6890: want to specify a subdirectory of that site. Since these
6891: macros may expand to more than one actual site, you
6892: <span class="emphasis"><em>must</em></span> use the following construct to
6893: specify a subdirectory:</p>
6894: <pre class="programlisting">
6895: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
6896: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
6897: </pre>
6898: <p>Note the trailing slash after the subdirectory
6899: name.</p>
6900: </div>
1.41 asau 6901: <div class="sect2">
1.1 dsieger 6902: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 6903: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1 dsieger 6904: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6905: all the distfiles exist in a local directory
6906: (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6907: user). If the files do not exist, they are fetched using
6908: commands of the form</p>
6909: <pre class="programlisting">
6910: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6911: </pre>
6912: <p>where <code class="literal">${site}</code> varies through
6913: several possibilities in turn: first,
6914: <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6915: sites specified in either <code class="varname">SITES.file</code> if
6916: defined, else <code class="varname">MASTER_SITES</code> or
6917: <code class="varname">PATCH_SITES</code>, as applies, then finally the
6918: value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6919: all except the first and the last can be optionally sorted
6920: by the user, via setting either
6921: <code class="varname">MASTER_SORT_RANDOM</code>, and
6922: <code class="varname">MASTER_SORT_AWK</code> or
6923: <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16 jnemeth 6924: <p> The specific command and arguments used depend on the
6925: <code class="varname">FETCH_USING</code> parameter. The example above is
6926: for <code class="literal">FETCH_USING=custom</code>.</p>
1.1 dsieger 6927: <p>The distfiles mirror run by the NetBSD Foundation uses the
6928: <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6929: distfiles, if they are freely distributable. Packages setting
6930: <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23 wiz 6931: <span class="quote">“<span class="quote">${RESTRICTED}</span>”</span>) will not have their distfiles
1.1 dsieger 6932: mirrored.</p>
6933: </div>
6934: </div>
1.41 asau 6935: <div class="sect1">
1.1 dsieger 6936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6937: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1 dsieger 6938: <p>After the distfile(s) are fetched, their checksum is
6939: generated and compared with the checksums stored in the
6940: distinfo file. If the checksums don't match, the build is
6941: aborted. This is to ensure the same distfile is used for
6942: building, and that the distfile wasn't changed, e.g. by some
6943: malign force, deliberately changed distfiles on the master
6944: distribution site or network lossage.</p>
6945: </div>
1.41 asau 6946: <div class="sect1">
1.1 dsieger 6947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6948: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1 dsieger 6949: <p>When the distfiles are present on the local system, they
6950: need to be extracted, as they usually come in the form of some
6951: compressed archive format.</p>
6952: <p>By default, all <code class="varname">DISTFILES</code> are
6953: extracted. If you only need some of them, you can set the
6954: <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6955: files.</p>
6956: <p>Extracting the files is usually done by a little
6957: program, <code class="filename">mk/extract/extract</code>, which
6958: already knows how to extract various archive formats, so most
6959: likely you will not need to change anything here. But if you
6960: need, the following variables may help you:</p>
1.41 asau 6961: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 6962: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6963: <dd><p>Use these variables to override the default
6964: options for an extract command, which are defined in
6965: <code class="filename">mk/extract/extract</code>.</p></dd>
6966: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6967: <dd><p>This variable can be set to
1.14 jmcneill 6968: <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6969: (which is the default value), <code class="literal">pax</code>, or an
1.1 dsieger 6970: absolute pathname pointing to the command with which tar
1.14 jmcneill 6971: archives should be extracted. It is preferred to choose bsdtar over gtar
6972: if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1 dsieger 6973: </dl></div>
6974: <p>If the <code class="filename">extract</code> program doesn't
6975: serve your needs, you can also override the
6976: <code class="varname">EXTRACT_CMD</code> variable, which holds the
6977: command used for extracting the files. This command is
6978: executed in the <code class="filename">${WRKSRC}</code>
6979: directory. During execution of this command, the shell
6980: variable <code class="varname">extract_file</code> holds the absolute
6981: pathname of the file that is going to be extracted.</p>
6982: <p>And if that still does not suffice, you can override the
6983: <code class="varname">do-extract</code> target in the package
6984: Makefile.</p>
6985: </div>
1.41 asau 6986: <div class="sect1">
1.1 dsieger 6987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 6988: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1 dsieger 6989: <p>After extraction, all the patches named by the
6990: <code class="varname">PATCHFILES</code>, those present in the patches
6991: subdirectory of the package as well as in
6992: $LOCALPATCHES/$PKGPATH (e.g.
6993: <code class="filename">/usr/local/patches/graphics/png</code>) are
6994: applied. Patchfiles ending in <code class="filename">.Z</code> or
6995: <code class="filename">.gz</code> are uncompressed before they are
6996: applied, files ending in <code class="filename">.orig</code> or
6997: <code class="filename">.rej</code> are ignored. Any special options to
1.29 dholland 6998: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.10 hubertf 6999: <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>
1.29 dholland 7000: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1 dsieger 7001: it fail if the patches apply with some lines of fuzz. Please
7002: fix (regen) the patches so that they apply cleanly. The
7003: rationale behind this is that patches that don't apply cleanly
7004: may end up being applied in the wrong place, and cause severe
7005: harm there.</p>
7006: </div>
1.41 asau 7007: <div class="sect1">
1.1 dsieger 7008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7009: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10 hubertf 7010: <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.1 dsieger 7011: </p>
7012: </div>
1.41 asau 7013: <div class="sect1">
1.1 dsieger 7014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7015: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1 dsieger 7016: <p>This phase creates wrapper programs for the compilers and
7017: linkers. The following variables can be used to tweak the
7018: wrappers.</p>
1.41 asau 7019: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7020: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
7021: <dd><p>The command used to print progress
7022: messages. Does nothing by default. Set to
7023: <code class="literal">${ECHO}</code> to see the progress
7024: messages.</p></dd>
7025: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
7026: <dd><p>This variable can be set to
7027: <code class="literal">yes</code> (default) or <code class="literal">no</code>,
7028: depending on whether you want additional information in the
7029: wrapper log file.</p></dd>
7030: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
7031: <dd><p>This variable can be set to
7032: <code class="literal">yes</code> or <code class="literal">no</code>, depending
7033: on whether the wrapper should use its cache, which will
7034: improve the speed. The default value is
7035: <code class="literal">yes</code>, but is forced to
7036: <code class="literal">no</code> if the platform does not support
7037: it.</p></dd>
7038: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
7039: <dd><p>A list of reordering commands. A reordering
7040: command has the form
7041: <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
7042: It ensures that that
7043: <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
7044: before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
7045: </p></dd>
7046: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
7047: <dd><p>A list of transformation commands. [TODO:
7048: investigate further]</p></dd>
7049: </dl></div>
7050: </div>
1.41 asau 7051: <div class="sect1">
1.1 dsieger 7052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7053: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1 dsieger 7054: <p>Most pieces of software need information on the header
7055: files, system calls, and library routines which are available
7056: on the platform they run on. The process of determining this
7057: information is known as configuration, and is usually
7058: automated. In most cases, a script is supplied with the
7059: distfiles, and its invocation results in generation of header
7060: files, Makefiles, etc.</p>
7061: <p>If the package contains a configure script, this can be
7062: invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23 wiz 7063: <span class="quote">“<span class="quote">yes</span>”</span>. If the configure script is a GNU autoconf
1.1 dsieger 7064: script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23 wiz 7065: <span class="quote">“<span class="quote">yes</span>”</span> instead. What happens in the
1.1 dsieger 7066: <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
7067: <pre class="programlisting">
7068: .for d in ${CONFIGURE_DIRS}
7069: cd ${WRKSRC} \
7070: && cd ${d} \
7071: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
7072: .endfor
7073: </pre>
7074: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23 wiz 7075: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 7076: <code class="varname">WRKSRC</code>. In each of these directories, the
7077: configure script is run with the environment
7078: <code class="varname">CONFIGURE_ENV</code> and arguments
7079: <code class="varname">CONFIGURE_ARGS</code>. The variables
7080: <code class="varname">CONFIGURE_ENV</code>,
7081: <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23 wiz 7082: <span class="quote">“<span class="quote">./configure</span>”</span>) and
1.1 dsieger 7083: <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
7084: package.</p>
1.37 wiz 7085: <p>If the program uses the Perl way of configuration (mainly Perl
7086: modules, but not only), i.e. a file called
7087: <code class="filename">Makefile.PL</code>, it should include
7088: <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
7089: <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
7090: variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1 dsieger 7091: <p>If the program uses an <code class="filename">Imakefile</code>
7092: for configuration, the appropriate steps can be invoked by
7093: setting <code class="varname">USE_IMAKE</code> to
1.23 wiz 7094: <span class="quote">“<span class="quote">yes</span>”</span>. (If you only want the package installed in
1.1 dsieger 7095: <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
7096: <code class="varname">USE_X11BASE</code> instead.) You can add variables to
7097: xmkmf's environment by adding them to the
7098: <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11 rillig 7099: <p>If the program uses <code class="filename">cmake</code>
7100: for configuration, the appropriate steps can be invoked by
1.23 wiz 7101: setting <code class="varname">USE_CMAKE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.
1.11 rillig 7102: You can add variables to cmake's environment by adding them to the
7103: <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
7104: by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
7105: The top directory argument is given by the
7106: <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23 wiz 7107: <span class="quote">“<span class="quote">.</span>”</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1 dsieger 7108: <p>If there is no configure step at all, set
1.23 wiz 7109: <code class="varname">NO_CONFIGURE</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 7110: </div>
1.41 asau 7111: <div class="sect1">
1.1 dsieger 7112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7113: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 7114: <p>For building a package, a rough equivalent of the
7115: following code is executed.</p>
7116: <pre class="programlisting">
7117: .for d in ${BUILD_DIRS}
7118: cd ${WRKSRC} \
7119: && cd ${d} \
7120: && env ${MAKE_ENV} \
7121: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
7122: -f ${MAKE_FILE} \
7123: ${BUILD_TARGET}
7124: .endfor
7125: </pre>
7126: <p><code class="varname">BUILD_DIRS</code> (default:
1.23 wiz 7127: <span class="quote">“<span class="quote">.</span>”</span>) is a list of pathnames relative to
1.1 dsieger 7128: <code class="varname">WRKSRC</code>. In each of these directories,
7129: <code class="varname">MAKE_PROGRAM</code> is run with the environment
7130: <code class="varname">MAKE_ENV</code> and arguments
7131: <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
7132: <code class="varname">MAKE_ENV</code>,
7133: <code class="varname">BUILD_MAKE_FLAGS</code>,
7134: <code class="varname">MAKE_FILE</code> and
7135: <code class="varname">BUILD_TARGET</code> may all be changed by the
7136: package.</p>
7137: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23 wiz 7138: <span class="quote">“<span class="quote">gmake</span>”</span> if <code class="varname">USE_TOOLS</code> contains
7139: <span class="quote">“<span class="quote">gmake</span>”</span>, <span class="quote">“<span class="quote">make</span>”</span> otherwise. The
1.1 dsieger 7140: default value of <code class="varname">MAKE_FILE</code> is
1.23 wiz 7141: <span class="quote">“<span class="quote">Makefile</span>”</span>, and <code class="varname">BUILD_TARGET</code>
7142: defaults to <span class="quote">“<span class="quote">all</span>”</span>.</p>
1.1 dsieger 7143: <p>If there is no build step at all, set
1.23 wiz 7144: <code class="varname">NO_BUILD</code> to <span class="quote">“<span class="quote">yes</span>”</span>.</p>
1.1 dsieger 7145: </div>
1.41 asau 7146: <div class="sect1">
1.1 dsieger 7147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7148: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1 dsieger 7149: <p>[TODO]</p>
7150: </div>
1.41 asau 7151: <div class="sect1">
1.1 dsieger 7152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7153: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1 dsieger 7154: <p>Once the build stage has completed, the final step is to
7155: install the software in public directories, so users can
7156: access the programs and files.</p>
7157: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
7158: equivalent of the following code is executed. Additionally,
7159: before and after this code, much magic is performed to do
7160: consistency checks, registering the package, and so on.</p>
7161: <pre class="programlisting">
7162: .for d in ${INSTALL_DIRS}
7163: cd ${WRKSRC} \
7164: && cd ${d} \
7165: && env ${MAKE_ENV} \
7166: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7167: -f ${MAKE_FILE} \
7168: ${INSTALL_TARGET}
7169: .endfor
7170: </pre>
7171: <p>The variable's meanings are analogous to the ones in the
7172: <span class="emphasis"><em>build</em></span> phase.
7173: <code class="varname">INSTALL_DIRS</code> defaults to
7174: <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23 wiz 7175: is <span class="quote">“<span class="quote">install</span>”</span> by default, plus
7176: <span class="quote">“<span class="quote">install.man</span>”</span> if <code class="varname">USE_IMAKE</code> is
1.1 dsieger 7177: defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7178: defined.</p>
7179: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7180: variables are useful. They are all variations of the
1.29 dholland 7181: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1 dsieger 7182: permissions preset. <code class="varname">INSTALL</code> is the plain
7183: install command. The specialized variants, together with their
7184: intended use, are:</p>
1.41 asau 7185: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7186: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7187: <dd><p>directories that contain
7188: binaries</p></dd>
7189: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7190: <dd><p>directories that contain
7191: scripts</p></dd>
7192: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7193: <dd><p>directories that contain shared and static
7194: libraries</p></dd>
7195: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7196: <dd><p>directories that contain data
7197: files</p></dd>
7198: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7199: <dd><p>directories that contain man
7200: pages</p></dd>
7201: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7202: <dd><p>binaries that can be stripped from debugging
7203: symbols</p></dd>
7204: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7205: <dd><p>binaries that cannot be
7206: stripped</p></dd>
7207: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7208: <dd><p>game
7209: binaries</p></dd>
7210: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7211: <dd><p>shared and static
7212: libraries</p></dd>
7213: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7214: <dd><p>data files</p></dd>
7215: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7216: <dd><p>data files for
7217: games</p></dd>
7218: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7219: <dd><p>man pages</p></dd>
7220: </dl></div>
7221: <p>Some other variables are:</p>
1.41 asau 7222: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7223: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7224: <dd><p>A list of directories relative to
7225: <code class="varname">PREFIX</code> that are created by pkgsrc at the
7226: beginning of the <span class="emphasis"><em>install</em></span> phase.
7227: The package is supposed to create all needed directories itself
7228: before installing files to it and list all other directories here.
7229: </p></dd>
7230: </dl></div>
7231: <p>In the rare cases that a package shouldn't install anything,
1.23 wiz 7232: set <code class="varname">NO_INSTALL</code> to <span class="quote">“<span class="quote">yes</span>”</span>. This is
1.1 dsieger 7233: mostly relevant for packages in the <code class="filename">regress</code>
7234: category.</p>
7235: </div>
1.41 asau 7236: <div class="sect1">
1.1 dsieger 7237: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7238: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1 dsieger 7239: <p>Once the install stage has completed, a binary package of
7240: the installed files can be built. These binary packages can be
7241: used for quick installation without previous compilation, e.g. by
1.10 hubertf 7242: the <span class="command"><strong>make bin-install</strong></span> or by using
7243: <span class="command"><strong>pkg_add</strong></span>.</p>
1.1 dsieger 7244: <p>By default, the binary packages are created in
7245: <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7246: <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7247: one for each category in the <code class="varname">CATEGORIES</code>
7248: variable. <code class="varname">PACKAGES</code> defaults to
7249: <code class="filename">pkgsrc/packages</code>.</p>
7250: </div>
1.41 asau 7251: <div class="sect1">
1.1 dsieger 7252: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7253: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1 dsieger 7254: <p>Once you're finished with a package, you can clean the work
1.10 hubertf 7255: directory by running <span class="command"><strong>make clean</strong></span>. If you want
1.1 dsieger 7256: to clean the work directories of all dependencies too, use
1.10 hubertf 7257: <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1 dsieger 7258: </div>
1.41 asau 7259: <div class="sect1">
1.1 dsieger 7260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7261: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41 asau 7262: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7263: <dt><span class="term">pre/post-*</span></dt>
7264: <dd><p>For any of the main targets described in the
7265: previous section, two auxiliary targets exist with
1.23 wiz 7266: <span class="quote">“<span class="quote">pre-</span>”</span> and <span class="quote">“<span class="quote">post-</span>”</span> used as a
1.1 dsieger 7267: prefix for the main target's name. These targets are
7268: invoked before and after the main target is called,
7269: allowing extra configuration or installation steps be
7270: performed from a package's Makefile, for example, which
7271: a program's configure script or install target
7272: omitted.</p></dd>
7273: <dt><span class="term">do-*</span></dt>
7274: <dd><p>Should one of the main targets do the wrong thing,
7275: and should there be no variable to fix this, you can
7276: redefine it with the do-* target. (Note that redefining
7277: the target itself instead of the do-* target is a bad
7278: idea, as the pre-* and post-* targets won't be called
7279: anymore, etc.) You will not usually need to do
7280: this.</p></dd>
7281: <dt><span class="term">reinstall</span></dt>
7282: <dd>
1.10 hubertf 7283: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1 dsieger 7284: you noticed some file was not installed properly, you
7285: can repeat the installation with this target, which will
1.23 wiz 7286: ignore the <span class="quote">“<span class="quote">already installed</span>”</span> flag.</p>
1.1 dsieger 7287: <p>This is the default value of
7288: <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10 hubertf 7289: <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1 dsieger 7290: package</strong></span>, where the defaults are
1.23 wiz 7291: <span class="quote">“<span class="quote">package</span>”</span> and <span class="quote">“<span class="quote">update</span>”</span>,
1.1 dsieger 7292: respectively.</p>
7293: </dd>
7294: <dt><span class="term">deinstall</span></dt>
7295: <dd>
1.29 dholland 7296: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1 dsieger 7297: current directory, effectively de-installing the
7298: package. The following variables can be used to tune the
7299: behaviour:</p>
1.41 asau 7300: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7301: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.29 dholland 7302: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1 dsieger 7303: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7304: <dd><p>Remove all packages that require (depend on)
7305: the given package. This can be used to remove any
7306: packages that may have been pulled in by a given
1.10 hubertf 7307: package, e.g. if <span class="command"><strong>make deinstall
1.1 dsieger 7308: DEINSTALLDEPENDS=1</strong></span> is done in
7309: <code class="filename">pkgsrc/x11/kde</code>, this is
7310: likely to remove whole KDE. Works by adding
1.29 dholland 7311: <span class="quote">“<span class="quote">-R</span>”</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1 dsieger 7312: command line.</p></dd>
7313: </dl></div>
7314: </dd>
7315: <dt><span class="term">bin-install</span></dt>
7316: <dd><p>Install a binary package from local disk and via FTP
7317: from a list of sites (see the
7318: <code class="varname">BINPKG_SITES</code> variable), and do a
1.10 hubertf 7319: <span class="command"><strong>make package</strong></span> if no binary package is
1.1 dsieger 7320: available anywhere. The arguments given to
1.10 hubertf 7321: <span class="command"><strong>pkg_add</strong></span> can be set via
1.1 dsieger 7322: <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7323: operation, etc.</p></dd>
7324: <dt><span class="term">update</span></dt>
7325: <dd>
7326: <p>This target causes the current package to be
7327: updated to the latest version. The package and all
7328: depending packages first get de-installed, then current
7329: versions of the corresponding packages get compiled and
7330: installed. This is similar to manually noting which
7331: packages are currently installed, then performing a
1.10 hubertf 7332: series of <span class="command"><strong>make deinstall</strong></span> and
7333: <span class="command"><strong>make install</strong></span> (or whatever
1.1 dsieger 7334: <code class="varname">UPDATE_TARGET</code> is set to) for these
7335: packages.</p>
1.23 wiz 7336: <p>You can use the <span class="quote">“<span class="quote">update</span>”</span> target to
1.10 hubertf 7337: resume package updating in case a previous <span class="command"><strong>make
1.1 dsieger 7338: update</strong></span> was interrupted for some reason.
7339: However, in this case, make sure you don't call
1.10 hubertf 7340: <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1 dsieger 7341: list of dependent packages in <code class="varname">WRKDIR</code>.
7342: Otherwise, you lose the ability to automatically update
7343: the current package along with the dependent packages
7344: you have installed.</p>
1.10 hubertf 7345: <p>Resuming an interrupted <span class="command"><strong>make
1.1 dsieger 7346: update</strong></span> will only work as long as the package
7347: tree remains unchanged. If the source code for one of
7348: the packages to be updated has been changed, resuming
1.10 hubertf 7349: <span class="command"><strong>make update</strong></span> will most certainly
1.1 dsieger 7350: fail!</p>
7351: <p>The following variables can be used either on the
1.10 hubertf 7352: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7353: alter the behaviour of <span class="command"><strong>make
1.1 dsieger 7354: update</strong></span>:</p>
1.41 asau 7355: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7356: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7357: <dd><p>Install target to recursively use for the
7358: updated package and the dependent packages.
7359: Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23 wiz 7360: set, <span class="quote">“<span class="quote">install</span>”</span> otherwise for
1.10 hubertf 7361: <span class="command"><strong>make update</strong></span>. Other good
1.23 wiz 7362: targets are <span class="quote">“<span class="quote">package</span>”</span> or
7363: <span class="quote">“<span class="quote">bin-install</span>”</span>. Do not set this to
7364: <span class="quote">“<span class="quote">update</span>”</span> or you will get stuck in an
1.1 dsieger 7365: endless loop!</p></dd>
7366: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7367: <dd><p>Don't clean up after updating. Useful if
7368: you want to leave the work sources of the updated
7369: packages around for inspection or other purposes.
7370: Be sure you eventually clean up the source tree
1.23 wiz 7371: (see the <span class="quote">“<span class="quote">clean-update</span>”</span> target below)
1.1 dsieger 7372: or you may run into troubles with old source code
7373: still lying around on your next
1.10 hubertf 7374: <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1 dsieger 7375: update</strong></span>.</p></dd>
7376: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7377: <dd><p>Deinstall each package before installing
7378: (making <code class="varname">DEPENDS_TARGET</code>). This
7379: may be necessary if the
1.23 wiz 7380: <span class="quote">“<span class="quote">clean-update</span>”</span> target (see below) was
1.10 hubertf 7381: called after interrupting a running <span class="command"><strong>make
1.1 dsieger 7382: update</strong></span>.</p></dd>
7383: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7384: <dd><p>Allows you to disable recursion and hardcode
7385: the target for packages. The default is
1.23 wiz 7386: <span class="quote">“<span class="quote">update</span>”</span> for the update target,
1.1 dsieger 7387: facilitating a recursive update of prerequisite
7388: packages. Only set
7389: <code class="varname">DEPENDS_TARGET</code> if you want to
7390: disable recursive updates. Use
7391: <code class="varname">UPDATE_TARGET</code> instead to just
7392: set a specific target for each package to be
1.10 hubertf 7393: installed during <span class="command"><strong>make update</strong></span>
1.1 dsieger 7394: (see above).</p></dd>
7395: </dl></div>
7396: </dd>
7397: <dt><span class="term">clean-update</span></dt>
7398: <dd>
7399: <p>Clean the source tree for all packages that would
1.10 hubertf 7400: get updated if <span class="command"><strong>make update</strong></span> was called
1.1 dsieger 7401: from the current directory. This target should not be
7402: used if the current package (or any of its depending
7403: packages) have already been de-installed (e.g., after
1.10 hubertf 7404: calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1 dsieger 7405: some packages you intended to update. As a rule of
7406: thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10 hubertf 7407: the first time you run <span class="command"><strong>make update</strong></span>
1.1 dsieger 7408: and only if you have a dirty package tree (e.g., if you
7409: used <code class="varname">NOCLEAN</code>).</p>
7410: <p>If you are unsure about whether your tree is
1.10 hubertf 7411: clean, you can either perform a <span class="command"><strong>make
1.1 dsieger 7412: clean</strong></span> at the top of the tree, or use the
7413: following sequence of commands from the directory of the
7414: package you want to update (<span class="emphasis"><em>before</em></span>
1.10 hubertf 7415: running <span class="command"><strong>make update</strong></span> for the first
1.1 dsieger 7416: time, otherwise you lose all the packages you wanted to
7417: update!):</p>
7418: <pre class="screen">
7419: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7420: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7421: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7422: </pre>
7423: <p>The following variables can be used either on the
1.10 hubertf 7424: command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7425: <span class="command"><strong>make clean-update</strong></span>:</p>
1.41 asau 7426: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 7427: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10 hubertf 7428: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1 dsieger 7429: reconstruct the list of directories to update for
1.10 hubertf 7430: this package. Only use this if <span class="command"><strong>make
1.1 dsieger 7431: update</strong></span> successfully installed all
7432: packages you wanted to update. Normally, this is
1.10 hubertf 7433: done automatically on <span class="command"><strong>make
1.1 dsieger 7434: update</strong></span>, but may have been suppressed by
7435: the <code class="varname">NOCLEAN</code> variable (see
7436: above).</p></dd>
7437: </dl></div>
7438: </dd>
7439: <dt><span class="term">replace</span></dt>
7440: <dd>
7441: <p>Update the installation of the current package. This
7442: differs from update in that it does not replace dependent
7443: 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
7444: target to work.</p>
7445: <p><span class="emphasis"><em>Be careful when using this
7446: target!</em></span> There are no guarantees that dependent
7447: packages will still work, in particular they will most
1.10 hubertf 7448: certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1 dsieger 7449: library package whose shared library major version changed
7450: between your installed version and the new one. For this
7451: reason, this target is not officially supported and only
7452: recommended for advanced users.</p>
7453: </dd>
7454: <dt><span class="term">info</span></dt>
1.29 dholland 7455: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1 dsieger 7456: package. You can use this to check which version of a
7457: package is installed.</p></dd>
7458: <dt><span class="term">index</span></dt>
7459: <dd>
7460: <p>This is a top-level command, i.e. it should be used in
7461: the <code class="filename">pkgsrc</code> directory. It creates a
7462: database of all packages in the local pkgsrc tree, including
7463: dependencies, comment, maintainer, and some other useful
7464: information. Individual entries are created by running
1.10 hubertf 7465: <span class="command"><strong>make describe</strong></span> in the packages'
1.1 dsieger 7466: directories. This index file is saved as
7467: <code class="filename">pkgsrc/INDEX</code>. It can be displayed in
1.10 hubertf 7468: verbose format by running <span class="command"><strong>make
1.1 dsieger 7469: print-index</strong></span>. You can search in it with
1.10 hubertf 7470: <span class="command"><strong>make search
1.1 dsieger 7471: key=<em class="replaceable"><code>something</code></em></strong></span>. You can
7472: extract a list of all packages that depend on a particular
1.10 hubertf 7473: one by running <span class="command"><strong>make show-deps
1.1 dsieger 7474: PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7475: <p>Running this command takes a very long time, some
7476: hours even on fast machines!</p>
7477: </dd>
7478: <dt><span class="term">readme</span></dt>
7479: <dd>
7480: <p>This target generates a
7481: <code class="filename">README.html</code> file, which can be
7482: 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
7483: contain references to any packages which are in the
7484: <code class="varname">PACKAGES</code> directory on the local
7485: host. The generated files can be made to refer to URLs
7486: based on <code class="varname">FTP_PKG_URL_HOST</code> and
7487: <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7488: wanted to generate <code class="filename">README.html</code>
7489: files which pointed to binary packages on the local
7490: machine, in the directory
7491: <code class="filename">/usr/packages</code>, set
7492: <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7493: <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7494: <code class="varname">${PACKAGES}</code> directory and its
7495: subdirectories will be searched for all the binary
7496: packages.</p>
7497: <p>The target can be run at the toplevel or in category
7498: directories, in which case it descends recursively.</p>
7499: </dd>
7500: <dt><span class="term">readme-all</span></dt>
7501: <dd><p>This is a top-level command, run it in
7502: <code class="filename">pkgsrc</code>. Use this target to create a
7503: file <code class="filename">README-all.html</code> which contains a
7504: list of all packages currently available in the NetBSD
7505: Packages Collection, together with the category they belong
7506: to and a short description. This file is compiled from the
7507: <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10 hubertf 7508: to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1 dsieger 7509: readme</strong></span>.</p></dd>
7510: <dt><span class="term">cdrom-readme</span></dt>
7511: <dd><p>This is very much the same as the
1.23 wiz 7512: <span class="quote">“<span class="quote">readme</span>”</span> target (see above), but is to be
1.1 dsieger 7513: used when generating a pkgsrc tree to be written to a
7514: CD-ROM. This target also produces
7515: <code class="filename">README.html</code> files, and can be made
7516: to refer to URLs based on
7517: <code class="varname">CDROM_PKG_URL_HOST</code> and
7518: <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7519: <dt><span class="term">show-distfiles</span></dt>
7520: <dd><p>This target shows which distfiles and patchfiles
7521: are needed to build the package
7522: (<code class="varname">ALLFILES</code>, which contains all
7523: <code class="varname">DISTFILES</code> and
7524: <code class="varname">PATCHFILES</code>, but not
7525: <code class="filename">patches/*</code>).</p></dd>
7526: <dt><span class="term">show-downlevel</span></dt>
7527: <dd><p>This target shows nothing if the package is not
7528: installed. If a version of this package is installed,
7529: but is not the version provided in this version of
7530: pkgsrc, then a warning message is displayed. This target
7531: can be used to show which of your installed packages are
7532: downlevel, and so the old versions can be deleted, and
7533: the current ones added.</p></dd>
7534: <dt><span class="term">show-pkgsrc-dir</span></dt>
7535: <dd><p>This target shows the directory in the pkgsrc
7536: hierarchy from which the package can be built and
7537: installed. This may not be the same directory as the one
7538: from which the package was installed. This target is
7539: intended to be used by people who may wish to upgrade
7540: many packages on a single host, and can be invoked from
7541: the top-level pkgsrc Makefile by using the
1.23 wiz 7542: <span class="quote">“<span class="quote">show-host-specific-pkgs</span>”</span> target.</p></dd>
1.1 dsieger 7543: <dt><span class="term">show-installed-depends</span></dt>
7544: <dd><p>This target shows which installed packages match
7545: the current package's <code class="varname">DEPENDS</code>. Useful
7546: if out of date dependencies are causing build
7547: problems.</p></dd>
7548: <dt><span class="term">check-shlibs</span></dt>
7549: <dd><p>After a package is installed, check all its
7550: binaries and (on ELF platforms) shared libraries to see
7551: if they find the shared libs they need. Run by default
1.10 hubertf 7552: 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.1 dsieger 7553: <dt><span class="term">print-PLIST</span></dt>
7554: <dd>
1.23 wiz 7555: <p>After a <span class="quote">“<span class="quote">make install</span>”</span> from a new or
1.1 dsieger 7556: upgraded pkg, this prints out an attempt to generate a
1.10 hubertf 7557: new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1 dsieger 7558: -newer work/.extract_done</strong></span>. An attempt is made
7559: to care for shared libs etc., but it is
7560: <span class="emphasis"><em>strongly</em></span> recommended to review the
7561: result before putting it into
7562: <code class="filename">PLIST</code>. On upgrades, it's useful to
7563: diff the output of this command against an already
7564: existing <code class="filename">PLIST</code> file.</p>
1.29 dholland 7565: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1 dsieger 7566: other methods that don't update file access times, be
7567: sure to add these files manually to your
1.23 wiz 7568: <code class="filename">PLIST</code>, as the <span class="quote">“<span class="quote">find
7569: -newer</span>”</span> command used by this target won't catch
1.1 dsieger 7570: them!</p>
1.23 wiz 7571: <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.1 dsieger 7572: information on this target.</p>
7573: </dd>
7574: <dt><span class="term">bulk-package</span></dt>
7575: <dd>
7576: <p>Used to do bulk builds. If an appropriate binary
7577: package already exists, no action is taken. If not, this
7578: target will compile, install and package it (and its
7579: depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10 hubertf 7580: properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, “Configuration”</a>).
1.1 dsieger 7581: After creating the binary package, the sources, the
7582: just-installed package and its required packages are
7583: removed, preserving free disk space.</p>
7584: <p><span class="emphasis"><em>Beware that this target may deinstall
7585: all packages installed on a system!</em></span></p>
7586: </dd>
7587: <dt><span class="term">bulk-install</span></dt>
7588: <dd>
7589: <p>Used during bulk-installs to install required
7590: packages. If an up-to-date binary package is available,
1.29 dholland 7591: it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10 hubertf 7592: <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1 dsieger 7593: but the installed binary won't be removed.</p>
7594: <p>A binary package is considered
1.23 wiz 7595: <span class="quote">“<span class="quote">up-to-date</span>”</span> to be installed via
1.29 dholland 7596: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41 asau 7597: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7598: <li class="listitem"><p>None of the package's files
1.1 dsieger 7599: (<code class="filename">Makefile</code>, ...) were modified
7600: since it was built.</p></li>
1.23 wiz 7601: <li class="listitem"><p>None of the package's required (binary)
1.1 dsieger 7602: packages were modified since it was built.</p></li>
7603: </ul></div>
7604: <p><span class="emphasis"><em>Beware that this target may deinstall
7605: all packages installed on a system!</em></span></p>
7606: </dd>
7607: </dl></div>
7608: </div>
7609: </div>
1.41 asau 7610: <div class="chapter">
1.1 dsieger 7611: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7612: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1 dsieger 7613: <div class="toc">
7614: <p><b>Table of Contents</b></p>
7615: <dl>
1.6 rillig 7616: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7617: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7618: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7619: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1 dsieger 7620: </dl>
7621: </div>
7622: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7623: by pkgsrc and also for individual packages to define what commands
7624: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7625: or for later run-time of an installed packaged (such as
7626: <code class="varname">DEPENDS</code>).
7627: If the native system provides an adequate tool, then in many cases, a pkgsrc
7628: package will not be used.</p>
7629: <p>When building a package, the replacement tools are
7630: made available in a directory (as symlinks or wrapper scripts)
7631: that is early in the executable search path. Just like the buildlink
7632: system, this helps with consistent builds.</p>
7633: <p>A tool may be needed to help build a specific package. For example,
7634: perl, GNU make (gmake) or yacc may be needed.</p>
7635: <p>Also a tool may be needed, for example, because the native system's supplied
7636: tool may be inefficient for building a package with pkgsrc.
7637: For example, a package may need GNU awk, bison (instead of
7638: yacc) or a better sed.</p>
7639: <p>The tools used by a package can be listed by running
1.10 hubertf 7640: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41 asau 7641: <div class="sect1">
1.1 dsieger 7642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7643: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1 dsieger 7644: <p>The default set of tools used by pkgsrc is defined in
7645: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10 hubertf 7646: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7647: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1 dsieger 7648: These can be seen by running:
1.10 hubertf 7649: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1 dsieger 7650: <p>If a package needs a specific program to build
7651: then the <code class="varname">USE_TOOLS</code> variable can be used
7652: to define the tools needed.</p>
7653: </div>
1.41 asau 7654: <div class="sect1">
1.1 dsieger 7655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7656: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28 wiz 7657: <p>In the following examples, the :run means that it is needed at
7658: run-time (and becomes a DEPENDS).
1.1 dsieger 7659: The default is a build dependency which can be set with
7660: :build. (So in this example, it is the same as gmake:build
7661: and pkg-config:build.)</p>
7662: <pre class="programlisting">
7663: USE_TOOLS+= gmake perl:run pkg-config
7664: </pre>
7665: <p>When using the tools framework, a
7666: <code class="varname">TOOLS_PATH.foo</code> variable is defined
7667: which contains the full path to the appropriate tool. For example,
1.23 wiz 7668: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">“<span class="quote">/bin/bash</span>”</span>
1.1 dsieger 7669: on Linux systems.</p>
7670: <p>If you always need a pkgsrc version of the
7671: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7672: </p>
7673: </div>
1.41 asau 7674: <div class="sect1">
1.1 dsieger 7675: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7676: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1 dsieger 7677: <p>When improving or porting pkgsrc to a new platform, have a look
7678: at (or create) the corresponding platform specific make file fragment under
7679: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7680: the name of the common tools. For example:</p>
7681: <pre class="programlisting">
7682: .if exists(/usr/bin/bzcat)
7683: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
7684: .elif exists(/usr/bin/bzip2)
7685: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
7686: .endif
7687:
7688: TOOLS_PLATFORM.true?= true # shell builtin
7689: </pre>
7690: </div>
1.41 asau 7691: <div class="sect1">
1.1 dsieger 7692: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7693: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.41 asau 7694: <div class="qandaset">
1.57 ! bsiegert 7695: <a name="idp140459939576832"></a><dl>
1.6 rillig 7696: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1 dsieger 7697: </dt>
1.6 rillig 7698: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1 dsieger 7699: tools?</a>
7700: </dt>
1.6 rillig 7701: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1 dsieger 7702: package is using while being built? I want to know whether it
7703: uses sed or not.</a>
7704: </dt>
7705: </dl>
1.41 asau 7706: <table border="0" style="width: 100%;">
7707: <colgroup>
1.1 dsieger 7708: <col align="left" width="1%">
1.23 wiz 7709: <col>
1.41 asau 7710: </colgroup>
1.1 dsieger 7711: <tbody>
1.41 asau 7712: <tr class="question">
1.1 dsieger 7713: <td align="left" valign="top">
1.57 ! bsiegert 7714: <a name="tools.new"></a><a name="idp140459939577472"></a><p><b>18.4.1.</b></p>
1.1 dsieger 7715: </td>
7716: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7717: </tr>
7718: <tr class="answer">
7719: <td align="left" valign="top"></td>
7720: <td align="left" valign="top"><p>TODO</p></td>
7721: </tr>
1.41 asau 7722: <tr class="question">
1.1 dsieger 7723: <td align="left" valign="top">
1.57 ! bsiegert 7724: <a name="tools.listall"></a><a name="idp140459939578752"></a><p><b>18.4.2.</b></p>
1.1 dsieger 7725: </td>
7726: <td align="left" valign="top"><p>How do I get a list of all available
7727: tools?</p></td>
7728: </tr>
7729: <tr class="answer">
7730: <td align="left" valign="top"></td>
7731: <td align="left" valign="top"><p>TODO</p></td>
7732: </tr>
1.41 asau 7733: <tr class="question">
1.1 dsieger 7734: <td align="left" valign="top">
1.57 ! bsiegert 7735: <a name="tools.used"></a><a name="idp140459939580048"></a><p><b>18.4.3.</b></p>
1.1 dsieger 7736: </td>
7737: <td align="left" valign="top"><p>How can I get a list of all the tools that a
7738: package is using while being built? I want to know whether it
7739: uses sed or not.</p></td>
7740: </tr>
7741: <tr class="answer">
7742: <td align="left" valign="top"></td>
7743: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7744: to do it.)</p></td>
7745: </tr>
7746: </tbody>
7747: </table>
7748: </div>
7749: </div>
7750: </div>
1.41 asau 7751: <div class="chapter">
1.1 dsieger 7752: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 7753: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1 dsieger 7754: <div class="toc">
7755: <p><b>Table of Contents</b></p>
7756: <dl>
1.6 rillig 7757: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1 dsieger 7758: <dd><dl>
1.6 rillig 7759: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.23 wiz 7760: <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>
1.6 rillig 7761: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7762: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7763: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7764: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7765: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7766: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7767: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7768: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7769: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7770: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7771: </dl></dd>
1.23 wiz 7772: <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>
1.6 rillig 7773: <dd><dl>
7774: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7775: <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>
7776: </dl></dd>
1.23 wiz 7777: <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>
1.6 rillig 7778: <dd><dl>
7779: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7780: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7781: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7782: </dl></dd>
7783: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7784: <dd><dl>
7785: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7786: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7787: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40 wiz 7788: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
7789: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6 rillig 7790: </dl></dd>
1.23 wiz 7791: <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>
1.6 rillig 7792: <dd><dl>
7793: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7794: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23 wiz 7795: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span></a></span></dt>
1.6 rillig 7796: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7797: </dl></dd>
1.23 wiz 7798: <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>
1.6 rillig 7799: <dd><dl>
7800: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7801: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7802: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7803: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7804: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7805: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7806: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7807: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7 rillig 7808: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18 snj 7809: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6 rillig 7810: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7811: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7812: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7813: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7814: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7815: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7816: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7817: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1 dsieger 7818: emulation</a></span></dt>
1.6 rillig 7819: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7820: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1 dsieger 7821: </dl></dd>
1.6 rillig 7822: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1 dsieger 7823: </dl>
7824: </div>
1.41 asau 7825: <div class="sect1">
1.1 dsieger 7826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 7827: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.41 asau 7828: <div class="sect2">
1.1 dsieger 7829: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7830: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1 dsieger 7831: <p>One appealing feature of pkgsrc is that it runs on many
7832: different platforms. As a result, it is important to ensure,
7833: where possible, that packages in pkgsrc are portable. This
7834: chapter mentions some particular details you should pay
7835: attention to while working on pkgsrc.</p>
7836: </div>
1.41 asau 7837: <div class="sect2">
1.1 dsieger 7838: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 7839: <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.1 dsieger 7840: </h3></div></div></div>
7841: <p>The pkgsrc user can configure pkgsrc by overriding several
7842: variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10 hubertf 7843: which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1 dsieger 7844: want to use those variables in the preprocessor directives of
1.29 dholland 7845: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1 dsieger 7846: <code class="literal">.for</code>), you need to include the file
7847: <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7848: loads the user preferences.</p>
7849: <p>But note that some variables may not be completely defined
7850: after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7851: included, as they may contain references to variables that are
7852: not yet defined. In shell commands this is no problem, since
7853: variables are actually macros, which are only expanded when they
7854: are used. But in the preprocessor directives mentioned above and
7855: in dependency lines (of the form <code class="literal">target:
7856: dependencies</code>) the variables are expanded at load
7857: time.</p>
1.41 asau 7858: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 7859: <h3 class="title">Note</h3>
7860: <p>Currently there is no exhaustive list of all
7861: variables that tells you whether they can be used at load time
7862: or only at run time, but it is in preparation.</p>
7863: </div>
7864: </div>
1.41 asau 7865: <div class="sect2">
1.1 dsieger 7866: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7867: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1 dsieger 7868: <p>Occasionally, packages require interaction from the user,
7869: and this can be in a number of ways:</p>
1.41 asau 7870: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 7871: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1 dsieger 7872: interaction such as entering username/password or accepting a
7873: license on a web page.</p></li>
1.23 wiz 7874: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1 dsieger 7875: passwords.</p></li>
1.23 wiz 7876: <li class="listitem"><p>help to configure the package before it is built</p></li>
7877: <li class="listitem"><p>help during the build process</p></li>
7878: <li class="listitem"><p>help during the installation of a package</p></li>
1.1 dsieger 7879: </ul></div>
7880: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7881: provided to notify the pkgsrc mechanism of an interactive stage
7882: which will be needed, and this should be set in the package's
7883: <code class="filename">Makefile</code>, e.g.:</p>
7884: <pre class="programlisting">
7885: INTERACTIVE_STAGE= build
7886: </pre>
7887: <p>Multiple interactive stages can be specified:</p>
7888: <pre class="programlisting">
7889: INTERACTIVE_STAGE= configure install
7890: </pre>
7891: <p>The user can then decide to skip this package by setting the
7892: <code class="varname">BATCH</code> variable.</p>
7893: </div>
1.41 asau 7894: <div class="sect2">
1.1 dsieger 7895: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 7896: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1 dsieger 7897: <p>Authors of software can choose the licence under which
7898: software can be copied. This is due to copyright law, and reasons
7899: for license choices are outside the scope of pkgsrc. The pkgsrc
7900: system recognizes that there are a number of licenses which some
7901: users may find objectionable or difficult or impossible to comply
7902: with. The Free Software Foundation has declared some licenses
7903: "Free", and the Open Source Initiative has a definition of "Open
7904: Source". The pkgsrc system, as a policy choice, does not label
7905: packages which have licenses that are Free or Open Source.
7906: However, packages without a license meeting either of those tests
7907: are labeled with a license tag denoting the license. Note that a
7908: package with no license to copy trivially does not meet either the
7909: Free or Open Source test.</p>
7910: <p>For packages which are not Free or Open Source, pkgsrc will
7911: not build the package unless the user has indicated to pkgsrc that
7912: packages with that particular license may be built. Note that
7913: this documentation avoids the term "accepted the license". The
7914: pkgsrc system is merely providing a mechanism to avoid
7915: accidentally building a package with a non-free license;
7916: judgement and responsibility remain with the user. (Installation
7917: of binary packages are not currently subject to this mechanism;
7918: this is a bug.)</p>
7919: <p>One might want to only install packages with a BSD license,
1.19 jnemeth 7920: or the GPL, and not the other. The free licenses are added to the
7921: default <code class="varname">ACCEPTABLE_LICENSES</code> variable. The
7922: user can override the default by setting the
7923: <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7924: of "+=". The licenses accepted by default are:
7925: </p>
7926: <pre class="programlisting">
1.48 rodent 7927: apache-1.1 apache-2.0
7928: arphic-public
7929: artistic artistic-2.0
7930: boost-license
7931: cc-by-sa-v3.0
1.55 ryoon 7932: cc0-1.0-universal
1.48 rodent 7933: cddl-1.0
7934: cpl-1.0
7935: epl-v1.0
7936: gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
7937: gnu-gpl-v1
7938: gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
7939: gnu-gpl-v3 gnu-lgpl-v3
7940: ibm-public-license-1.0
7941: ipafont
7942: isc
7943: lppl-1.3c
7944: lucent
7945: miros
7946: mit
7947: mpl-1.0 mpl-1.1 mpl-2.0
7948: mplusfont
7949: ofl-v1.0 ofl-v1.1
7950: original-bsd modified-bsd 2-clause-bsd
7951: php
7952: png-license
7953: postgresql-license
7954: public-domain
7955: python-software-foundation
7956: qpl-v1.0
1.52 rodent 7957: sgi-free-software-b-v2.0
1.48 rodent 7958: sleepycat-public
7959: unlicense
7960: x11
7961: zlib
7962: zpl
1.19 jnemeth 7963: </pre>
7964: <p>
7965: </p>
1.1 dsieger 7966: <p>The license tag mechanism is intended to address
7967: copyright-related issues surrounding building, installing and
7968: using a package, and not to address redistribution issues (see
7969: <code class="varname">RESTRICTED</code> and
1.19 jnemeth 7970: <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7971: Packages with redistribution restrictions should set these
7972: tags.</p>
1.1 dsieger 7973: <p>Denoting that a package may be copied according to a
7974: particular license is done by placing the license in
7975: <code class="filename">pkgsrc/licenses</code> and setting the
7976: <code class="varname">LICENSE</code> variable to a string identifying the
7977: 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>
7978: <pre class="programlisting">
7979: LICENSE= xv-license
7980: </pre>
7981: <p>When trying to build, the user will get a notice that the
7982: package is covered by a license which has not been placed in the
7983: <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7984: <pre class="programlisting">
7985: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7986: ===> xv-3.10anb9 has an unacceptable license: xv-license.
7987: ===> To view the license, enter "/usr/bin/make show-license".
7988: ===> To indicate acceptance, add this line to your /etc/mk.conf:
7989: ===> ACCEPTABLE_LICENSES+=xv-license
7990: *** Error code 1
7991: </pre>
1.10 hubertf 7992: <p>The license can be viewed with <span class="command"><strong>make
1.1 dsieger 7993: show-license</strong></span>, and if the user so chooses, the line
1.10 hubertf 7994: printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1 dsieger 7995: convey to pkgsrc that it should not in the future fail because of
7996: that license:</p>
7997: <pre class="programlisting">
7998: ACCEPTABLE_LICENSES+=xv-license
7999: </pre>
1.48 rodent 8000: <p>When adding a package with a new license, the following steps
8001: are required:</p>
8002: <div class="orderedlist"><ol class="orderedlist" type="1">
8003: <li class="listitem">
8004: <p>Check if the file can avoid the -license filename tag as described above by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.html" target="_top">Various Licenses and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name | Open Source Initiative</a>. If this is the case, additionally add the license filename to:</p>
8005: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
8006: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
8007: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.52 rodent 8008: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.48 rodent 8009: </ul></div>
8010: <p>with the proper syntax as demonstrated in those files, respectively.</p>
8011: </li>
8012: <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying. A list of known licenses can be seen in this directory.</p></li>
8013: </ol></div>
1.1 dsieger 8014: <p>When the license changes (in a way other than formatting),
8015: please make sure that the new license has a different name (e.g.,
8016: append the version number if it exists, or the date). Just
8017: because a user told pkgsrc to build programs under a previous
8018: version of a license does not mean that pkgsrc should build
8019: programs under the new licenses. The higher-level point is that
8020: pkgsrc does not evaluate licenses for reasonableness; the only
8021: test is a mechanistic test of whether a particular text has been
8022: approved by either of two bodies.</p>
8023: <p>The use of <code class="varname">LICENSE=shareware</code>,
8024: <code class="varname">LICENSE=no-commercial-use</code>, and similar language
8025: is deprecated because it does not crisply refer to a particular
8026: license text. Another problem with such usage is that it does not
8027: enable a user to tell pkgsrc to proceed for a single package
8028: without also telling pkgsrc to proceed for all packages with that
8029: tag.</p>
8030: </div>
1.41 asau 8031: <div class="sect2">
1.1 dsieger 8032: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8033: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1 dsieger 8034: <p>Some licenses restrict how software may be re-distributed.
8035: Because a license tag is required unless the package is Free or
8036: Open Source, all packages with restrictions should have license
8037: tags. By declaring the restrictions, package tools can
8038: automatically refrain from e.g. placing binary packages on FTP
8039: sites.</p>
8040: <p>There are four restrictions that may be encoded, which are
8041: the cross product of sources (distfiles) and binaries not being
8042: placed on FTP sites and CD-ROMs. Because this is rarely the exact
8043: language in any license, and because non-Free licenses tend to be
8044: different from each other, pkgsrc adopts a definition of FTP and
8045: CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file
8046: should not be made available over the Internet at no charge.
8047: Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
8048: made available on some kind of media, together with other source
8049: and binary packages, and which is sold for a distribution charge.
8050: </p>
8051: <p>In order to encode these restrictions, the package system
8052: defines five make variables that can be set to note these
8053: restrictions:</p>
1.41 asau 8054: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8055: <li class="listitem">
1.1 dsieger 8056: <p><code class="varname">RESTRICTED</code></p>
8057: <p>This variable should be set whenever a restriction
8058: exists (regardless of its kind). Set this variable to a
8059: string containing the reason for the restriction. It should
8060: be understood that those wanting to understand the restriction
8061: will have to read the license, and perhaps seek advice of
8062: counsel.</p>
8063: </li>
1.23 wiz 8064: <li class="listitem">
1.1 dsieger 8065: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
8066: <p>Binaries may not be placed on CD-ROM containing other
8067: binary packages, for which a distribution charge may be made.
8068: In this case, set this variable to
8069: <code class="varname">${RESTRICTED}</code>.</p>
8070: </li>
1.23 wiz 8071: <li class="listitem">
1.1 dsieger 8072: <p><code class="varname">NO_BIN_ON_FTP</code></p>
8073: <p>Binaries may not made available on the Internet without
8074: charge. In this case, set this variable to
8075: <code class="varname">${RESTRICTED}</code>. If this variable is set,
8076: binary packages will not be included on ftp.NetBSD.org.</p>
8077: </li>
1.23 wiz 8078: <li class="listitem">
1.1 dsieger 8079: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
8080: <p>Distfiles may not be placed on CD-ROM, together with
8081: other distfiles, for which a fee may be charged. In this
8082: case, set this variable to <code class="varname">${RESTRICTED}</code>.
8083: </p>
8084: </li>
1.23 wiz 8085: <li class="listitem">
1.1 dsieger 8086: <p><code class="varname">NO_SRC_ON_FTP</code></p>
8087: <p>Distfiles may not made available via FTP at no charge.
8088: In this case, set this variable to
8089: <code class="varname">${RESTRICTED}</code>. If this variable is set,
8090: the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
8091: </li>
8092: </ul></div>
1.32 wiz 8093: <p>Please note that packages will to be removed from pkgsrc
8094: when the distfiles are not distributable and cannot be obtained
8095: for a period of one full quarter branch. Packages with manual /
8096: interactive fetch must have a maintainer and it is his/her
8097: responsibility to ensure this.</p>
1.1 dsieger 8098: </div>
1.41 asau 8099: <div class="sect2">
1.1 dsieger 8100: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8101: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1 dsieger 8102: <p>Your package may depend on some other package being present
8103: - and there are various ways of expressing this dependency.
8104: pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
8105: <code class="varname">DEPENDS</code> definitions, the
8106: <code class="varname">USE_TOOLS</code> definition, as well as dependencies
8107: via <code class="filename">buildlink3.mk</code>, which is the preferred way
8108: to handle dependencies, and which uses the variables named above.
1.10 hubertf 8109: See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1 dsieger 8110: <p>The basic difference between the two variables is as
8111: follows: The <code class="varname">DEPENDS</code> definition registers
8112: that pre-requisite in the binary package so it will be pulled in
8113: when the binary package is later installed, whilst the
8114: <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
8115: dependency that is only needed for building the package.</p>
8116: <p>This means that if you only need a package present whilst
8117: you are building, it should be noted as a
8118: <code class="varname">BUILD_DEPENDS</code>.</p>
8119: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
8120: <code class="varname">DEPENDS</code> definition is:</p>
8121: <pre class="programlisting">
8122: <pre-req-package-name>:../../<category>/<pre-req-package>
8123: </pre>
1.23 wiz 8124: <p>Please note that the <span class="quote">“<span class="quote">pre-req-package-name</span>”</span>
1.1 dsieger 8125: may include any of the wildcard version numbers recognized by
1.29 dholland 8126: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23 wiz 8127: <div class="orderedlist"><ol class="orderedlist" type="1">
8128: <li class="listitem">
1.1 dsieger 8129: <p>If your package needs another package's binaries or
1.54 wiz 8130: libraries to build and run, and if that package has a
1.1 dsieger 8131: <code class="filename">buildlink3.mk</code> file available, use it:</p>
8132: <pre class="programlisting">
8133: .include "../../graphics/jpeg/buildlink3.mk"
8134: </pre>
8135: </li>
1.23 wiz 8136: <li class="listitem">
1.54 wiz 8137: <p>If your package needs another package's binaries or
8138: libraries only for building, and if that package has a
8139: <code class="filename">buildlink3.mk</code> file available, use it:</p>
8140: <pre class="programlisting">
8141: .include "../../graphics/jpeg/buildlink3.mk"
8142: </pre>
8143: <p>but set
8144: <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
8145: to make it a build dependency only. This case is rather
8146: rare.</p>
8147: </li>
8148: <li class="listitem">
1.25 spz 8149: <p>If your package needs binaries from another package to build,
8150: use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1 dsieger 8151: <pre class="programlisting">
1.25 spz 8152: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.1 dsieger 8153: </pre>
8154: </li>
1.25 spz 8155: <li class="listitem"><p>If your package needs a library with which to link and
8156: there is no <code class="filename">buildlink3.mk</code> file
8157: available, create one. Using
8158: <code class="varname">DEPENDS</code> won't be sufficient because the
8159: include files and libraries will be hidden from the compiler.</p></li>
1.23 wiz 8160: <li class="listitem">
1.25 spz 8161: <p>If your package needs some executable to be able to run
8162: correctly and if there's no
8163: <code class="filename">buildlink3.mk</code> file, this is specified
8164: using the <code class="varname">DEPENDS</code> variable. The
8165: <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
8166: be able to execute the latex binary from the teTeX package
8167: when it runs, and that is specified:</p>
1.1 dsieger 8168: <pre class="programlisting">
1.25 spz 8169: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
1.1 dsieger 8170: </pre>
1.25 spz 8171: </li>
8172: <li class="listitem">
8173: <p>You can use wildcards in package dependencies. Note that
8174: such wildcard dependencies are retained when creating binary
8175: packages. The dependency is checked when installing the binary
8176: package and any package which matches the pattern will be
8177: used. Wildcard dependencies should be used with care.</p>
1.23 wiz 8178: <p>The <span class="quote">“<span class="quote">-[0-9]*</span>”</span> should be used instead of
8179: <span class="quote">“<span class="quote">-*</span>”</span> to avoid potentially ambiguous matches
8180: such as <span class="quote">“<span class="quote">tk-postgresql</span>”</span> matching a
8181: <span class="quote">“<span class="quote">tk-*</span>”</span> <code class="varname">DEPENDS</code>.</p>
1.1 dsieger 8182: <p>Wildcards can also be used to specify that a package
8183: will only build against a certain minimum version of a
8184: pre-requisite:</p>
8185: <pre class="programlisting">
1.25 spz 8186: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 8187: </pre>
1.25 spz 8188: <p>This means that the package will build using version 6.0
8189: of ImageMagick or newer. Such a dependency may be warranted
8190: if, for example, the command line options of an executable
8191: have changed.</p>
8192: <p>If you need to depend on minimum versions of libraries,
8193: see the buildlink section of the pkgsrc guide.</p>
1.1 dsieger 8194: <p>For security fixes, please update the package
1.10 hubertf 8195: 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.1 dsieger 8196: information.</p>
8197: </li>
8198: </ol></div>
8199: <p>If your package needs files from another package to build,
8200: add the relevant distribution files to
8201: <code class="varname">DISTFILES</code>, so they will be extracted
8202: 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.
8203: (It relies on the jpeg sources being present in source form
8204: during the build.)</p>
8205: </div>
1.41 asau 8206: <div class="sect2">
1.1 dsieger 8207: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8208: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1 dsieger 8209: <p>Your package may conflict with other packages a user might
8210: already have installed on his system, e.g. if your package
8211: installs the same set of files as another package in the pkgsrc
8212: tree.</p>
8213: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8214: space-separated list of packages (including version string) your
8215: package conflicts with.</p>
8216: <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>
8217: 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>
8218: install the same shared library, thus you set in
8219: <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8220: <pre class="programlisting">
8221: CONFLICTS= Xaw-Xpm-[0-9]*
8222: </pre>
8223: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8224: <pre class="programlisting">
8225: CONFLICTS= Xaw3d-[0-9]*
8226: </pre>
8227: <p>Packages will automatically conflict with other packages
8228: with the name prefix and a different version
1.23 wiz 8229: string. <span class="quote">“<span class="quote">Xaw3d-1.5</span>”</span> e.g. will automatically
8230: conflict with the older version <span class="quote">“<span class="quote">Xaw3d-1.3</span>”</span>.</p>
1.1 dsieger 8231: </div>
1.41 asau 8232: <div class="sect2">
1.1 dsieger 8233: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8234: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1 dsieger 8235: <p>There are several reasons why a package might be
8236: instructed to not build under certain circumstances. If the
8237: package builds and runs on most platforms, the exceptions
8238: should be noted with <code class="varname">NOT_FOR_PLATFORM</code>. If
8239: the package builds and runs on a small handful of platforms,
8240: set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8241: Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8242: <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8243: (OS-version-platform) that can use glob-style
8244: wildcards.</p>
8245: <p>Some packages are tightly bound to a specific version of an
8246: 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
8247: backwards compatible with other versions of the OS, and should be
8248: uploaded to a version specific directory on the FTP server. Mark
8249: these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23 wiz 8250: <span class="quote">“<span class="quote">yes</span>”</span>. This variable is not currently used by any of
1.1 dsieger 8251: the package system internals, but may be used in the
8252: future.</p>
8253: <p>If the package should be skipped (for example, because it
8254: provides functionality already provided by the system), set
8255: <code class="varname">PKG_SKIP_REASON</code> to a descriptive message. If
8256: the package should fail because some preconditions are not met,
8257: set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8258: message.</p>
8259: </div>
1.41 asau 8260: <div class="sect2">
1.1 dsieger 8261: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8262: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1 dsieger 8263: <p>To ensure that a package may not be deleted, once it has been
8264: installed, the <code class="varname">PKG_PRESERVE</code> definition should
8265: be set in the package Makefile. This will be carried into any
8266: binary package that is made from this pkgsrc entry. A
1.23 wiz 8267: <span class="quote">“<span class="quote">preserved</span>”</span> package will
1.29 dholland 8268: not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23 wiz 8269: <span class="quote">“<span class="quote">-f</span>”</span> option is used.</p>
1.1 dsieger 8270: </div>
1.41 asau 8271: <div class="sect2">
1.1 dsieger 8272: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8273: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1 dsieger 8274: <p>When a vulnerability is found, this should be noted in
8275: <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31 wiz 8276: and after committing that file, ask pkgsrc-security@NetBSD.org to
8277: update the file on ftp.NetBSD.org.</p>
1.1 dsieger 8278: <p>After fixing the vulnerability by a patch, its
1.31 wiz 8279: <code class="varname">PKGREVISION</code> should be increased (this is of
8280: course not necessary if the problem is fixed by using a newer
8281: release of the software), and the pattern in the
8282: pkg-vulnerabilities file must be updated.</p>
1.1 dsieger 8283: <p>Also, if the fix should be applied to the stable pkgsrc
8284: branch, be sure to submit a pullup request!</p>
8285: <p>Binary packages already on ftp.NetBSD.org will be handled
8286: semi-automatically by a weekly cron job.</p>
8287: </div>
1.41 asau 8288: <div class="sect2">
1.1 dsieger 8289: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8290: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1 dsieger 8291: <p>When making fixes to an existing package it can be useful
8292: to change the version number in <code class="varname">PKGNAME</code>. To
8293: avoid conflicting with future versions by the original author, a
1.23 wiz 8294: <span class="quote">“<span class="quote">nb1</span>”</span>, <span class="quote">“<span class="quote">nb2</span>”</span>, ... suffix can be used
1.1 dsieger 8295: on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23 wiz 8296: (2, ...). The <span class="quote">“<span class="quote">nb</span>”</span> is treated like a
8297: <span class="quote">“<span class="quote">.</span>”</span> by the package tools. e.g.</p>
1.1 dsieger 8298: <pre class="programlisting">
8299: DISTNAME= foo-17.42
8300: PKGREVISION= 9
8301: </pre>
8302: <p>will result in a <code class="varname">PKGNAME</code> of
1.23 wiz 8303: <span class="quote">“<span class="quote">foo-17.42nb9</span>”</span>. If you want to use the original
8304: value of <code class="varname">PKGNAME</code> without the <span class="quote">“<span class="quote">nbX</span>”</span>
1.1 dsieger 8305: suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8306: <code class="varname">PKGNAME_NOREV</code>.</p>
8307: <p>When a new release of the package is released, the
8308: <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8309: minor release of the above package, things should be like:</p>
8310: <pre class="programlisting">
8311: DISTNAME= foo-17.43
8312: </pre>
8313: <p><code class="varname">PKGREVISION</code> should be incremented for any
8314: non-trivial change in the resulting binary package. Without a
8315: <code class="varname">PKGREVISION</code> bump, someone with the previous
8316: version installed has no way of knowing that their package is out
8317: of date. Thus, changes without increasing
8318: <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8319: trivial that no reasonable person would want to upgrade", and this
8320: is the rough test for when increasing
8321: <code class="varname">PKGREVISION</code> is appropriate. Examples of
8322: changes that do not merit increasing
8323: <code class="varname">PKGREVISION</code> are:</p>
1.41 asau 8324: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8325: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14 jmcneill 8326: <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1 dsieger 8327: or comments in Makefile.</p></li>
1.23 wiz 8328: <li class="listitem"><p>
1.1 dsieger 8329: Changing build variables if the resulting binary package is the same.</p></li>
1.23 wiz 8330: <li class="listitem"><p>
1.1 dsieger 8331: Changing <code class="filename">DESCR</code>.</p></li>
1.23 wiz 8332: <li class="listitem"><p>
1.1 dsieger 8333: Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8334: </ul></div>
8335: <p>Examples of changes that do merit an increase to
8336: <code class="varname">PKGREVISION</code> include:</p>
1.41 asau 8337: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8338: <li class="listitem"><p>
1.1 dsieger 8339: Security fixes</p></li>
1.23 wiz 8340: <li class="listitem"><p>
1.1 dsieger 8341: Changes or additions to a patch file</p></li>
1.23 wiz 8342: <li class="listitem"><p>
1.1 dsieger 8343: Changes to the <code class="filename">PLIST</code></p></li>
1.23 wiz 8344: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1 dsieger 8345: </ul></div>
8346: <p>PKGREVISION must also be incremented when dependencies have ABI
8347: changes.</p>
8348: </div>
1.41 asau 8349: <div class="sect2">
1.1 dsieger 8350: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8351: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1 dsieger 8352: <p>When you want to replace the same text in multiple files
8353: or when the replacement text varies, patches alone cannot help.
8354: This is where the SUBST framework comes in. It provides an
8355: easy-to-use interface for replacing text in files.
8356: Example:</p>
8357: <pre class="programlisting">
8358: SUBST_CLASSES+= fix-paths
8359: SUBST_STAGE.fix-paths= pre-configure
8360: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
8361: SUBST_FILES.fix-paths= src/*.c
8362: SUBST_FILES.fix-paths+= scripts/*.sh
8363: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
8364: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
8365: </pre>
8366: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8367: that are used to identify the different SUBST blocks that are
8368: defined. The SUBST framework is heavily used by pkgsrc, so it is
8369: important to always use the <code class="literal">+=</code> operator with
8370: this variable. Otherwise some substitutions may be
8371: skipped.</p>
8372: <p>The remaining variables of each SUBST block are
8373: parameterized with the identifier from the first line
8374: (<code class="literal">fix-paths</code> in this case.) They can be seen as
8375: parameters to a function call.</p>
8376: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8377: which the replacement will take place. All combinations of
8378: <code class="literal">pre-</code>, <code class="literal">do-</code> and
8379: <code class="literal">post-</code> together with a phase name are
8380: possible, though only few are actually used. Most commonly used
8381: are <code class="literal">post-patch</code> and
8382: <code class="literal">pre-configure</code>. Of these two,
8383: <code class="literal">pre-configure</code> should be preferred because
1.10 hubertf 8384: then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1 dsieger 8385: have the state after applying the patches but before making any
8386: other changes. This is especially useful when you are debugging
8387: a package in order to create new patches for it. Similarly,
8388: <code class="literal">post-build</code> is preferred over
8389: <code class="literal">pre-install</code>, because the install phase should
8390: generally be kept as simple as possible. When you use
8391: <code class="literal">post-build</code>, you have the same files in the
8392: working directory that will be installed later, so you can check
8393: if the substitution has succeeded.</p>
8394: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8395: that is printed just before the substitution is done.</p>
8396: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8397: globbing patterns that specifies the files in which the
8398: substitution will take place. The patterns are interpreted
8399: relatively to the <code class="varname">WRKSRC</code> directory.</p>
8400: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.29 dholland 8401: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1 dsieger 8402: command should be prefixed with <code class="literal">-e</code>, so that
8403: all SUBST blocks look uniform.</p>
8404: <p>There are some more variables, but they are so seldomly
8405: used that they are only documented in the
8406: <code class="filename">mk/subst.mk</code> file.</p>
8407: </div>
8408: </div>
1.41 asau 8409: <div class="sect1">
1.1 dsieger 8410: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8411: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41 asau 8412: <div class="sect2">
1.1 dsieger 8413: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8414: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1 dsieger 8415: <p>If you need to download from a dynamic URL you can set
1.10 hubertf 8416: <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1 dsieger 8417: fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8418: with the name of each file to download as an argument, expecting
8419: it to output the URL of the directory from which to download
8420: 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
8421: example of this usage.</p>
8422: <p>If the download can't be automated, because the user must
8423: submit personal information to apply for a password, or must pay
8424: for the source, or whatever, you can set
8425: <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8426: displayed to the user before aborting the build. Example:</p>
8427: <pre class="programlisting">
8428: FETCH_MESSAGE= "Please download the files"
8429: FETCH_MESSAGE+= " "${DISTFILES:Q}
8430: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8431: </pre>
8432: </div>
1.41 asau 8433: <div class="sect2">
1.1 dsieger 8434: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8435: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1 dsieger 8436: <p>Sometimes authors of a software package make some
8437: modifications after the software was released, and they put up a
8438: new distfile without changing the package's version number. If a
8439: package is already in pkgsrc at that time, the checksum will
8440: no longer match. The contents of the new distfile should be
8441: compared against the old one before changing anything, to make
8442: sure the distfile was really updated on purpose, and that
8443: no trojan horse or so crept in.
8444: Please mention that the distfiles were compared and what was found
1.53 rodent 8445: in your commit message.</p>
8446: <p>Then, the correct way to work around this is to
1.1 dsieger 8447: set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8448: usually based on <code class="varname">PKGNAME_NOREV</code>. All
8449: <code class="varname">DISTFILES</code> and
8450: <code class="varname">PATCHFILES</code> for this package will be put in that
8451: subdirectory of the local distfiles directory.
1.10 hubertf 8452: (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.1 dsieger 8453: In case this
8454: happens more often, <code class="varname">PKGNAME</code> can be used (thus
8455: including the <code class="filename">nbX</code> suffix) or a date stamp
1.53 rodent 8456: can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
8457: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
8458: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1 dsieger 8459: after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8460: path in the filenames.
1.53 rodent 8461: Also, increase the PKGREVISION if the installed package is different.
1.1 dsieger 8462: Furthermore, a mail to the package's authors seems appropriate
8463: telling them that changing distfiles after releases without
8464: changing the file names is not good practice.</p>
8465: </div>
8466: </div>
1.41 asau 8467: <div class="sect1">
1.1 dsieger 8468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8469: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41 asau 8470: <div class="sect2">
1.1 dsieger 8471: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8472: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1 dsieger 8473: <p>pkgsrc supports many different machines, with different
8474: object formats like a.out and ELF, and varying abilities to do
8475: shared library and dynamic loading at all. To accompany this,
8476: varying commands and options have to be passed to the
8477: compiler, linker, etc. to get the Right Thing, which can be
8478: pretty annoying especially if you don't have all the machines
8479: at your hand to test things. The
8480: <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.23 wiz 8481: can help here, as it just <span class="quote">“<span class="quote">knows</span>”</span> how to build
1.1 dsieger 8482: both static and dynamic libraries from a set of source files,
8483: thus being platform-independent.</p>
8484: <p>Here's how to use libtool in a package in seven simple
8485: steps:</p>
1.23 wiz 8486: <div class="orderedlist"><ol class="orderedlist" type="1">
8487: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1 dsieger 8488: Makefile.</p></li>
1.23 wiz 8489: <li class="listitem"><p>For library objects, use <span class="quote">“<span class="quote">${LIBTOOL} --mode=compile
8490: ${CC}</span>”</span> in place of <span class="quote">“<span class="quote">${CC}</span>”</span>. You could even
1.1 dsieger 8491: add it to the definition of <code class="varname">CC</code>, if only
8492: libraries are being built in a given Makefile. This one command
8493: will build both PIC and non-PIC library objects, so you need not
8494: have separate shared and non-shared library rules.</p></li>
1.23 wiz 8495: <li class="listitem">
1.1 dsieger 8496: <p>For the linking of the library, remove any
1.23 wiz 8497: <span class="quote">“<span class="quote">ar</span>”</span>, <span class="quote">“<span class="quote">ranlib</span>”</span>, and <span class="quote">“<span class="quote">ld
8498: -Bshareable</span>”</span> commands, and instead use:</p>
1.1 dsieger 8499: <pre class="programlisting">
8500: ${LIBTOOL} --mode=link \
8501: ${CC} -o ${.TARGET:.a=.la} \
8502: ${OBJS:.o=.lo} \
8503: -rpath ${PREFIX}/lib \
8504: -version-info major:minor
8505: </pre>
8506: <p>Note that the library is changed to have a
8507: <code class="filename">.la</code> extension, and the objects are
8508: changed to have a <code class="filename">.lo</code>
8509: extension. Change <code class="varname">OBJS</code> as
8510: necessary. This automatically creates all of the
8511: <code class="filename">.a</code>,
8512: <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8513: necessary) in the build directory. Be sure to include
1.23 wiz 8514: <span class="quote">“<span class="quote">-version-info</span>”</span>, especially when major and
1.1 dsieger 8515: minor are zero, as libtool will otherwise strip off the
8516: shared library version.</p>
8517: <p>From the libtool manual:</p>
8518: <pre class="programlisting">
8519: So, libtool library versions are described by three integers:
8520:
8521: CURRENT
8522: The most recent interface number that this library implements.
8523:
8524: REVISION
8525: The implementation number of the CURRENT interface.
8526:
8527: AGE
8528: The difference between the newest and oldest interfaces that
8529: this library implements. In other words, the library implements
8530: all the interface numbers in the range from number `CURRENT -
8531: AGE' to `CURRENT'.
8532:
8533: If two libraries have identical CURRENT and AGE numbers, then the
8534: dynamic linker chooses the library with the greater REVISION number.
8535: </pre>
1.23 wiz 8536: <p>The <span class="quote">“<span class="quote">-release</span>”</span> option will produce
1.1 dsieger 8537: different results for a.out and ELF (excluding symlinks)
8538: in only one case. An ELF library of the form
1.23 wiz 8539: <span class="quote">“<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8540: will have a symlink of
1.23 wiz 8541: <span class="quote">“<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>”</span>
1.1 dsieger 8542: on an a.out platform. This is handled
8543: automatically.</p>
1.23 wiz 8544: <p>The <span class="quote">“<span class="quote">-rpath argument</span>”</span> is the install
1.1 dsieger 8545: directory of the library being built.</p>
8546: <p>In the <code class="filename">PLIST</code>, include only the
8547: <code class="filename">.la</code> file, the other files will be
8548: added automatically.</p>
8549: </li>
1.23 wiz 8550: <li class="listitem">
1.1 dsieger 8551: <p>When linking shared object (<code class="filename">.so</code>)
1.29 dholland 8552: files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23 wiz 8553: shared libraries, use <span class="quote">“<span class="quote">-module
8554: -avoid-version</span>”</span> to prevent them getting version
1.1 dsieger 8555: tacked on.</p>
8556: <p>The <code class="filename">PLIST</code> file gets the
8557: <code class="filename">foo.so</code> entry.</p>
8558: </li>
1.23 wiz 8559: <li class="listitem">
1.1 dsieger 8560: <p>When linking programs that depend on these libraries
8561: <span class="emphasis"><em>before</em></span> they are installed, preface
1.29 dholland 8562: the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8563: --mode=link</span>”</span>, and it will find the correct
1.1 dsieger 8564: libraries (static or shared), but please be aware that
8565: libtool will not allow you to specify a relative path in
1.23 wiz 8566: -L (such as <span class="quote">“<span class="quote">-L../somelib</span>”</span>), because it
1.1 dsieger 8567: expects you to change that argument to be the
8568: <code class="filename">.la</code> file. e.g.</p>
8569: <pre class="programlisting">
8570: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8571: </pre>
8572: <p>should be changed to:</p>
8573: <pre class="programlisting">
8574: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8575: </pre>
8576: <p>and it will do the right thing with the libraries.</p>
8577: </li>
1.23 wiz 8578: <li class="listitem">
1.29 dholland 8579: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
8580: or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">“<span class="quote">${LIBTOOL}
1.23 wiz 8581: --mode=install</span>”</span>, and change the library name to
1.1 dsieger 8582: <code class="filename">.la</code>. e.g.</p>
8583: <pre class="programlisting">
1.22 jakllsch 8584: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 8585: </pre>
8586: <p>This will install the static <code class="filename">.a</code>,
8587: shared library, any needed symlinks, and run
1.29 dholland 8588: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1 dsieger 8589: </li>
1.23 wiz 8590: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1 dsieger 8591: the <code class="filename">.la</code>
8592: file (this is a change from previous behaviour).</p></li>
8593: </ol></div>
8594: </div>
1.41 asau 8595: <div class="sect2">
1.1 dsieger 8596: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8597: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1 dsieger 8598: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8599: package Makefile. This will override the package's own libtool
8600: in most cases. For older libtool using packages, libtool is
8601: made by ltconfig script during the do-configure step; you can
1.10 hubertf 8602: check the libtool script location by doing <span class="command"><strong>make
1.1 dsieger 8603: configure; find work*/ -name libtool</strong></span>.</p>
8604: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8605: scripts, relative to <code class="varname">WRKSRC</code>, to override. By
1.23 wiz 8606: default, it is set to <span class="quote">“<span class="quote">libtool */libtool
8607: */*/libtool</span>”</span>. If this does not match the location of the
1.1 dsieger 8608: package's libtool script(s), set it as appropriate.</p>
8609: <p>If you do not need <code class="filename">*.a</code> static
8610: libraries built and installed, then use
8611: <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8612: <p>If your package makes use of the platform-independent library
8613: for loading dynamic shared objects, that comes with libtool
8614: (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8615: <p>Some packages use libtool incorrectly so that the package
8616: may not work or build in some circumstances. Some of the more
8617: common errors are:</p>
1.41 asau 8618: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8619: <li class="listitem">
1.1 dsieger 8620: <p>The inclusion of a shared object (-module) as a dependent library in an
8621: executable or library. This in itself isn't a problem if one of two things
8622: has been done:</p>
1.23 wiz 8623: <div class="orderedlist"><ol class="orderedlist" type="1">
8624: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1 dsieger 8625: <code class="filename">libfoo.la</code>, not
8626: <code class="filename">foo.la</code></p></li>
1.23 wiz 8627: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1 dsieger 8628: </ol></div>
8629: </li>
1.23 wiz 8630: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1 dsieger 8631: The function lt_dlinit() should be called and the macro
8632: <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8633: executables.</p></li>
8634: </ul></div>
8635: </div>
1.41 asau 8636: <div class="sect2">
1.1 dsieger 8637: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8638: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1 dsieger 8639: <p>If a package needs GNU autoconf or automake to be executed
8640: to regenerate the configure script and Makefile.in makefile
8641: templates, then they should be executed in a pre-configure
8642: target.</p>
8643: <p>For packages that need only autoconf:</p>
8644: <pre class="programlisting">
8645: AUTOCONF_REQD= 2.50 # if default version is not good enough
8646: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
8647: ...
8648:
8649: pre-configure:
8650: cd ${WRKSRC} && autoconf
8651:
8652: ...
8653: </pre>
8654: <p>and for packages that need automake and autoconf:</p>
8655: <pre class="programlisting">
8656: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
8657: USE_TOOLS+= automake # use "automake14" for automake-1.4
8658: ...
8659:
8660: pre-configure:
8661: set -e; cd ${WRKSRC}; \
8662: aclocal; autoheader; automake -a --foreign -i; autoconf
8663:
8664: ...
8665: </pre>
8666: <p>Packages which use GNU Automake will almost certainly
8667: require GNU Make.</p>
8668: <p>There are times when the configure process makes
8669: additional changes to the generated files, which then causes
8670: the build process to try to re-execute the automake sequence.
8671: This is prevented by touching various files in the configure
8672: stage. If this causes problems with your package you can set
8673: <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8674: Makefile.</p>
8675: </div>
8676: </div>
1.41 asau 8677: <div class="sect1">
1.1 dsieger 8678: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8679: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41 asau 8680: <div class="sect2">
1.1 dsieger 8681: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8682: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1 dsieger 8683: <p>Compilers for the C, C++, and Fortran languages comes with
8684: the NetBSD base system. By default, pkgsrc assumes that a package
8685: is written in C and will hide all other compilers (via the wrapper
1.10 hubertf 8686: framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1 dsieger 8687: <p>To declare which language's compiler a package needs, set
8688: the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23 wiz 8689: currently are <span class="quote">“<span class="quote">c</span>”</span>, <span class="quote">“<span class="quote">c++</span>”</span>, and
8690: <span class="quote">“<span class="quote">fortran</span>”</span> (and any combination). The default is
8691: <span class="quote">“<span class="quote">c</span>”</span>. Packages using GNU configure scripts, even if
1.1 dsieger 8692: written in C++, usually need a C compiler for the configure
8693: phase.</p>
8694: </div>
1.41 asau 8695: <div class="sect2">
1.1 dsieger 8696: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8697: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1 dsieger 8698: <p>If a program is written in Java, use the Java framework in
8699: pkgsrc. The package must include
8700: <code class="filename">../../mk/java-vm.mk</code>. This Makefile fragment
8701: provides the following variables:</p>
1.41 asau 8702: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 8703: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1 dsieger 8704: dependency on the JDK is added. If
1.23 wiz 8705: <code class="varname">USE_JAVA</code> is set to <span class="quote">“<span class="quote">run</span>”</span>, then
1.1 dsieger 8706: there is only a runtime dependency on the JDK. The default is
1.23 wiz 8707: <span class="quote">“<span class="quote">yes</span>”</span>, which also adds a build dependency on the
1.1 dsieger 8708: JDK.</p></li>
1.23 wiz 8709: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1 dsieger 8710: a package needs a Java2 implementation. The supported values
1.23 wiz 8711: are <span class="quote">“<span class="quote">yes</span>”</span>, <span class="quote">“<span class="quote">1.4</span>”</span>, and
8712: <span class="quote">“<span class="quote">1.5</span>”</span>. <span class="quote">“<span class="quote">yes</span>”</span> accepts any Java2
8713: implementation, <span class="quote">“<span class="quote">1.4</span>”</span> insists on versions 1.4 or
8714: above, and <span class="quote">“<span class="quote">1.5</span>”</span> only accepts versions 1.5 or
1.1 dsieger 8715: above. This variable is not set by default.</p></li>
1.24 wiz 8716: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8717: automatically set to the runtime location of the used Java
8718: implementation dependency. It may be used to set
8719: <code class="varname">JAVA_HOME</code> to a good value if the program
8720: needs this variable to be defined.
8721: </p></li>
1.1 dsieger 8722: </ul></div>
8723: </div>
1.41 asau 8724: <div class="sect2">
1.1 dsieger 8725: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8726: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1 dsieger 8727: <p>If your package contains interpreted perl scripts, add
1.23 wiz 8728: <span class="quote">“<span class="quote">perl</span>”</span> to the <code class="varname">USE_TOOLS</code> variable
1.1 dsieger 8729: and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8730: interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8731: contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8732: that you want adjusted. Every occurrence of
8733: <code class="filename">*/bin/perl</code> will be replaced with the full
8734: path to the perl executable.</p>
8735: <p>If a particular version of perl is needed, set the
8736: <code class="varname">PERL5_REQD</code> variable to the version number. The
1.23 wiz 8737: default is <span class="quote">“<span class="quote">5.0</span>”</span>.</p>
1.10 hubertf 8738: <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.1 dsieger 8739: about handling perl modules.</p>
8740: </div>
1.41 asau 8741: <div class="sect2">
1.1 dsieger 8742: <div class="titlepage"><div><div><h3 class="title">
1.40 wiz 8743: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
8744: <p><code class="varname">REPLACE_SH</code>,
8745: <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
8746: and <code class="varname">REPLACE_KSH</code> can be used to replace shell
8747: hash bangs in files. Please use the appropriate one, prefering
8748: <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
8749: When using <code class="varname">REPLACE_BASH</code>, don't forget to add
8750: <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
8751: </div>
1.41 asau 8752: <div class="sect2">
1.40 wiz 8753: <div class="titlepage"><div><div><h3 class="title">
8754: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1 dsieger 8755: <p>Currently, there is no special handling for other languages
8756: in pkgsrc. If a compiler package provides a
8757: <code class="filename">buildlink3.mk</code> file, include that, otherwise
8758: just add a (build) dependency on the appropriate compiler
8759: package.</p>
8760: </div>
8761: </div>
1.41 asau 8762: <div class="sect1">
1.1 dsieger 8763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8764: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1 dsieger 8765: <p>The most common failures when building a package are that
8766: some platforms do not provide certain header files, functions or
8767: libraries, or they provide the functions in a library that the
8768: original package author didn't know. To work around this, you
8769: can rewrite the source code in most cases so that it does not
8770: use the missing functions or provides a replacement function.</p>
1.41 asau 8771: <div class="sect2">
1.1 dsieger 8772: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8773: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1 dsieger 8774: <p>If a package already comes with a GNU configure script, the
8775: preferred way to fix the build failure is to change the
8776: configure script, not the code. In the other cases, you can
8777: utilize the C preprocessor, which defines certain macros
8778: depending on the operating system and hardware architecture it
8779: compiles for. These macros can be queried using for example
8780: <code class="varname">#if defined(__i386)</code>. Almost every operating
8781: system, hardware architecture and compiler has its own macro.
8782: For example, if the macros <code class="varname">__GNUC__</code>,
8783: <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8784: are all defined, you know that you are using NetBSD on an i386
8785: compatible CPU, and your compiler is GCC.</p>
8786: <p>The list of the following macros for hardware and
8787: operating system depends on the compiler that is used. For
8788: example, if you want to conditionally compile code on Solaris,
8789: don't use <code class="varname">__sun__</code>, as the SunPro compiler
8790: does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41 asau 8791: <div class="sect3">
1.1 dsieger 8792: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8793: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1 dsieger 8794: <p>To distinguish between 4.4 BSD-derived systems and the
8795: rest of the world, you should use the following code.</p>
8796: <pre class="programlisting">
8797: #include <sys/param.h>
8798: #if (defined(BSD) && BSD >= 199306)
8799: /* BSD-specific code goes here */
8800: #else
8801: /* non-BSD-specific code goes here */
8802: #endif
8803: </pre>
8804: <p>If this distinction is not fine enough, you can also test
8805: for the following macros.</p>
8806: <pre class="programlisting">
1.45 obache 8807: Cygwin __CYGWIN__
8808: DragonFly __DragonFly__
1.1 dsieger 8809: FreeBSD __FreeBSD__
1.45 obache 8810: Haiku __HAIKU__
1.1 dsieger 8811: Interix __INTERIX
8812: IRIX __sgi (TODO: get a definite source for this)
8813: Linux linux, __linux, __linux__
1.45 obache 8814: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
8815: Minix3 __minix
1.1 dsieger 8816: NetBSD __NetBSD__
8817: OpenBSD __OpenBSD__
8818: Solaris sun, __sun
8819: </pre>
8820: </div>
1.41 asau 8821: <div class="sect3">
1.1 dsieger 8822: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8823: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1 dsieger 8824: <pre class="programlisting">
8825: i386 i386, __i386, __i386__
8826: MIPS __mips
8827: SPARC sparc, __sparc
8828: </pre>
8829: </div>
1.41 asau 8830: <div class="sect3">
1.1 dsieger 8831: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8832: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1 dsieger 8833: <pre class="programlisting">
8834: GCC __GNUC__ (major version), __GNUC_MINOR__
8835: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8836: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
8837: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
8838: </pre>
8839: </div>
8840: </div>
1.41 asau 8841: <div class="sect2">
1.1 dsieger 8842: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8843: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1 dsieger 8844: <p>Some source files trigger bugs in the compiler, based on
8845: combinations of compiler version and architecture and almost
8846: always relation to optimisation being enabled. Common symptoms
8847: are gcc internal errors or never finishing compiling a
8848: file.</p>
8849: <p>Typically, a workaround involves testing the
8850: <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8851: optimisation for that combination of file,
8852: <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8853: in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8854: number of examples.</p>
8855: </div>
1.41 asau 8856: <div class="sect2">
1.1 dsieger 8857: <div class="titlepage"><div><div><h3 class="title">
1.23 wiz 8858: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">“<span class="quote">...</span>”</span>
8859: </h3></div></div></div>
1.1 dsieger 8860: <p>This error message often means that a package did not
8861: link to a shared library it needs. The following functions are
8862: known to cause this error message over and over.</p>
8863: <div class="informaltable">
8864: <a name="undefined-reference-functions"></a><table border="1">
8865: <colgroup>
8866: <col>
8867: <col>
8868: <col>
8869: </colgroup>
8870: <thead><tr>
8871: <th>Function</th>
8872: <th>Library</th>
8873: <th>Affected platforms</th>
8874: </tr></thead>
8875: <tbody>
8876: <tr>
8877: <td>accept, bind, connect</td>
8878: <td>-lsocket</td>
8879: <td>Solaris</td>
8880: </tr>
8881: <tr>
8882: <td>crypt</td>
8883: <td>-lcrypt</td>
8884: <td>DragonFly, NetBSD</td>
8885: </tr>
8886: <tr>
8887: <td>dlopen, dlsym</td>
8888: <td>-ldl</td>
8889: <td>Linux</td>
8890: </tr>
8891: <tr>
8892: <td>gethost*</td>
8893: <td>-lnsl</td>
8894: <td>Solaris</td>
8895: </tr>
8896: <tr>
8897: <td>inet_aton</td>
8898: <td>-lresolv</td>
8899: <td>Solaris</td>
8900: </tr>
8901: <tr>
8902: <td>nanosleep, sem_*, timer_*</td>
8903: <td>-lrt</td>
8904: <td>Solaris</td>
8905: </tr>
8906: <tr>
8907: <td>openpty</td>
8908: <td>-lutil</td>
8909: <td>Linux</td>
8910: </tr>
8911: </tbody>
8912: </table>
8913: </div>
8914: <p>To fix these linker errors, it is often sufficient to say
8915: <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8916: -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10 hubertf 8917: <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1 dsieger 8918: bmake</strong></span>.</p>
1.41 asau 8919: <div class="sect3">
1.1 dsieger 8920: <div class="titlepage"><div><div><h4 class="title">
1.6 rillig 8921: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1 dsieger 8922: <p>When you are using the SunPro compiler, there is another
8923: possibility. That compiler cannot handle the following code:</p>
8924: <pre class="programlisting">
8925: extern int extern_func(int);
8926:
8927: static inline int
8928: inline_func(int x)
8929: {
8930: return extern_func(x);
8931: }
8932:
8933: int main(void)
8934: {
8935: return 0;
8936: }
8937: </pre>
8938: <p>It generates the code for <code class="function">inline_func</code> even if
8939: that function is never used. This code then refers to
8940: <code class="function">extern_func</code>, which can usually not be resolved. To
8941: solve this problem you can try to tell the package to disable inlining
8942: of functions.</p>
8943: </div>
8944: </div>
1.41 asau 8945: <div class="sect2">
1.1 dsieger 8946: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8947: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1 dsieger 8948: <p>Sometimes packages fail to build because the compiler runs
8949: into an operating system specific soft limit. With the
8950: <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8951: to unlimit the resources. Currently, the allowed values are
1.23 wiz 8952: <span class="quote">“<span class="quote">datasize</span>”</span> and <span class="quote">“<span class="quote">stacksize</span>”</span> (or both).
1.1 dsieger 8953: Setting this variable is similar to running the shell builtin
1.10 hubertf 8954: <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1 dsieger 8955: segment size or maximum stack size of a process, respectively, to
8956: their hard limits.</p>
8957: </div>
8958: </div>
1.41 asau 8959: <div class="sect1">
1.1 dsieger 8960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 8961: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41 asau 8962: <div class="sect2">
1.1 dsieger 8963: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8964: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10 hubertf 8965: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1 dsieger 8966: with some operating systems cannot create more than one
8967: directory at a time. As such, you should call
8968: <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8969: <pre class="programlisting">
8970: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8971: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8972: </pre>
1.23 wiz 8973: <p>You can also just append <span class="quote">“<span class="quote"><code class="literal">dir1
8974: dir2</code></span>”</span> to the
1.1 dsieger 8975: <code class="varname">INSTALLATION_DIRS</code> variable, which will
8976: automatically do the right thing.</p>
8977: </div>
1.41 asau 8978: <div class="sect2">
1.1 dsieger 8979: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 8980: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1 dsieger 8981: <p>In general, documentation should be installed into
8982: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8983: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8984: includes the version number of the package).</p>
8985: <p>Many modern packages using GNU autoconf allow to set the
8986: directory where HTML documentation is installed with the
1.23 wiz 8987: <span class="quote">“<span class="quote">--with-html-dir</span>”</span> option. Sometimes using this flag
1.1 dsieger 8988: is needed because otherwise the documentation ends up in
8989: <code class="filename">${PREFIX}/share/doc/html</code> or other
8990: places.</p>
8991: <p>An exception to the above is that library API documentation
8992: 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
8993: browsers (devhelp) should be left at their default location, which
8994: is <code class="filename">${PREFIX}/share/gtk-doc</code>. Such
8995: documentation can be recognized from files ending in
8996: <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8997: (It is also acceptable to install such files in
8998: <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8999: <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
9000: <code class="filename">.devhelp*</code> file must be directly in that
9001: directory then, no additional subdirectory level is allowed in
9002: this case. This is usually achieved by using
1.23 wiz 9003: <span class="quote">“<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>”</span>.
1.1 dsieger 9004: <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
9005: though.)</p>
9006: </div>
1.41 asau 9007: <div class="sect2">
1.1 dsieger 9008: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9009: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1 dsieger 9010: <p>Certain packages, most of them in the games category, install
9011: a score file that allows all users on the system to record their
9012: highscores. In order for this to work, the binaries need to be
9013: installed setgid and the score files owned by the appropriate
1.35 wiz 9014: group and/or owner (traditionally the "games" user/group). Set
9015: <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1 dsieger 9016: following variables, documented in more detail in
9017: <code class="filename">mk/defaults/mk.conf</code>, control this
1.35 wiz 9018: behaviour: <code class="varname">GAMEDATAMODE</code>,
9019: <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
9020: <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
1.14 jmcneill 9021: <p>A package should therefore never hard code file ownership or
1.1 dsieger 9022: access permissions but rely on <code class="varname">INSTALL_GAME</code> and
9023: <code class="varname">INSTALL_GAME_DATA</code> to set these
9024: correctly.</p>
9025: </div>
1.41 asau 9026: <div class="sect2">
1.1 dsieger 9027: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9028: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14 jmcneill 9029: <p><code class="varname">DESTDIR</code> support means that a package
9030: installs into a staging directory, not the final location of the
9031: files. Then a binary package is created which can be used for
9032: installation as usual. There are two ways: Either the package must
1.23 wiz 9033: install as root (<span class="quote">“<span class="quote">destdir</span>”</span>) or the package can
9034: install as non-root user (<span class="quote">“<span class="quote">user-destdir</span>”</span>).</p>
1.41 asau 9035: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9036: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.38 wiz 9037: set to <span class="quote">“<span class="quote">none</span>”</span>, <span class="quote">“<span class="quote">destdir</span>”</span>, or
9038: <span class="quote">“<span class="quote">user-destdir</span>”</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
9039: is set to <span class="quote">“<span class="quote">user-destdir</span>”</span> to help catching more
9040: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14 jmcneill 9041: <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
9042: the inclusion.</p></li>
1.23 wiz 9043: <li class="listitem"><p>All installation operations have to be prefixed with
1.4 rillig 9044: <code class="filename">${DESTDIR}</code>.</p></li>
1.23 wiz 9045: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4 rillig 9046: automatically. Many manual rules and pre/post-install often are
9047: incorrect; fix them.</p></li>
1.23 wiz 9048: <li class="listitem"><p>If files are installed with special owner/group
1.17 imil 9049: use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23 wiz 9050: <li class="listitem"><p>In general, packages should support
1.4 rillig 9051: <code class="varname">UNPRIVILEGED</code> to be able to use
9052: DESTDIR.</p></li>
9053: </ul></div>
9054: </div>
1.41 asau 9055: <div class="sect2">
1.4 rillig 9056: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9057: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1 dsieger 9058: <p>Your package may also contain scripts with hardcoded paths to
9059: other interpreters besides (or as well as) perl. To correct the
9060: full pathname to the script interpreter, you need to set the
9061: following definitions in your <code class="filename">Makefile</code> (we
1.10 hubertf 9062: shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1 dsieger 9063: <pre class="programlisting">
9064: REPLACE_INTERPRETER+= tcl
9065: REPLACE.tcl.old= .*/bin/tclsh
9066: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
9067: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
9068: # relative to ${WRKSRC}, just as in REPLACE_PERL
9069: </pre>
1.41 asau 9070: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9071: <h3 class="title">Note</h3>
9072: <p>Before March 2006, these variables were called
9073: <code class="varname">_REPLACE.*</code> and
9074: <code class="varname">_REPLACE_FILES.*</code>.</p>
9075: </div>
9076: </div>
1.41 asau 9077: <div class="sect2">
1.1 dsieger 9078: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9079: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1 dsieger 9080: <p>Makefiles of packages providing perl5 modules should include
9081: the Makefile fragment
9082: <code class="filename">../../lang/perl5/module.mk</code>. It provides a
1.10 hubertf 9083: <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1 dsieger 9084: configuration for such modules as well as various hooks to tune
9085: this configuration. See comments in this file for
9086: details.</p>
9087: <p>Perl5 modules will install into different places depending
9088: on the version of perl used during the build process. To
9089: address this, pkgsrc will append lines to the
9090: <code class="filename">PLIST</code> corresponding to the files listed in
9091: the installed <code class="filename">.packlist</code> file generated by
9092: most perl5 modules. This is invoked by defining
9093: <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47 wiz 9094: packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
9095: (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
9096: e.g.:</p>
1.1 dsieger 9097: <pre class="programlisting">
1.47 wiz 9098: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 9099: </pre>
1.47 wiz 9100: <p>The perl5 config variables
9101: <code class="varname">installarchlib</code>,
9102: <code class="varname">installscript</code>,
9103: <code class="varname">installvendorbin</code>,
9104: <code class="varname">installvendorscript</code>,
9105: <code class="varname">installvendorarch</code>,
9106: <code class="varname">installvendorlib</code>,
9107: <code class="varname">installvendorman1dir</code>, and
9108: <code class="varname">installvendorman3dir</code> represent those
9109: locations in which components of perl5 modules may be installed,
9110: provided as variable with uppercase and prefixed with
9111: <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
9112: and may be used by perl5 packages that don't have a packlist.
9113: These variables are also substituted for in the
9114: <code class="filename">PLIST</code> as uppercase prefixed with
9115: <code class="varname">PERL5_SUB_</code>.</p>
1.1 dsieger 9116: </div>
1.41 asau 9117: <div class="sect2">
1.1 dsieger 9118: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9119: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1 dsieger 9120: <p>Some packages install info files or use the
1.23 wiz 9121: <span class="quote">“<span class="quote">makeinfo</span>”</span> or <span class="quote">“<span class="quote">install-info</span>”</span>
1.1 dsieger 9122: commands. <code class="varname">INFO_FILES</code> should be defined in
9123: the package Makefile so that <code class="filename">INSTALL</code> and
9124: <code class="filename">DEINSTALL</code> scripts will be generated to
9125: handle registration of the info files in the Info directory
1.23 wiz 9126: file. The <span class="quote">“<span class="quote">install-info</span>”</span> command used for the info
1.1 dsieger 9127: files registration is either provided by the system, or by a
9128: special purpose package automatically added as dependency if
9129: needed.</p>
9130: <p><code class="varname">PKGINFODIR</code> is the directory under
9131: <code class="filename">${PREFIX}</code> where info files are primarily
9132: located. <code class="varname">PKGINFODIR</code> defaults to
1.23 wiz 9133: <span class="quote">“<span class="quote">info</span>”</span> and can be overridden by the user.</p>
1.1 dsieger 9134: <p>The info files for the package should be listed in the
9135: package <code class="filename">PLIST</code>; however any split info files
9136: need not be listed.</p>
1.23 wiz 9137: <p>A package which needs the <span class="quote">“<span class="quote">makeinfo</span>”</span> command
9138: at build time must add <span class="quote">“<span class="quote">makeinfo</span>”</span> to
1.1 dsieger 9139: <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23 wiz 9140: version of the <span class="quote">“<span class="quote">makeinfo</span>”</span> command is needed it
1.1 dsieger 9141: should be noted with the <code class="varname">TEXINFO_REQD</code>
9142: variable in the package <code class="filename">Makefile</code>. By
9143: default, a minimum version of 3.12 is required. If the system
1.10 hubertf 9144: does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1 dsieger 9145: does not match the required minimum, a build dependency on the
9146: <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
9147: be added automatically.</p>
9148: <p>The build and installation process of the software provided
9149: by the package should not use the
1.10 hubertf 9150: <span class="command"><strong>install-info</strong></span> command as the registration of
1.1 dsieger 9151: info files is the task of the package
9152: <code class="filename">INSTALL</code> script, and it must use the
1.10 hubertf 9153: appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1 dsieger 9154: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10 hubertf 9155: overriding scripts for the <span class="command"><strong>install-info</strong></span> and
9156: <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1 dsieger 9157: in <code class="varname">PATH</code>.</p>
1.10 hubertf 9158: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1 dsieger 9159: no effect except the logging of a message. The script overriding
1.10 hubertf 9160: <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1 dsieger 9161: value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10 hubertf 9162: <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1 dsieger 9163: </div>
1.41 asau 9164: <div class="sect2">
1.1 dsieger 9165: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9166: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1 dsieger 9167: <p>All packages that install manual pages should install them
9168: into the same directory, so that there is one common place to look
9169: for them. In pkgsrc, this place is
9170: <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
9171: should be used in packages. The default for
9172: <code class="varname">PKGMANDIR</code> is
1.23 wiz 9173: <span class="quote">“<span class="quote"><code class="filename">man</code></span>”</span>. Another often-used value
9174: is <span class="quote">“<span class="quote"><code class="filename">share/man</code></span>”</span>.</p>
1.41 asau 9175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9176: <h3 class="title">Note</h3>
9177: <p>The support for a custom <code class="varname">PKGMANDIR</code>
9178: is far from complete.</p>
9179: </div>
9180: <p>The <code class="filename">PLIST</code> files can just use
9181: <code class="filename">man/</code> as the top level directory for the man
9182: page file entries, and the pkgsrc framework will convert as
9183: needed. In all other places, the correct
9184: <code class="varname">PKGMANDIR</code> must be used.</p>
9185: <p>Packages that are
9186: configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23 wiz 9187: <span class="quote">“<span class="quote">yes</span>”</span>, by default will use the
1.1 dsieger 9188: <code class="filename">./configure</code>
9189: --mandir switch to set where the man pages should be installed.
9190: The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
9191: to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
9192: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
9193: use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23 wiz 9194: to <span class="quote">“<span class="quote">no</span>”</span>.
1.1 dsieger 9195: Or if the <code class="filename">./configure</code> script uses
9196: a non-standard use of --mandir, you can set
9197: <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10 hubertf 9198: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, “Man page compression”</a> for
1.1 dsieger 9199: information on installation of compressed manual pages.</p>
9200: </div>
1.41 asau 9201: <div class="sect2">
1.1 dsieger 9202: <div class="titlepage"><div><div><h3 class="title">
1.7 rillig 9203: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1 dsieger 9204: <p>If a package installs <code class="filename">.schemas</code> or
1.7 rillig 9205: <code class="filename">.entries</code> files, used by GConf,
1.1 dsieger 9206: you need to take some extra steps to make sure they get registered
9207: in the database:</p>
1.23 wiz 9208: <div class="orderedlist"><ol class="orderedlist" type="1">
9209: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1 dsieger 9210: instead of its <code class="filename">buildlink3.mk</code> file. This
1.7 rillig 9211: takes care of rebuilding the GConf database at installation and
1.1 dsieger 9212: deinstallation time, and tells the package where to install
1.7 rillig 9213: GConf data files using some standard configure arguments. It
1.1 dsieger 9214: also disallows any access to the database directly from the
9215: package.</p></li>
1.23 wiz 9216: <li class="listitem"><p>Ensure that the package installs its
1.1 dsieger 9217: <code class="filename">.schemas</code> files under
9218: <code class="filename">${PREFIX}/share/gconf/schemas</code>. If they get
9219: installed under <code class="filename">${PREFIX}/etc</code>, you will
9220: need to manually patch the package.</p></li>
1.23 wiz 9221: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1 dsieger 9222: directory, as they will be handled automatically. See
1.10 hubertf 9223: <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.23 wiz 9224: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1 dsieger 9225: your <code class="filename">Makefile</code> with a list of all
9226: <code class="filename">.schemas</code> files installed by the package, if
9227: any. Names must not contain any directories in them.</p></li>
1.23 wiz 9228: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1 dsieger 9229: your <code class="filename">Makefile</code> with a
9230: list of all <code class="filename">.entries</code> files installed by the
9231: package, if any. Names must not contain any directories in
9232: them.</p></li>
9233: </ol></div>
9234: </div>
1.41 asau 9235: <div class="sect2">
1.1 dsieger 9236: <div class="titlepage"><div><div><h3 class="title">
1.18 snj 9237: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1 dsieger 9238: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18 snj 9239: scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1 dsieger 9240: get registered in the database:</p>
1.23 wiz 9241: <div class="orderedlist"><ol class="orderedlist" type="1">
9242: <li class="listitem"><p>Include
1.18 snj 9243: <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9244: instead of rarian's <code class="filename">buildlink3.mk</code> file. This
1.1 dsieger 9245: takes care of rebuilding the scrollkeeper database at
9246: installation and deinstallation time, and disallows any access
9247: to it directly from the package.</p></li>
1.23 wiz 9248: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9249: <code class="filename">libdata/scrollkeeper</code> directory, as they
9250: will be handled automatically.</p></li>
1.23 wiz 9251: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18 snj 9252: the PLIST. It will be handled by rarian. (<span class="command"><strong>make
9253: print-PLIST</strong></span> does this automatically.)</p></li>
1.1 dsieger 9254: </ol></div>
9255: </div>
1.41 asau 9256: <div class="sect2">
1.1 dsieger 9257: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9258: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1 dsieger 9259: <p>If a package installs font files, you will need to rebuild
9260: the fonts database in the directory where they get installed at
9261: installation and deinstallation time. This can be automatically
9262: done by using the pkginstall framework.</p>
9263: <p>You can list the directories where fonts are installed in the
9264: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9265: variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23 wiz 9266: <span class="quote">“<span class="quote">ttf</span>”</span>, <span class="quote">“<span class="quote">type1</span>”</span> or <span class="quote">“<span class="quote">x11</span>”</span>.
1.1 dsieger 9267: Also make sure that the database file
9268: <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9269: <p>Note that you should not create new directories for fonts;
9270: instead use the standard ones to avoid that the user needs to
9271: manually configure his X server to find them.</p>
9272: </div>
1.41 asau 9273: <div class="sect2">
1.1 dsieger 9274: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9275: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1 dsieger 9276: <p>If a package installs GTK2 immodules or loaders, you need to
9277: take some extra steps to get them registered in the GTK2 database
9278: properly:</p>
1.23 wiz 9279: <div class="orderedlist"><ol class="orderedlist" type="1">
9280: <li class="listitem"><p>Include
1.1 dsieger 9281: <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9282: <code class="filename">buildlink3.mk</code> file. This takes care of
9283: rebuilding the database at installation and deinstallation time.</p></li>
1.23 wiz 9284: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1 dsieger 9285: your package installs GTK2 immodules.</p></li>
1.23 wiz 9286: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1 dsieger 9287: GTK2 loaders.</p></li>
1.23 wiz 9288: <li class="listitem">
1.1 dsieger 9289: <p>Patch the package to not touch any of the GTK2
9290: databases directly. These are:</p>
1.41 asau 9291: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9292: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9293: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1 dsieger 9294: </ul></div>
9295: </li>
1.23 wiz 9296: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1 dsieger 9297: any entries under the <code class="filename">libdata/gtk-2.0</code>
9298: directory, as they will be handled automatically.</p></li>
9299: </ol></div>
9300: </div>
1.41 asau 9301: <div class="sect2">
1.1 dsieger 9302: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9303: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1 dsieger 9304: <p>If a package installs SGML or XML data files that need to be
9305: registered in system-wide catalogs (like DTDs, sub-catalogs,
9306: etc.), you need to take some extra steps:</p>
1.23 wiz 9307: <div class="orderedlist"><ol class="orderedlist" type="1">
9308: <li class="listitem"><p>Include
1.1 dsieger 9309: <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9310: your <code class="filename">Makefile</code>, which takes care of
9311: registering those files in system-wide catalogs at
9312: installation and deinstallation time.</p></li>
1.23 wiz 9313: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1 dsieger 9314: any SGML catalogs installed by the package.</p></li>
1.23 wiz 9315: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1 dsieger 9316: any XML catalogs installed by the package.</p></li>
1.23 wiz 9317: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1 dsieger 9318: to be added to the SGML catalog. These come in groups of
9319: three strings; see xmlcatmgr(1) for more information
9320: (specifically, arguments recognized by the 'add' action).
9321: Note that you will normally not use this variable.</p></li>
1.23 wiz 9322: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1 dsieger 9323: to be added to the XML catalog. These come in groups of three
9324: strings; see xmlcatmgr(1) for more information (specifically,
9325: arguments recognized by the 'add' action). Note that you will
9326: normally not use this variable.</p></li>
9327: </ol></div>
9328: </div>
1.41 asau 9329: <div class="sect2">
1.1 dsieger 9330: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9331: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1 dsieger 9332: <p>If a package provides extensions to the MIME database by
9333: installing <code class="filename">.xml</code> files inside
9334: <code class="filename">${PREFIX}/share/mime/packages</code>, you
9335: need to take some extra steps to ensure that the database is kept
9336: consistent with respect to these new files:</p>
1.23 wiz 9337: <div class="orderedlist"><ol class="orderedlist" type="1">
9338: <li class="listitem"><p>Include
1.1 dsieger 9339: <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9340: (avoid using the <code class="filename">buildlink3.mk</code> file from
9341: this same directory, which is reserved for inclusion from
9342: other <code class="filename">buildlink3.mk</code> files). It takes
9343: care of rebuilding the MIME database at installation and
9344: deinstallation time, and disallows any access to it directly
9345: from the package.</p></li>
1.23 wiz 9346: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1 dsieger 9347: <code class="filename">share/mime</code> directory,
9348: <span class="emphasis"><em>except</em></span> for files saved under
9349: <code class="filename">share/mime/packages</code>. The former are
9350: handled automatically by
9351: the update-mime-database program, but the latter are
9352: package-dependent and must be removed by the package that
9353: installed them in the first place.</p></li>
1.23 wiz 9354: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1 dsieger 9355: from the PLIST. They will be handled by the shared-mime-info
9356: package.</p></li>
9357: </ol></div>
9358: </div>
1.41 asau 9359: <div class="sect2">
1.1 dsieger 9360: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9361: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1 dsieger 9362: <p>If a package uses intltool during its build, add
9363: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9364: which forces it to use the intltool package provided by pkgsrc,
9365: instead of the one bundled with the distribution file.</p>
9366: <p>This tracks intltool's build-time dependencies and uses the
9367: latest available version; this way, the package benefits of any
9368: bug fixes that may have appeared since it was released.</p>
9369: </div>
1.41 asau 9370: <div class="sect2">
1.1 dsieger 9371: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9372: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1 dsieger 9373: <p>If a package contains a rc.d script, it won't be copied into
9374: the startup directory by default, but you can enable it, by adding
9375: the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10 hubertf 9376: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1 dsieger 9377: into <code class="filename">/etc/rc.d</code> when a package is installed, and
9378: it will automatically remove the scripts when the package is
9379: deinstalled.</p>
9380: </div>
1.41 asau 9381: <div class="sect2">
1.1 dsieger 9382: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9383: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1 dsieger 9384: <p>If a package installs TeX packages into the texmf tree,
9385: the <code class="filename">ls-R</code> database of the tree needs to be
9386: updated.</p>
1.41 asau 9387: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 9388: <h3 class="title">Note</h3>
1.22 jakllsch 9389: <p>Except the main TeX packages such as kpathsea,
1.1 dsieger 9390: packages should install files
1.22 jakllsch 9391: into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9392: not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1 dsieger 9393: </div>
1.23 wiz 9394: <div class="orderedlist"><ol class="orderedlist" type="1">
9395: <li class="listitem"><p>Include
1.22 jakllsch 9396: <code class="filename">../../print/kpathsea/texmf.mk</code>. This
1.1 dsieger 9397: takes care of rebuilding the <code class="filename">ls-R</code>
9398: database at installation and deinstallation time.</p></li>
1.23 wiz 9399: <li class="listitem">
1.1 dsieger 9400: <p>If your package installs files into a texmf
9401: tree other than the one
1.22 jakllsch 9402: at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9403: set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1 dsieger 9404: trees that need database update.</p>
9405: <p>If your package also installs font map files that need
1.10 hubertf 9406: to be registered using <span class="command"><strong>updmap</strong></span>,
1.29 dholland 9407: include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22 jakllsch 9408: set <code class="varname">TEX_MAP_FILES</code> and/or
9409: <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10 hubertf 9410: such font map files. Then <span class="command"><strong>updmap</strong></span> will
1.1 dsieger 9411: be run automatically at installation/deinstallation to
9412: enable/disable font map files for TeX output
9413: drivers.</p>
9414: </li>
1.23 wiz 9415: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1 dsieger 9416: databases are included in <code class="filename">PLIST</code>, as
1.29 dholland 9417: they will be removed only by the kpathsea package.</p></li>
1.1 dsieger 9418: </ol></div>
9419: </div>
1.41 asau 9420: <div class="sect2">
1.1 dsieger 9421: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9422: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1 dsieger 9423: emulation</h3></div></div></div>
9424: <p>There are some packages that provide libraries and
9425: executables for running binaries from a one operating system
9426: on a different one (if the latter supports it). One example
9427: is running Linux binaries on NetBSD.</p>
9428: <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>
9429: helps in extracting and packaging Linux rpm packages.</p>
9430: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10 hubertf 9431: avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1 dsieger 9432: if all libraries for each installed executable can be found by
9433: the dynamic linker. Since the standard dynamic linker is run,
9434: this fails for emulation packages, because the libraries used
9435: by the emulation are not in the standard directories.</p>
9436: </div>
1.41 asau 9437: <div class="sect2">
1.1 dsieger 9438: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9439: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1 dsieger 9440: <p>If a package installs images under the
9441: <code class="filename">share/icons/hicolor</code> and/or updates the
9442: <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9443: database, you need to take some extra steps to make sure that the
9444: shared theme directory is handled appropriately and that the cache
9445: database is rebuilt:</p>
1.23 wiz 9446: <div class="orderedlist"><ol class="orderedlist" type="1">
9447: <li class="listitem"><p>Include
1.1 dsieger 9448: <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23 wiz 9449: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1 dsieger 9450: entry that refers to the theme cache.</p></li>
1.23 wiz 9451: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1 dsieger 9452: directories from the <code class="filename">share/icons/hicolor</code>
9453: hierarchy because they will be handled automatically.</p></li>
9454: </ol></div>
9455: <p>The best way to verify that the PLIST is correct with
9456: respect to the last two points is to regenerate it using
1.10 hubertf 9457: <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1 dsieger 9458: </div>
1.41 asau 9459: <div class="sect2">
1.1 dsieger 9460: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 9461: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1 dsieger 9462: <p>If a package installs <code class="filename">.desktop</code> files
9463: under <code class="filename">share/applications</code> and these include
1.53 rodent 9464: MIME information (MimeType key), you need to take extra steps to
9465: ensure that they are registered into the MIME database:</p>
1.23 wiz 9466: <div class="orderedlist"><ol class="orderedlist" type="1">
9467: <li class="listitem"><p>Include
1.1 dsieger 9468: <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23 wiz 9469: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1 dsieger 9470: <code class="filename">share/applications/mimeinfo.cache</code> file.
9471: It will be handled automatically.</p></li>
9472: </ol></div>
9473: <p>The best way to verify that the PLIST is correct with
1.10 hubertf 9474: respect to the last point is to regenerate it using <span class="command"><strong>make
1.1 dsieger 9475: print-PLIST</strong></span>.</p>
9476: </div>
9477: </div>
1.41 asau 9478: <div class="sect1">
1.1 dsieger 9479: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9480: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1 dsieger 9481: <p>In some cases one does not have the time to solve a problem
1.22 jakllsch 9482: immediately. In this case, one can plainly mark a package as broken. For
9483: this, one just sets the variable <code class="varname">BROKEN</code> to the
9484: reason why the package is broken (similar to the
9485: <code class="varname">RESTRICTED</code> variable). A user trying to build
9486: the package will immediately be shown this message, and the build
9487: will not be even tried.</p>
9488: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1 dsieger 9489: intervals.</p>
9490: </div>
9491: </div>
1.41 asau 9492: <div class="chapter">
1.1 dsieger 9493: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9494: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1 dsieger 9495: <p>To check out all the gotchas when building a package, here are
9496: the steps that I do in order to get a package working. Please note
9497: this is basically the same as what was explained in the previous
9498: sections, only with some debugging aids.</p>
1.41 asau 9499: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9500: <li class="listitem"><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>
9501: <li class="listitem">
1.1 dsieger 9502: <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>,
9503: create a directory for a new package, change into it, then run
1.10 hubertf 9504: <span class="command"><strong>url2pkg</strong></span>:</p>
1.1 dsieger 9505: <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>
9506: <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>
9507: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9508: </li>
1.23 wiz 9509: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9510: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9511: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9512: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1 dsieger 9513: configure step to the package's
9514: <code class="filename">Makefile</code>.</p></li>
1.23 wiz 9515: <li class="listitem">
1.1 dsieger 9516: <p>Make the package compile, doing multiple rounds of</p>
9517: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9518: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9519: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9520: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9521: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9522: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9523: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9524: <p>Doing this step as non-root user will ensure that no files
9525: are modified that shouldn't be, especially during the build
1.10 hubertf 9526: phase. <span class="command"><strong>mkpatches</strong></span>,
9527: <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1 dsieger 9528: 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>
9529: package.</p>
9530: </li>
1.23 wiz 9531: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9532: necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, “<code class="filename">Makefile</code>”</a>.</p></li>
9533: <li class="listitem">
1.1 dsieger 9534: <p>Generate a <code class="filename">PLIST</code>:</p>
9535: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9536: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST >PLIST</code></strong>
9537: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9538: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9539: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9540: <p>You usually need to be <code class="username">root</code> to do
9541: this. Look if there are any files left:</p>
9542: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9543: <p>If this reveals any files that are missing in
9544: <code class="filename">PLIST</code>, add them.</p>
9545: </li>
1.23 wiz 9546: <li class="listitem">
1.1 dsieger 9547: <p>Now that the <code class="filename">PLIST</code> is OK, install the
9548: package again and make a binary package:</p>
9549: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9550: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9551: </li>
1.23 wiz 9552: <li class="listitem">
1.1 dsieger 9553: <p>Delete the installed package:</p>
9554: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9555: </li>
1.23 wiz 9556: <li class="listitem">
1.10 hubertf 9557: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1 dsieger 9558: command, which shouldn't find anything now:</p>
9559: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9560: </li>
1.23 wiz 9561: <li class="listitem">
1.1 dsieger 9562: <p>Reinstall the binary package:</p>
9563: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9564: </li>
1.23 wiz 9565: <li class="listitem"><p>Play with it. Make sure everything works.</p></li>
9566: <li class="listitem">
1.10 hubertf 9567: <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.1 dsieger 9568: reports:</p>
9569: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9570: </li>
1.23 wiz 9571: <li class="listitem"><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.1 dsieger 9572: </ul></div>
9573: </div>
1.41 asau 9574: <div class="chapter">
1.1 dsieger 9575: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9576: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1 dsieger 9577: <div class="toc">
9578: <p><b>Table of Contents</b></p>
9579: <dl>
1.6 rillig 9580: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9581: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9582: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.33 wiz 9583: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.6 rillig 9584: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.20 snj 9585: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9586: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.1 dsieger 9587: </dl>
9588: </div>
1.41 asau 9589: <div class="sect1">
1.1 dsieger 9590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9591: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1 dsieger 9592: <p>Our policy is that we accept binaries only from pkgsrc
9593: developers to guarantee that the packages don't contain any
9594: trojan horses etc. This is not to annoy anyone but rather to
9595: protect our users! You're still free to put up your home-made
9596: binary packages and tell the world where to get them. NetBSD
9597: developers doing bulk builds and wanting to upload them please
1.10 hubertf 9598: 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.1 dsieger 9599: </div>
1.41 asau 9600: <div class="sect1">
1.1 dsieger 9601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9602: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1 dsieger 9603: <p>First, check that your package is complete, compiles and
1.10 hubertf 9604: runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.29 dholland 9605: document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1 dsieger 9606: archive that contains all files that make up the package.
9607: Finally, send this package to the pkgsrc bug tracking system,
1.29 dholland 9608: either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1 dsieger 9609: that, go to the web page
1.10 hubertf 9610: <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21 snj 9611: which contains some instructions and a link to a form where you
9612: can submit packages. The
9613: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
9614: also available as a substitute for either of the above two tools.
9615: </p>
1.1 dsieger 9616: <p>In the form of the problem report, the category should be
1.23 wiz 9617: <span class="quote">“<span class="quote">pkg</span>”</span>, the synopsis should include the package name
1.1 dsieger 9618: and version number, and the description field should contain a
9619: short description of your package (contents of the COMMENT
9620: variable or DESCR file are OK). The uuencoded package data should
1.23 wiz 9621: go into the <span class="quote">“<span class="quote">fix</span>”</span> field.</p>
1.1 dsieger 9622: <p>If you want to submit several packages, please send a
9623: separate PR for each one, it's easier for us to track things
9624: that way.</p>
9625: <p>Alternatively, you can also import new packages into
1.23 wiz 9626: pkgsrc-wip (<span class="quote">“<span class="quote">pkgsrc work-in-progress</span>”</span>); see the
1.10 hubertf 9627: homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1 dsieger 9628: for details.</p>
9629: </div>
1.41 asau 9630: <div class="sect1">
1.1 dsieger 9631: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9632: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1 dsieger 9633: <p>Please note all package additions, updates, moves, and
9634: removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9635: important to keep this file up to date and conforming to the
9636: existing format, because it will be used by scripts to
1.10 hubertf 9637: automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1 dsieger 9638: sites. Additionally, check the
9639: <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9640: for the package you updated or removed, in case it was mentioned
9641: there.</p>
9642: <p>When the <code class="varname">PKGREVISION</code> of a package is
9643: bumped, the change should appear in
9644: <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9645: related or otherwise relevant. Mass bumps that result from a
9646: dependency being updated should not be mentioned. In all other
9647: cases it's the developer's decision.</p>
9648: <p>There is a make target that helps in creating proper
1.10 hubertf 9649: <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries: <span class="command"><strong>make
1.1 dsieger 9650: changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9651: and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9652: usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9653: file is up-to-date (to avoid having to resolve conflicts later-on)
1.10 hubertf 9654: and then to <span class="command"><strong>cd</strong></span> to the package directory. For
9655: package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1 dsieger 9656: For new packages, or package moves or removals, set the
9657: <code class="varname">CTYPE</code> variable on the command line to "Added",
9658: "Moved", or "Removed". You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10 hubertf 9659: in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22 jakllsch 9660: not the same as your NetBSD login name. The target also automatically
9661: removes possibly existing entries for the package in the
9662: <code class="filename">TODO</code> file. Don't forget to commit
9663: the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
9664: If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9665: a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9666: makes the cvs commands use the main repository.
9667: </p>
1.1 dsieger 9668: </div>
1.41 asau 9669: <div class="sect1">
1.1 dsieger 9670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.33 wiz 9671: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.1 dsieger 9672: <p>This section is only of interest for pkgsrc developers with write
1.33 wiz 9673: access to the pkgsrc repository.</p>
9674: <p>When the package is finished, <span class="quote">“<span class="quote">cvs add</span>”</span> the files.
9675: Start by adding the directory and then files in the directory. Don't
9676: forget to add the new package to the category's
9677: <code class="filename">Makefile</code>. Make sure you don't forget any files;
9678: you can check by running <span class="quote">“<span class="quote">cvs status</span>”</span>. An example:</p>
9679: <pre class="programlisting">
9680: <code class="prompt">$</code> cd .../pkgsrc/category
9681: <code class="prompt">$</code> cvs add pkgname
9682: <code class="prompt">$</code> cd pkgname
9683: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
9684: <code class="prompt">$</code> cvs add patches/p*
9685: <code class="prompt">$</code> cvs status | less
1.34 wiz 9686: <code class="prompt">$</code> cvs commit
1.33 wiz 9687: <code class="prompt">$</code> cd ..
9688: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34 wiz 9689: <code class="prompt">$</code> cvs commit Makefile
1.33 wiz 9690: </pre>
1.1 dsieger 9691: <p>The commit message of the initial import should include part of the
9692: <code class="filename">DESCR</code> file, so people reading the mailing lists know
9693: what the package is/does.</p>
1.33 wiz 9694: <p>Also mention the new package in
9695: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
9696: <p>Previously, <span class="quote">“<span class="quote">cvs import</span>”</span> was suggested, but it was
9697: much easier to get wrong than <span class="quote">“<span class="quote">cvs add</span>”</span>.</p>
1.1 dsieger 9698: </div>
1.41 asau 9699: <div class="sect1">
1.1 dsieger 9700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 9701: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1 dsieger 9702: <p>Please always put a concise, appropriate and relevant summary of the
9703: changes between old and new versions into the commit log when updating
9704: a package. There are various reasons for this:</p>
1.41 asau 9705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9706: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1 dsieger 9707: or its information may be overwritten by newer information.</p></li>
1.23 wiz 9708: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9709: repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23 wiz 9710: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1 dsieger 9711: repository is very useful for people who read the pkgsrc-changes mailing
9712: list, so that they can make tactical decisions about when to upgrade
9713: the package.</p></li>
9714: </ul></div>
9715: <p>Please also recognize that, just because a new version of a package
9716: has been released, it should not automatically be upgraded in the CVS
9717: repository. We prefer to be conservative in the packages that are
9718: included in pkgsrc - development or beta packages are not really the
9719: best thing for most places in which pkgsrc is used. Please use your
9720: judgement about what should go into pkgsrc, and bear in mind that
9721: stability is to be preferred above new and possibly untested features.</p>
9722: </div>
1.41 asau 9723: <div class="sect1">
1.1 dsieger 9724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.20 snj 9725: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9726: <p>Renaming packages is not recommended.</p>
9727: <p>When renaming packages, be sure to fix any references to old name
9728: in other Makefiles, options, buildlink files, etc.</p>
9729: <p>Also When renaming a package, please define
9730: <code class="varname">SUPERSEDES</code> to the package name and dewey version
9731: pattern(s) of the previous package name.
9732: This may be repeated for multiple renames.
9733: The new package would be an exact replacement.
9734: </p>
1.23 wiz 9735: <p>Note that <span class="quote">“<span class="quote">successor</span>”</span> in the
1.20 snj 9736: CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9737: mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9738: not be an exact replacement but is a suggestion for the replaced
9739: functionality.</p>
9740: </div>
1.41 asau 9741: <div class="sect1">
1.20 snj 9742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9743: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9744: <p>It is preferred that packages are not renamed or moved, but if needed
9745: please follow these steps.
9746: </p>
1.23 wiz 9747: <div class="orderedlist"><ol class="orderedlist" type="1">
9748: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9749: <li class="listitem">
1.1 dsieger 9750: <p>Remove all CVS dirs.</p>
9751: <p>Alternatively to the first two steps you can also do:</p>
9752: <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>
9753: <p>and use that for further work.</p>
9754: </li>
1.23 wiz 9755: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9756: <code class="varname">DEPENDS</code> paths that just did <span class="quote">“<span class="quote">../package</span>”</span>
9757: instead of <span class="quote">“<span class="quote">../../category/package</span>”</span>.</p></li>
9758: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20 snj 9759: <code class="varname">PREV_PKGPATH</code> to the previous category/package
9760: pathname. The <code class="varname">PREV_PKGPATH</code> can be used by tools
9761: for doing an update using pkgsrc building; for example, it can
1.29 dholland 9762: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20 snj 9763: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9764: new <code class="varname">PKGPATH</code> for that moved package. Note that
9765: it may have multiple matches, so the tool should also check on the
9766: <code class="varname">PKGBASE</code> too. The <code class="varname">PREV_PKGPATH</code>
9767: probably has no value unless <code class="varname">SUPERSEDES</code> is not
9768: set, i.e. <code class="varname">PKGBASE</code> stays the same. </p></li>
1.23 wiz 9769: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1 dsieger 9770: place.</p></li>
1.23 wiz 9771: <li class="listitem">
1.1 dsieger 9772: <p>Check if any package depends on it:
9773: </p>
9774: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9775: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9776: </li>
1.23 wiz 9777: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9778: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9779: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9780: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9781: <li class="listitem">
1.1 dsieger 9782: <p>Commit the changed and removed files:</p>
9783: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9784: <p>(and any packages from step 5, of course).</p>
9785: </li>
9786: </ol></div>
9787: </div>
9788: </div>
1.41 asau 9789: <div class="chapter">
1.1 dsieger 9790: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 9791: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1 dsieger 9792: <p>This section contains the answers to questions that may
9793: arise when you are writing a package. If you don't find your
9794: question answered here, first have a look in the other chapters,
9795: and if you still don't have the answer, ask on the
9796: <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41 asau 9797: <div class="qandaset">
1.57 ! bsiegert 9798: <a name="idp140459940175040"></a><dl>
1.6 rillig 9799: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1 dsieger 9800: MAKEFLAGS, .MAKEFLAGS and
9801: MAKE_FLAGS?</a>
9802: </dt>
1.6 rillig 9803: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1 dsieger 9804: MAKE, GMAKE and
9805: MAKE_PROGRAM?</a>
9806: </dt>
1.6 rillig 9807: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1 dsieger 9808: CC, PKG_CC and
9809: PKGSRC_COMPILER?</a>
9810: </dt>
1.6 rillig 9811: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1 dsieger 9812: BUILDLINK_LDFLAGS,
9813: BUILDLINK_LDADD and
9814: BUILDLINK_LIBS?</a>
9815: </dt>
1.6 rillig 9816: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1 dsieger 9817: VARNAME=BUILDLINK_PREFIX.foo
9818: say it's empty?</a>
9819: </dt>
1.6 rillig 9820: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1 dsieger 9821: ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9822: don't understand the := inside
9823: it.</a>
9824: </dt>
1.6 rillig 9825: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1 dsieger 9826: developers?</a>
9827: </dt>
1.6 rillig 9828: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1 dsieger 9829: documentation?</a>
9830: </dt>
1.6 rillig 9831: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill. What shall I
1.1 dsieger 9832: do?</a>
9833: </dt>
9834: </dl>
1.41 asau 9835: <table border="0" style="width: 100%;">
9836: <colgroup>
1.1 dsieger 9837: <col align="left" width="1%">
1.23 wiz 9838: <col>
1.41 asau 9839: </colgroup>
1.1 dsieger 9840: <tbody>
1.41 asau 9841: <tr class="question">
1.1 dsieger 9842: <td align="left" valign="top">
1.57 ! bsiegert 9843: <a name="devfaq.makeflags"></a><a name="idp140459940175696"></a><p><b>22.1.</b></p>
1.1 dsieger 9844: </td>
9845: <td align="left" valign="top"><p>What is the difference between
9846: <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9847: <code class="varname">MAKE_FLAGS</code>?</p></td>
9848: </tr>
9849: <tr class="answer">
9850: <td align="left" valign="top"></td>
9851: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.29 dholland 9852: to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1 dsieger 9853: <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9854: the <code class="varname">MAKE_PROGRAM</code> when building the
9855: package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9856: </tr>
1.41 asau 9857: <tr class="question">
1.1 dsieger 9858: <td align="left" valign="top">
1.57 ! bsiegert 9859: <a name="devfaq.make"></a><a name="idp140459940180160"></a><p><b>22.2.</b></p>
1.1 dsieger 9860: </td>
9861: <td align="left" valign="top"><p>What is the difference between
9862: <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9863: <code class="varname">MAKE_PROGRAM</code>?</p></td>
9864: </tr>
9865: <tr class="answer">
9866: <td align="left" valign="top"></td>
9867: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.29 dholland 9868: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1 dsieger 9869: infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9870: Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9871: use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9872: Make program that is used for building the
9873: package.</p></td>
9874: </tr>
1.41 asau 9875: <tr class="question">
1.1 dsieger 9876: <td align="left" valign="top">
1.57 ! bsiegert 9877: <a name="devfaq.cc"></a><a name="idp140459940185184"></a><p><b>22.3.</b></p>
1.1 dsieger 9878: </td>
9879: <td align="left" valign="top"><p>What is the difference between
9880: <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9881: <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9882: </tr>
9883: <tr class="answer">
9884: <td align="left" valign="top"></td>
9885: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9886: compiler, which can be configured by the pkgsrc user.
9887: <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9888: <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9889: path to a compiler, but the type of compiler that should be
9890: used. See <code class="filename">mk/compiler.mk</code> for more
9891: information about the latter variable.</p></td>
9892: </tr>
1.41 asau 9893: <tr class="question">
1.1 dsieger 9894: <td align="left" valign="top">
1.57 ! bsiegert 9895: <a name="devfaq.bl3flags"></a><a name="idp140459940190064"></a><p><b>22.4.</b></p>
1.1 dsieger 9896: </td>
9897: <td align="left" valign="top"><p>What is the difference between
9898: <code class="varname">BUILDLINK_LDFLAGS</code>,
9899: <code class="varname">BUILDLINK_LDADD</code> and
9900: <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9901: </tr>
9902: <tr class="answer">
9903: <td align="left" valign="top"></td>
9904: <td align="left" valign="top"><p>[FIXME]</p></td>
9905: </tr>
1.41 asau 9906: <tr class="question">
1.1 dsieger 9907: <td align="left" valign="top">
1.57 ! bsiegert 9908: <a name="devfaq.bl3prefix"></a><a name="idp140459940192688"></a><p><b>22.5.</b></p>
1.1 dsieger 9909: </td>
1.10 hubertf 9910: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1 dsieger 9911: VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9912: say it's empty?</p></td>
9913: </tr>
9914: <tr class="answer">
9915: <td align="left" valign="top"></td>
9916: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23 wiz 9917: available in the <span class="quote">“<span class="quote">wrapper</span>”</span> phase and later. To
9918: <span class="quote">“<span class="quote">simulate</span>”</span> the wrapper phase, append
1.10 hubertf 9919: <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1 dsieger 9920: command.</p></td>
9921: </tr>
1.41 asau 9922: <tr class="question">
1.1 dsieger 9923: <td align="left" valign="top">
1.57 ! bsiegert 9924: <a name="devfaq.master_sites"></a><a name="idp140459940196560"></a><p><b>22.6.</b></p>
1.1 dsieger 9925: </td>
9926: <td align="left" valign="top"><p>What does
9927: <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9928: don't understand the <code class="literal">:=</code> inside
9929: it.</p></td>
9930: </tr>
9931: <tr class="answer">
9932: <td align="left" valign="top"></td>
9933: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9934: assignment operator, like you might expect at first sight.
9935: Instead, it is a degenerate form of
9936: <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.29 dholland 9937: which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.1 dsieger 9938: may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9939: case of <code class="varname">MASTER_SITE_*</code>,
9940: <em class="replaceable"><code>old_string</code></em> is the empty string and
9941: <em class="replaceable"><code>new_string</code></em> is
9942: <code class="literal">package/</code>. That's where the
9943: <code class="literal">:</code> and the <code class="literal">=</code> fall
9944: together.</p></td>
9945: </tr>
1.41 asau 9946: <tr class="question">
1.1 dsieger 9947: <td align="left" valign="top">
1.57 ! bsiegert 9948: <a name="devfaq.mailinglists"></a><a name="idp140459940206176"></a><p><b>22.7.</b></p>
1.1 dsieger 9949: </td>
9950: <td align="left" valign="top"><p>Which mailing lists are there for package
9951: developers?</p></td>
9952: </tr>
9953: <tr class="answer">
9954: <td align="left" valign="top"></td>
1.41 asau 9955: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10 hubertf 9956: <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.1 dsieger 9957: <dd><p>This is a list for technical discussions related
9958: to pkgsrc development, e.g. soliciting feedback for changes to
9959: pkgsrc infrastructure, proposed new features, questions related
9960: to porting pkgsrc to a new platform, advice for maintaining a
9961: package, patches that affect many packages, help requests moved
9962: from pkgsrc-users when an infrastructure bug is found,
9963: etc.</p></dd>
1.10 hubertf 9964: <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.1 dsieger 9965: <dd><p>All bug reports in category "pkg" sent with
1.29 dholland 9966: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1 dsieger 9967: directly; use one of the other mailing
9968: lists.</p></dd>
9969: </dl></div></td>
9970: </tr>
1.41 asau 9971: <tr class="question">
1.1 dsieger 9972: <td align="left" valign="top">
1.57 ! bsiegert 9973: <a name="devfaq.documentation"></a><a name="idp140459940211088"></a><p><b>22.8.</b></p>
1.1 dsieger 9974: </td>
9975: <td align="left" valign="top"><p>Where is the pkgsrc
9976: documentation?</p></td>
9977: </tr>
9978: <tr class="answer">
9979: <td align="left" valign="top"></td>
9980: <td align="left" valign="top">
9981: <p>There are many places where you can find
9982: documentation about pkgsrc:</p>
1.41 asau 9983: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 9984: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1 dsieger 9985: of chapters that explain large parts of pkgsrc, but some
9986: chapters tend to be outdated. Which ones they are is hard to
9987: say.</p></li>
1.23 wiz 9988: <li class="listitem"><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.1 dsieger 9989: about certain features, announcements of new parts of the pkgsrc
9990: infrastructure and sometimes even announcements that a certain
9991: feature has been marked as obsolete. The benefit here is that
9992: each message has a date appended to it.</p></li>
1.23 wiz 9993: <li class="listitem"><p>Many of the files in the
1.1 dsieger 9994: <code class="filename">mk/</code> directory start with a comment that
9995: describes the purpose of the file and how it can be used by the
9996: pkgsrc user and package authors. An easy way to find this
1.10 hubertf 9997: documentation is to run <span class="command"><strong>bmake
1.1 dsieger 9998: help</strong></span>.</p></li>
1.23 wiz 9999: <li class="listitem"><p>The CVS log messages are a rich source of
1.1 dsieger 10000: information, but they tend to be highly abbreviated, especially
10001: for actions that occur often. Some contain a detailed
10002: description of what has changed, but they are geared towards the
10003: other pkgsrc developers, not towards an average pkgsrc user.
10004: They also only document <span class="emphasis"><em>changes</em></span>, so if you
10005: don't know what has been before, these messages may not be worth
10006: too much to you.</p></li>
1.23 wiz 10007: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">“<span class="quote">implicitly
10008: documented</span>”</span>, that is the documentation exists only in the
1.1 dsieger 10009: mind of the developer who wrote the code. To get this
1.10 hubertf 10010: information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1 dsieger 10011: to see who has written it and ask on the
10012: <code class="literal">tech-pkg</code> mailing list, so that others can
10013: find your questions later (see above). To be sure that the
10014: developer in charge reads the mail, you may CC him or
10015: her.</p></li>
10016: </ul></div>
10017: </td>
10018: </tr>
1.41 asau 10019: <tr class="question">
1.1 dsieger 10020: <td align="left" valign="top">
1.57 ! bsiegert 10021: <a name="devfaq.too-much-time"></a><a name="idp140459940219968"></a><p><b>22.9.</b></p>
1.1 dsieger 10022: </td>
10023: <td align="left" valign="top"><p>I have a little time to kill. What shall I
10024: do?</p></td>
10025: </tr>
10026: <tr class="answer">
10027: <td align="left" valign="top"></td>
10028: <td align="left" valign="top">
10029: <p>This is not really an FAQ yet, but here's the answer
10030: anyway.</p>
1.41 asau 10031: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10032: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1 dsieger 10033: <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
10034: will tell you about newer versions of installed packages that are
10035: available, but not yet updated in pkgsrc.</p></li>
1.23 wiz 10036: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14 jmcneill 10037: — it contains a list of suggested new packages and a list of
1.1 dsieger 10038: cleanups and enhancements for pkgsrc that would be nice to
10039: have.</p></li>
1.23 wiz 10040: <li class="listitem"><p>Review packages for which review was requested on
1.10 hubertf 10041: the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1 dsieger 10042: mailing list.</p></li>
10043: </ul></div>
10044: </td>
10045: </tr>
10046: </tbody>
10047: </table>
10048: </div>
10049: </div>
1.41 asau 10050: <div class="chapter">
1.1 dsieger 10051: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10052: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1 dsieger 10053: <div class="toc">
10054: <p><b>Table of Contents</b></p>
10055: <dl>
1.6 rillig 10056: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
10057: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
10058: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
10059: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1 dsieger 10060: </dl>
10061: </div>
1.10 hubertf 10062: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1 dsieger 10063: site</a>:</p>
10064: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
10065: environment, an intuitive and attractive desktop for users, and the
10066: GNOME development platform, an extensive framework for building
10067: applications that integrate into the rest of the desktop.</p></blockquote></div>
10068: <p>pkgsrc provides a seamless way to automatically build and install
10069: a complete GNOME environment <span class="emphasis"><em>under many different
10070: platforms</em></span>. We can say with confidence that pkgsrc is one of
10071: the most advanced build and packaging systems for GNOME due to its
10072: included technologies buildlink3, the wrappers and tools framework and
10073: automatic configuration file management. Lots of efforts are put into
10074: achieving a completely clean deinstallation of installed software
10075: components.</p>
1.10 hubertf 10076: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1 dsieger 10077: the above also means that great efforts are put into making GNOME work
1.10 hubertf 10078: under this operating system. Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1 dsieger 10079: pkgsrc as its preferred packaging system, contributing lots of
10080: portability fixes to make GNOME build and install under it.</p>
10081: <p>This chapter is aimed at pkgsrc developers and other people
10082: interested in helping our GNOME porting and packaging efforts. It
10083: provides instructions on how to manage the existing packages and some
10084: important information regarding their internals.</p>
1.41 asau 10085: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10086: <h3 class="title">We need your help!</h3>
10087: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
10088: and GNOME and are willing to learn new exciting stuff, please jump
1.10 hubertf 10089: straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1 dsieger 10090: work</a> list! There is still a long way to go to get a
10091: fully-functional GNOME desktop under NetBSD and we need your help to
10092: achieve it!</p>
10093: </div>
1.41 asau 10094: <div class="sect1">
1.1 dsieger 10095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10096: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1 dsieger 10097: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41 asau 10098: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10099: <li class="listitem"><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.1 dsieger 10100: the core GNOME desktop environment. It only includes the necessary
10101: bits to get it to boot correctly, although it may lack important
10102: functionality for daily operation. The idea behind this package is
10103: to let end users build their own configurations on top of this one,
10104: first installing this meta package to achieve a functional setup and
10105: then adding individual applications.</p></li>
1.23 wiz 10106: <li class="listitem"><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.1 dsieger 10107: complete installation of the GNOME platform and desktop as defined
10108: by the GNOME project; this is based on the components distributed in
10109: the <code class="filename">platform/x.y/x.y.z/sources</code> and
10110: <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
10111: official FTP server. Developer-only tools found in those
10112: directories are not installed unless required by some other
10113: component to work properly. Similarly, packages from the bindings
10114: set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
10115: in unless required as a dependency for an end-user component. This
10116: 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>
1.23 wiz 10117: <li class="listitem"><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.1 dsieger 10118: Installs all the tools required to build a GNOME component when
10119: fetched from the CVS repository. These are required to let the
1.10 hubertf 10120: <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1 dsieger 10121: </ul></div>
10122: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
10123: sorted in a way that eases updates: a package may depend on other
10124: packages listed before it but not on any listed after it. It is very
10125: important to keep this order to ease updates so... <span class="emphasis"><em>do not
10126: change it to alphabetical sorting!</em></span></p>
10127: </div>
1.41 asau 10128: <div class="sect1">
1.1 dsieger 10129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10130: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1 dsieger 10131: <p>Almost all GNOME applications are written in C and use a common
10132: set of tools as their build system. Things get different with the new
10133: bindings to other languages (such as Python), but the following will
10134: give you a general idea on the minimum required tools:</p>
1.41 asau 10135: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10136: <li class="listitem">
1.1 dsieger 10137: <p>Almost all GNOME applications use the GNU Autotools as their
10138: build system. As a general rule you will need to tell this to your
10139: package:</p>
10140: <pre class="programlisting">
10141: GNU_CONFIGURE=yes
10142: USE_LIBTOOL=yes
10143: USE_TOOLS+=gmake
10144: </pre>
10145: </li>
1.23 wiz 10146: <li class="listitem">
1.1 dsieger 10147: <p>If the package uses pkg-config to detect dependencies, add this
10148: tool to the list of required utilities:</p>
10149: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
10150: <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
10151: the end of the build process to ensure that you did not miss to
10152: specify any dependency in your package and that the version
10153: requirements are all correct.</p>
10154: </li>
1.23 wiz 10155: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1 dsieger 10156: <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
10157: to handle dependencies and to force the package to use the latest
10158: available version.</p></li>
1.23 wiz 10159: <li class="listitem">
1.1 dsieger 10160: <p>If the package uses gtk-doc (a documentation generation
10161: utility), do <span class="emphasis"><em>not</em></span> add a dependency on it. The
10162: tool is rather big and the distfile should come with pregenerated
10163: documentation anyway; if it does not, it is a bug that you ought to
10164: report. For such packages you should disable gtk-doc (unless it is
10165: the default):</p>
10166: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
10167: <p>The default location of installed HTML files
10168: (<code class="filename">share/gtk-doc/<package-name></code>) is correct
10169: and should not be changed unless the package insists on installing
10170: them somewhere else. Otherwise programs as
1.10 hubertf 10171: <span class="command"><strong>devhelp</strong></span> will not be able to open them. You can
1.1 dsieger 10172: do that with an entry similar to:</p>
10173: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
10174: </li>
10175: </ul></div>
10176: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
10177: files under the installation prefix to maintain databases. In this
10178: context, shared means that those exact same directories and files are
10179: used among several different packages, leading to conflicts in the
10180: <code class="filename">PLIST</code>. pkgsrc currently includes functionality to
10181: handle the most common cases, so you have to forget about using
10182: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
10183: omitting shared files from them. If you find yourself doing those,
10184: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
10185: <p>The following table lists the common situations that result in
10186: using shared directories or files. For each of them, the appropriate
10187: solution is given. After applying the solution be sure to
10188: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10 hubertf 10189: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1 dsieger 10190: <div class="table">
1.6 rillig 10191: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1 dsieger 10192: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
10193: <colgroup>
10194: <col>
10195: <col>
10196: </colgroup>
10197: <thead><tr>
10198: <th>If the package...</th>
10199: <th>Then...</th>
10200: </tr></thead>
10201: <tbody>
10202: <tr>
10203: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18 snj 10204: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, “Packages installing scrollkeeper/rarian data files”</a>.</td>
1.1 dsieger 10205: </tr>
10206: <tr>
10207: <td>Installs icons under the
10208: <code class="filename">share/icons/hicolor</code> hierarchy or updates
10209: <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10 hubertf 10210: <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.1 dsieger 10211: </tr>
10212: <tr>
10213: <td>Installs files under
10214: <code class="filename">share/mime/packages</code>.</td>
1.10 hubertf 10215: <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.1 dsieger 10216: </tr>
10217: <tr>
10218: <td>Installs <code class="filename">.desktop</code> files under
10219: <code class="filename">share/applications</code> and these include MIME
10220: information.</td>
1.10 hubertf 10221: <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.1 dsieger 10222: </tr>
10223: </tbody>
10224: </table></div>
10225: </div>
10226: <br class="table-break">
10227: </div>
1.41 asau 10228: <div class="sect1">
1.1 dsieger 10229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10230: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1 dsieger 10231: <p>When seeing GNOME as a whole, there are two kinds of
10232: updates:</p>
1.41 asau 10233: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10234: <dt><span class="term">Major update</span></dt>
10235: <dd>
10236: <p>Given that there is still a very long way for GNOME 3 (if it
10237: ever appears), we consider a major update one that goes from a
10238: <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10239: where <code class="literal">Y</code> is even and greater than
10240: <code class="literal">X</code>. These are hard to achieve because they
10241: introduce lots of changes in the components' code and almost all
10242: GNOME distfiles are updated to newer versions. Some of them can
10243: even break API and ABI compatibility with the previous major
10244: version series. As a result, the update needs to be done all at
10245: once to minimize breakage.</p>
10246: <p>A major update typically consists of around 80 package
10247: updates and the addition of some new ones.</p>
10248: </dd>
10249: <dt><span class="term">Minor update</span></dt>
10250: <dd>
10251: <p>We consider a minor update one that goes from a
10252: <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10253: one where <code class="literal">Y</code> is greater than
10254: <code class="literal">X</code>. These are easy to achieve because they do
10255: not update all GNOME components, can be done in an incremental way
10256: and do not break API nor ABI compatibility.</p>
10257: <p>A minor update typically consists of around 50 package
10258: updates, although the numbers here may vary a lot.</p>
10259: </dd>
10260: </dl></div>
10261: <p>In order to update the GNOME components in pkgsrc to a new stable
10262: release (either major or minor), the following steps should be
10263: followed:</p>
1.23 wiz 10264: <div class="orderedlist"><ol class="orderedlist" type="1">
10265: <li class="listitem">
1.1 dsieger 10266: <p>Get a list of all the tarballs that form the new release by
10267: using the following commands. These will leave the full list of the
1.18 snj 10268: components' distfiles into the <code class="filename">list.txt</code>
1.1 dsieger 10269: file:</p>
10270: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10271: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10272: awk '{ print $9 }' >list.txt</code></strong>
10273: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10274: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10275: awk '{ print $9 }' >>list.txt</code></strong></pre>
10276: </li>
1.23 wiz 10277: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1 dsieger 10278: bump their version to the release you are updating them to. The
10279: three meta packages should be always consistent with versioning.
10280: Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10281: in them.</p></li>
1.23 wiz 10282: <li class="listitem">
1.1 dsieger 10283: <p>For each meta package, update all its
10284: <code class="varname">DEPENDS</code> lines to match the latest versions as
10285: shown by the above commands. Do <span class="emphasis"><em>not</em></span> list any
10286: newer version (even if found in the FTP) because the meta packages
10287: are supposed to list the exact versions that form a specific GNOME
10288: release. Exceptions are permitted here if a newer version solves a
10289: serious issue in the overall desktop experience; these typically
10290: come in the form of a revision bump in pkgsrc, not in newer versions
10291: from the developers.</p>
10292: <p>Packages not listed in the <code class="filename">list.txt</code> file
10293: should be updated to the latest version available (if found in
10294: pkgsrc). This is the case, for example, of the dependencies on the
10295: 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>
10296: </li>
1.23 wiz 10297: <li class="listitem">
1.1 dsieger 10298: <p>Generate a patch from the modified meta packages and extract the
10299: list of "new" lines. This will provide you an outline on what
10300: packages need to be updated in pkgsrc and in what order:</p>
10301: <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>
10302: </li>
1.23 wiz 10303: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1 dsieger 10304: installed packages and start over from scratch at this point.</p></li>
1.23 wiz 10305: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1 dsieger 10306: of <code class="filename">todo.txt</code> and update the packages listed in
10307: it in order. For major desktop updates none of these should be
10308: committed until the entire set is completed because there are chances
10309: of breaking not-yet-updated packages.</p></li>
1.23 wiz 10310: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1 dsieger 10311: the tree one by one with appropriate log messages. At the end,
10312: commit the three meta package updates and all the corresponding
10313: changes to the <code class="filename">doc/CHANGES-<YEAR></code> and
10314: <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>
10315: </ol></div>
10316: </div>
1.41 asau 10317: <div class="sect1">
1.1 dsieger 10318: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10319: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1 dsieger 10320: <p>GNOME is a very big component in pkgsrc which approaches 100
10321: packages. Please, it is very important that you always, always,
10322: <span class="strong"><strong>always</strong></span> feed back any portability
1.10 hubertf 10323: 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.1 dsieger 10324: their attention on portability issues and to ensure that future versions
10325: can be built out-of-the box on NetBSD. The less custom patches in
10326: pkgsrc, the easier further updates are. Those developers in charge of
10327: issuing major GNOME updates will be grateful if you do that.</p>
1.10 hubertf 10328: <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.1 dsieger 10329: Bugzilla</a>. Not all components use these to track bugs, but most
10330: of them do. Do not be short on your reports: always provide detailed
10331: explanations of the current failure, how it can be improved to achieve
10332: maximum portability and, if at all possible, provide a patch against CVS
10333: head. The more verbose you are, the higher chances of your patch being
10334: accepted.</p>
10335: <p>Also, please avoid using preprocessor magic to fix portability
10336: issues. While the FreeBSD GNOME people are doing a great job in porting
10337: GNOME to their operating system, the official GNOME sources are now
10338: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10339: and similar macros. This hurts portability. Please see our patching
1.10 hubertf 10340: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, “Patching guidelines”</a>) for more
1.1 dsieger 10341: details.</p>
10342: </div>
10343: </div>
10344: </div>
1.41 asau 10345: <div class="part">
1.1 dsieger 10346: <div class="titlepage"><div><div><h1 class="title">
10347: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41 asau 10348: <div class="partintro">
1.1 dsieger 10349: <div></div>
10350: <p>This part of the guide deals with everything
10351: from the infrastructure that is behind the interfaces described
10352: in the developer's guide. A casual package maintainer should not
10353: need anything from this part.</p>
10354: <div class="toc">
10355: <p><b>Table of Contents</b></p>
10356: <dl>
1.6 rillig 10357: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1 dsieger 10358: <dd><dl>
1.6 rillig 10359: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10360: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10361: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10362: <dd><dl>
1.6 rillig 10363: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10364: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10365: </dl></dd>
1.6 rillig 10366: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10367: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10368: <dd><dl>
1.6 rillig 10369: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10370: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10371: </dl></dd>
1.6 rillig 10372: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10373: <dd><dl>
1.23 wiz 10374: <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>
10375: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10376: </dl></dd>
10377: </dl></dd>
1.6 rillig 10378: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1 dsieger 10379: <dd><dl>
1.6 rillig 10380: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10381: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10382: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10383: <dd><dl>
1.6 rillig 10384: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10385: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10386: </dl></dd>
10387: </dl></dd>
1.6 rillig 10388: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1 dsieger 10389: <dd><dl>
1.6 rillig 10390: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10391: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10392: </dl></dd>
10393: </dl>
10394: </div>
10395: </div>
1.41 asau 10396: <div class="chapter">
1.1 dsieger 10397: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10398: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1 dsieger 10399: <div class="toc">
10400: <p><b>Table of Contents</b></p>
10401: <dl>
1.6 rillig 10402: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10403: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10404: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1 dsieger 10405: <dd><dl>
1.6 rillig 10406: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10407: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1 dsieger 10408: </dl></dd>
1.6 rillig 10409: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10410: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1 dsieger 10411: <dd><dl>
1.6 rillig 10412: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10413: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1 dsieger 10414: </dl></dd>
1.6 rillig 10415: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1 dsieger 10416: <dd><dl>
1.23 wiz 10417: <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>
10418: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.1 dsieger 10419: </dl></dd>
10420: </dl>
10421: </div>
10422: <p>The pkgsrc infrastructure consists of many small Makefile
10423: fragments. Each such fragment needs a properly specified
10424: interface. This chapter explains how such an interface looks
10425: like.</p>
1.41 asau 10426: <div class="sect1">
1.1 dsieger 10427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10428: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1 dsieger 10429: <p>Whenever a variable is defined in the pkgsrc
10430: infrastructure, the location and the way of definition provide
10431: much information about the intended use of that variable.
10432: Additionally, more documentation may be found in a header
10433: comment or in this pkgsrc guide.</p>
10434: <p>A special file is
10435: <code class="filename">mk/defaults/mk.conf</code>, which lists all
10436: variables that are intended to be user-defined. They are either
10437: defined using the <code class="literal">?=</code> operator or they are
10438: left undefined because defining them to anything would
1.23 wiz 10439: effectively mean <span class="quote">“<span class="quote">yes</span>”</span>. All these variables may be
1.1 dsieger 10440: overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10441: file.</p>
10442: <p>Outside this file, the following conventions apply:
10443: Variables that are defined using the <code class="literal">?=</code>
10444: operator may be overridden by a package.</p>
10445: <p>Variables that are defined using the <code class="literal">=</code>
10446: operator may be used read-only at run-time.</p>
10447: <p>Variables whose name starts with an underscore must not be
10448: accessed outside the pkgsrc infrastructure at all. They may
10449: change without further notice.</p>
1.41 asau 10450: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 10451: <h3 class="title">Note</h3>
10452: <p>These conventions are currently not applied
10453: consistently to the complete pkgsrc
10454: infrastructure.</p>
10455: </div>
10456: </div>
1.41 asau 10457: <div class="sect1">
1.1 dsieger 10458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10459: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1 dsieger 10460: <p>All variables that contain lists of things should default
10461: to being empty. Two examples that do not follow this rule are
10462: <code class="varname">USE_LANGUAGES</code> and
10463: <code class="varname">DISTFILES</code>. These variables cannot simply be
10464: modified using the <code class="literal">+=</code> operator in package
10465: <code class="filename">Makefile</code>s (or other files included by
10466: them), since there is no guarantee whether the variable is
10467: already set or not, and what its value is. In the case of
1.23 wiz 10468: <code class="varname">DISTFILES</code>, the packages <span class="quote">“<span class="quote">know</span>”</span>
1.1 dsieger 10469: the default value and just define it as in the following
10470: example.</p>
10471: <pre class="programlisting">
10472: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10473: </pre>
10474: <p>Because of the selection of this default value, the same
10475: value appears in many package Makefiles. Similarly for
10476: <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23 wiz 10477: value (<span class="quote">“<span class="quote"><code class="literal">c</code></span>”</span>) is so short that it
1.1 dsieger 10478: doesn't stand out. Nevertheless it is mentioned in many
10479: files.</p>
10480: </div>
1.41 asau 10481: <div class="sect1">
1.1 dsieger 10482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10483: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41 asau 10484: <div class="sect2">
1.1 dsieger 10485: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10486: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1 dsieger 10487: <p>Variable evaluation takes place either at load time or at
10488: runtime, depending on the context in which they occur. The
10489: contexts where variables are evaluated at load time are:</p>
1.41 asau 10490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 10491: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1 dsieger 10492: and <code class="literal">!=</code> operators,</p></li>
1.23 wiz 10493: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1 dsieger 10494: <code class="literal">.for</code>,</p></li>
1.23 wiz 10495: <li class="listitem"><p>Dependency lines.</p></li>
1.1 dsieger 10496: </ul></div>
10497: <p>A special exception are references to the iteration
10498: variables of <code class="literal">.for</code> loops, which are expanded
10499: inline, no matter in which context they appear.</p>
10500: <p>As the values of variables may change during load time,
10501: care must be taken not to evaluate them by accident. Typical
10502: examples for variables that should not be evaluated at load time
10503: are <code class="varname">DEPENDS</code> and
10504: <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10505: clear, here is an example:</p>
10506: <pre class="programlisting">
10507: CONFIGURE_ARGS= # none
10508: CFLAGS= -O
10509: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
10510:
10511: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
10512:
10513: CFLAGS+= -Wall
10514: </pre>
10515: <p>This code shows how the use of the <code class="literal">:=</code>
10516: operator can quickly lead to unexpected results. The first
10517: paragraph is fairly common code. The second paragraph evaluates
10518: the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10519: <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10520: <code class="literal">-Wall</code> is appended to the
10521: <code class="varname">CFLAGS</code>, but this addition will not appear in
10522: <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10523: paragraphs from above typically occur in completely unrelated
10524: files.</p>
10525: </div>
1.41 asau 10526: <div class="sect2">
1.1 dsieger 10527: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10528: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1 dsieger 10529: <p>After all the files have been loaded, the values of the
10530: variables cannot be changed anymore. Variables that are used in
10531: the shell commands are expanded at this point.</p>
10532: </div>
10533: </div>
1.41 asau 10534: <div class="sect1">
1.1 dsieger 10535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10536: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1 dsieger 10537: <p>There are many ways in which the definition and use of a
10538: variable can be restricted in order to detect bugs and
10539: violations of the (mostly unwritten) policies. See the
10540: <code class="literal">pkglint</code> developer's documentation for further
10541: details.</p>
10542: </div>
1.41 asau 10543: <div class="sect1">
1.1 dsieger 10544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10545: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1 dsieger 10546: <p>Most of the <code class="filename">.mk</code> files fall into one
10547: of the following classes. Cases where a file falls into more
10548: than one class should be avoided as it often leads to subtle
10549: bugs.</p>
1.41 asau 10550: <div class="sect2">
1.1 dsieger 10551: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10552: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1 dsieger 10553: <p>In a traditional imperative programming language some of
10554: the <code class="filename">.mk</code> files could be described as
1.14 jmcneill 10555: procedures. They take some input parameters and—after
10556: inclusion—provide a result in output parameters. Since all
1.1 dsieger 10557: variables in <code class="filename">Makefile</code>s have global scope
10558: care must be taken not to use parameter names that have already
10559: another meaning. For example, <code class="varname">PKGNAME</code> is a
10560: bad choice for a parameter name.</p>
10561: <p>Procedures are completely evaluated at preprocessing time.
10562: That is, when calling a procedure all input parameters must be
10563: completely resolvable. For example,
10564: <code class="varname">CONFIGURE_ARGS</code> should never be an input
10565: parameter since it is very likely that further text will be
10566: added after calling the procedure, which would effectively apply
10567: the procedure to only a part of the variable. Also, references
10568: to other variables wit will be modified after calling the
10569: procedure.</p>
10570: <p>A procedure can declare its output parameters either as
10571: suitable for use in preprocessing directives or as only
10572: available at runtime. The latter alternative is for variables
10573: that contain references to other runtime variables.</p>
10574: <p>Procedures shall be written such that it is possible to
10575: call the procedure more than once. That is, the file must not
10576: contain multiple-inclusion guards.</p>
10577: <p>Examples for procedures are
10578: <code class="filename">mk/bsd.options.mk</code> and
10579: <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10580: that the parameters are evaluated at load time, they should be
10581: assigned using the <code class="literal">:=</code> operator, which should
10582: be used only for this purpose.</p>
10583: </div>
1.41 asau 10584: <div class="sect2">
1.1 dsieger 10585: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10586: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1 dsieger 10587: <p>Action files take some input parameters and may define
10588: runtime variables. They shall not define loadtime variables.
10589: There are action files that are included implicitly by the
10590: pkgsrc infrastructure, while other must be included
10591: explicitly.</p>
10592: <p>An example for action files is
10593: <code class="filename">mk/subst.mk</code>.</p>
10594: </div>
10595: </div>
1.41 asau 10596: <div class="sect1">
1.1 dsieger 10597: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10598: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1 dsieger 10599: <p>Package <code class="filename">Makefile</code>s usually consist of
10600: a set of variable definitions, and include the file
10601: <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10602: Before that, they may also include various other
10603: <code class="filename">*.mk</code> files if they need to query the
10604: availability of certain features like the type of compiler or
10605: the X11 implementation. Due to the heavy use of preprocessor
10606: directives like <code class="literal">.if</code> and
10607: <code class="literal">.for</code>, the order in which the files are loaded
10608: matters.</p>
10609: <p>This section describes at which point the various files
10610: are loaded and gives reasons for that order.</p>
1.41 asau 10611: <div class="sect2">
1.1 dsieger 10612: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10613: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1 dsieger 10614: </h3></div></div></div>
10615: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10616: is to define some essential variables like
10617: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10618: <code class="varname">MACHINE_ARCH</code>.</p>
10619: <p>Then, the user settings are loaded from the file specified
1.10 hubertf 10620: in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4 rillig 10621: After that, those variables
1.1 dsieger 10622: that have not been overridden by the user are loaded from
10623: <code class="filename">mk/defaults/mk.conf</code>.</p>
10624: <p>After the user settings, the system settings and platform
10625: settings are loaded, which may override the user
10626: settings.</p>
10627: <p>Then, the tool definitions are loaded. The tool wrappers
10628: are not yet in effect. This only happens when building a
10629: package, so the proper variables must be used instead of the
10630: direct tool names.</p>
10631: <p>As the last steps, some essential variables from the
10632: wrapper and the package system flavor are loaded, as well as the
10633: variables that have been cached in earlier phases of a package
10634: build.</p>
10635: </div>
1.41 asau 10636: <div class="sect2">
1.1 dsieger 10637: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10638: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1 dsieger 10639: </h3></div></div></div>
10640: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10641: <p>Then, the various <code class="filename">*-vars.mk</code> files are
10642: loaded, which fill default values for those variables that have
10643: not been defined by the package. These variables may later
10644: be used even in unrelated files.</p>
10645: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10646: provides the target <code class="literal">error-check</code> that is added
10647: as a special dependency to all other targets that use
10648: <code class="varname">DELAYED_ERROR_MSG</code> or
10649: <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10650: <p>Then, the package-specific hacks from
10651: <code class="filename">hacks.mk</code> are included.</p>
10652: <p>Then, various other files follow. Most of them don't have
10653: any dependencies on what they need to have included before or
10654: after them, though some do.</p>
10655: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10656: <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10657: restricts the use of these variables to all the files that have
10658: been included before. Appearances in later files will be
10659: silently ignored.</p>
10660: <p>Then, the files for the main targets are included, in the
10661: order of later execution, though the actual order should not
10662: matter.</p>
10663: <p>At last, some more files are included that don't set any
10664: interesting variables but rather just define make targets to be
10665: executed.</p>
10666: </div>
10667: </div>
10668: </div>
1.41 asau 10669: <div class="chapter">
1.1 dsieger 10670: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10671: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1 dsieger 10672: <div class="toc">
10673: <p><b>Table of Contents</b></p>
10674: <dl>
1.6 rillig 10675: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10676: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10677: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1 dsieger 10678: <dd><dl>
1.6 rillig 10679: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10680: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1 dsieger 10681: </dl></dd>
10682: </dl>
10683: </div>
10684: <p>The pkgsrc infrastructure consists of a large codebase,
10685: and there are many corners where every little bit of a file is
10686: well thought out, making pkgsrc likely to fail as soon as
10687: anything is changed near those parts. To prevent most changes
10688: from breaking anything, a suite of regression tests should go
10689: along with every important part of the pkgsrc infrastructure.
10690: This chapter describes how regression tests work in pkgsrc and
10691: how you can add new tests.</p>
1.41 asau 10692: <div class="sect1">
1.1 dsieger 10693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10694: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1 dsieger 10695: <p></p>
10696: </div>
1.41 asau 10697: <div class="sect1">
1.1 dsieger 10698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10699: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1 dsieger 10700: <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.10 hubertf 10701: provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1 dsieger 10702: can simply run that command, which will run all tests in the
10703: <code class="filename">regress</code> category.</p>
10704: </div>
1.41 asau 10705: <div class="sect1">
1.1 dsieger 10706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10707: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1 dsieger 10708: <p>Every directory in the <code class="filename">regress</code>
10709: category that contains a file called <code class="filename">spec</code>
10710: is considered a regression test. This file is a shell program
1.10 hubertf 10711: that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1 dsieger 10712: The following functions can be overridden to suit your
10713: needs.</p>
1.41 asau 10714: <div class="sect2">
1.1 dsieger 10715: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10716: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1 dsieger 10717: <p>These functions do not take any parameters. They are all
1.23 wiz 10718: called in <span class="quote">“<span class="quote">set -e</span>”</span> mode, so you should be careful
1.1 dsieger 10719: to check the exitcodes of any commands you run in the
10720: test.</p>
1.41 asau 10721: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10722: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10723: <dd><p>This function prepares the environment for the
10724: test. By default it does nothing.</p></dd>
10725: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10726: <dd><p>This function runs the actual test. By default,
10727: it calls <code class="varname">TEST_MAKE</code> with the arguments
10728: <code class="varname">MAKEARGS_TEST</code> and writes its output including
10729: error messages into the file
10730: <code class="varname">TEST_OUTFILE</code>.</p></dd>
10731: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10732: <dd><p>This function is run after the test and is
10733: typically used to compare the actual output from the one that is
10734: expected. It can make use of the various helper functions from
10735: the next section.</p></dd>
10736: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10737: <dd><p>This function cleans everything up after the
10738: test has been run. By default it does nothing.</p></dd>
10739: </dl></div>
10740: </div>
1.41 asau 10741: <div class="sect2">
1.1 dsieger 10742: <div class="titlepage"><div><div><h3 class="title">
1.6 rillig 10743: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.41 asau 10744: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10745: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10746: <dd><p>This function compares the exitcode of the
1.10 hubertf 10747: <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1 dsieger 10748: If they differ, the test will fail.</p></dd>
10749: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10750: <dd><p>This function checks for each of its parameters
1.10 hubertf 10751: if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1 dsieger 10752: extended regular expression. If it does not, the test will
10753: fail.</p></dd>
10754: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10755: <dd><p>This function checks for each of its parameters
1.10 hubertf 10756: if the output from <span class="command"><strong>do_test()</strong></span> does
1.1 dsieger 10757: <span class="emphasis"><em>not</em></span> match the extended regular expression.
10758: If any of the regular expressions matches, the test will
10759: fail.</p></dd>
10760: </dl></div>
10761: </div>
10762: </div>
10763: </div>
1.41 asau 10764: <div class="chapter">
1.1 dsieger 10765: <div class="titlepage"><div><div><h2 class="title">
1.6 rillig 10766: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1 dsieger 10767: <div class="toc">
10768: <p><b>Table of Contents</b></p>
10769: <dl>
1.6 rillig 10770: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10771: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1 dsieger 10772: </dl>
10773: </div>
10774: <p>The pkgsrc system has already been ported to many
10775: operating systems, hardware architectures and compilers. This
10776: chapter explains the necessary steps to make pkgsrc even more
10777: portable.</p>
1.41 asau 10778: <div class="sect1">
1.1 dsieger 10779: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10780: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1 dsieger 10781: <p>To port pkgsrc to a new operating system (called
10782: <code class="literal">MyOS</code> in this example), you need to touch the
10783: following files:</p>
1.41 asau 10784: <div class="variablelist"><dl class="variablelist">
1.1 dsieger 10785: <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>
10786: <dd><p>This file contains some basic definitions, for
10787: example the name of the C
10788: compiler.</p></dd>
10789: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10790: <dd><p>Insert code that defines the variables
10791: <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10792: <code class="varname">LOWER_OS_VERSION</code>,
10793: <code class="varname">LOWER_VENDOR</code>,
10794: <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10795: <code class="varname">APPEND_ELF</code>, and the other variables that
10796: appear in this file.</p></dd>
10797: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10798: <dd><p>This file contains the platform-specific
10799: definitions that are used by pkgsrc. Start by copying one of the
10800: other files and edit it to your
10801: needs.</p></dd>
10802: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10803: <dd><p>This file contains a list of directories,
10804: together with their permission bits and ownership. These
10805: directories will be created automatically with every package
10806: that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10807: be removed.</p></dd>
10808: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10809: <dd><p>Just copy one of the pre-existing x11.dist files
10810: to your
10811: <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10812: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10813: <dd><p>On some operating systems, the tools that are
10814: provided with the base system are not good enough for pkgsrc.
1.29 dholland 10815: For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.1 dsieger 10816: narrow limit on the line length they can process. Therefore
10817: pkgsrc brings its own tools, which can be enabled
10818: here.</p></dd>
10819: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10820: <dd><p>This file defines the paths to all the tools
10821: that are needed by one or the other package in pkgsrc, as well
10822: as by pkgsrc itself. Find out where these tools are on your
10823: platform and add them.</p></dd>
10824: </dl></div>
10825: <p>Now, you should be able to build some basic packages, like
10826: <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>
10827: </div>
1.41 asau 10828: <div class="sect1">
1.1 dsieger 10829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6 rillig 10830: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1 dsieger 10831: <p>TODO</p>
10832: </div>
10833: </div>
10834: </div>
1.41 asau 10835: <div class="appendix">
10836: <div class="titlepage"><div><div><h1 class="title">
10837: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1 dsieger 10838: <div class="toc">
10839: <p><b>Table of Contents</b></p>
10840: <dl>
10841: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10842: <dd><dl>
10843: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10844: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10845: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23 wiz 10846: <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.1 dsieger 10847: </dl></dd>
10848: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10849: </dl>
10850: </div>
10851: <p>We checked to find a piece of software that wasn't in the packages
10852: collection, and picked GNU bison. Quite why someone would want to have
1.10 hubertf 10853: <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1 dsieger 10854: present in the tree is beyond us, but it's useful for the purposes of
10855: this exercise.</p>
1.41 asau 10856: <div class="sect1">
1.1 dsieger 10857: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10858: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41 asau 10859: <div class="sect2">
1.1 dsieger 10860: <div class="titlepage"><div><div><h3 class="title">
10861: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10862: <pre class="programlisting">
10863: # $NetBSD$
10864: #
10865:
10866: DISTNAME= bison-1.25
10867: CATEGORIES= devel
10868: MASTER_SITES= ${MASTER_SITE_GNU}
10869:
1.29 dholland 10870: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 10871: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
10872: COMMENT= GNU yacc clone
10873:
10874: GNU_CONFIGURE= yes
1.46 wiz 10875: INFO_FILES= yes
1.1 dsieger 10876:
10877: .include "../../mk/bsd.pkg.mk"
10878: </pre>
10879: </div>
1.41 asau 10880: <div class="sect2">
1.1 dsieger 10881: <div class="titlepage"><div><div><h3 class="title">
10882: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10883: <pre class="programlisting">
10884: GNU version of yacc. Can make re-entrant parsers, and numerous other
1.29 dholland 10885: improvements. Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1 dsieger 10886: of the NetBSD source tree is beyond me.
10887: </pre>
10888: </div>
1.41 asau 10889: <div class="sect2">
1.1 dsieger 10890: <div class="titlepage"><div><div><h3 class="title">
10891: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10892: <pre class="programlisting">
10893: @comment $NetBSD$
10894: bin/bison
10895: man/man1/bison.1.gz
10896: share/bison.simple
10897: share/bison.hairy
10898: </pre>
10899: </div>
1.41 asau 10900: <div class="sect2">
1.1 dsieger 10901: <div class="titlepage"><div><div><h3 class="title">
1.10 hubertf 10902: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1 dsieger 10903: </h3></div></div></div>
10904: <p>The NetBSD package system comes with
10905: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10906: which helps to check the contents of these
10907: files. After installation it is quite easy to use, just change to the
10908: directory of the package you wish to examine and execute
1.10 hubertf 10909: <span class="command"><strong>pkglint</strong></span>:</p>
1.1 dsieger 10910: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10911: looks fine.</pre>
10912: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10 hubertf 10913: more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1 dsieger 10914: -Wall</strong></span> for a very thorough check.</p>
10915: </div>
10916: </div>
1.41 asau 10917: <div class="sect1">
1.1 dsieger 10918: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10919: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10920: <p>Create the directory where the package lives,
10921: plus any auxiliary directories:</p>
10922: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10923: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10924: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10925: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10926: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10 hubertf 10927: <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.1 dsieger 10928: then continue with fetching the distfile:</p>
10929: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10930: >> bison-1.25.tar.gz doesn't seem to exist on this system.
10931: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10932: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10933: ftp: Error retrieving file: 500 Internal error
10934:
10935: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10936: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10937: ftp: Error retrieving file: 500 Internal error
10938:
10939: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10940: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10941: Successfully retrieved file.</pre>
10942: <p>Generate the checksum of the distfile into
10943: <code class="filename">distinfo</code>:</p>
10944: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10945: <p>Now compile:</p>
10946: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10947: >> Checksum OK for bison-1.25.tar.gz.
10948: ===> Extracting for bison-1.25
10949: ===> Patching for bison-1.25
10950: ===> Ignoring empty patch directory
10951: ===> Configuring for bison-1.25
10952: creating cache ./config.cache
10953: checking for gcc... cc
10954: checking whether we are using GNU C... yes
10955: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10956: checking how to run the C preprocessor... cc -E
10957: checking for minix/config.h... no
10958: checking for POSIXized ISC... no
10959: checking whether cross-compiling... no
10960: checking for ANSI C header files... yes
10961: checking for string.h... yes
10962: checking for stdlib.h... yes
10963: checking for memory.h... yes
10964: checking for working const... yes
10965: checking for working alloca.h... no
10966: checking for alloca... yes
10967: checking for strerror... yes
10968: updating cache ./config.cache
10969: creating ./config.status
10970: creating Makefile
10971: ===> Building for bison-1.25
10972: 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
10973: 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
10974: 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
10975: 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
10976: 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
10977: 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
10978: 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
10979: 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
10980: 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
10981: 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
10982: 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
10983: 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
10984: 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
10985: 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
10986: 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
10987: 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
10988: 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
10989: 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
10990: 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
10991: 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
10992: 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
10993: 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
10994: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10995: rm -f bison.s1
10996: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1</pre>
10997: <p>Everything seems OK, so install the files:</p>
10998: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10999: >> Checksum OK for bison-1.25.tar.gz.
11000: ===> Installing for bison-1.25
11001: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
11002: rm -f /usr/pkg/bin/bison
11003: cd /usr/pkg/share; rm -f bison.simple bison.hairy
11004: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
11005: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
11006: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
11007: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
11008: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
11009: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
11010: ===> Registering installation for bison-1.25</pre>
11011: <p>You can now use bison, and also - if you decide so - remove it with
1.10 hubertf 11012: <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1 dsieger 11013: binary package, do this now:</p>
11014: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11015: >> Checksum OK for bison-1.25.tar.gz.
11016: ===> Building package for bison-1.25
11017: Creating package bison-1.25.tgz
11018: Registering depends:.
11019: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
11020: <p>Now that you don't need the source and object files
11021: any more, clean up:</p>
11022: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
11023: ===> Cleaning for bison-1.25</pre>
11024: </div>
11025: </div>
1.41 asau 11026: <div class="appendix">
11027: <div class="titlepage"><div><div><h1 class="title">
11028: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1 dsieger 11029: <div class="toc">
11030: <p><b>Table of Contents</b></p>
11031: <dl>
11032: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
11033: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
11034: </dl>
11035: </div>
1.41 asau 11036: <div class="sect1">
1.1 dsieger 11037: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11038: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
11039: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
11040: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11041: => figlet221.tar.gz doesn't seem to exist on this system.
11042: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
11043: => [172219 bytes]
11044: Connected to ftp.plig.net.
11045: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
11046: 331 Guest login ok, send your complete e-mail address as password.
11047: 230-You are user #5 of 500 simultaneous users allowed.
11048: 230-
11049: 230- ___ _ _ _
11050: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
11051: 230- | _| _| . |_| . | | | . |_| . | _| . |
11052: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
11053: 230- |_| |_| |___| |___|
11054: 230-
11055: 230-** Welcome to ftp.plig.org **
11056: 230-
11057: 230-Please note that all transfers from this FTP site are logged. If you
11058: 230-do not like this, please disconnect now.
11059: 230-
1.18 snj 11060: 230-This archive is available via
1.1 dsieger 11061: 230-
11062: 230-HTTP: http://ftp.plig.org/
11063: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
11064: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
11065: 230-
11066: 230-Please email comments, bug reports and requests for packages to be
11067: 230-mirrored to ftp-admin@plig.org.
11068: 230-
11069: 230-
11070: 230 Logged in anonymously.
11071: Remote system type is UNIX.
11072: Using binary mode to transfer files.
11073: 200 Type okay.
11074: 250 "/pub" is new cwd.
11075: 250-"/pub/figlet" is new cwd.
11076: 250-
11077: 250-Welcome to the figlet archive at ftp.figlet.org
11078: 250-
11079: 250- ftp://ftp.figlet.org/pub/figlet/
11080: 250-
11081: 250-The official FIGlet web page is:
11082: 250- http://www.figlet.org/
11083: 250-
11084: 250-If you have questions, please mailto:info@figlet.org. If you want to
11085: 250-contribute a font or something else, you can email us.
11086: 250
11087: 250 "/pub/figlet/program" is new cwd.
11088: 250 "/pub/figlet/program/unix" is new cwd.
11089: local: figlet221.tar.gz remote: figlet221.tar.gz
11090: 502 Unimplemented command.
11091: 227 Entering Passive Mode (195,40,6,41,246,104)
11092: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
11093: 38% |************** | 65800 64.16 KB/s 00:01 ETA
11094: 226 Transfer completed.
11095: 172219 bytes received in 00:02 (75.99 KB/s)
11096: 221 Goodbye.
11097: => Checksum OK for figlet221.tar.gz.
11098: ===> Extracting for figlet-2.2.1nb2
11099: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
11100: ===> Patching for figlet-2.2.1nb2
11101: ===> Applying pkgsrc patches for figlet-2.2.1nb2
11102: ===> Overriding tools for figlet-2.2.1nb2
11103: ===> Creating toolchain wrappers for figlet-2.2.1nb2
11104: ===> Configuring for figlet-2.2.1nb2
11105: ===> Building for figlet-2.2.1nb2
11106: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
11107: chmod a+x figlet
11108: gcc -O2 -o chkfont chkfont.c
11109: => Unwrapping files-to-be-installed.
11110: <code class="prompt">#</code>
11111: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
11112: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11113: ===> Installing for figlet-2.2.1nb2
11114: install -d -o root -g wheel -m 755 /usr/pkg/bin
11115: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
11116: mkdir -p /usr/pkg/share/figlet
11117: cp figlet /usr/pkg/bin
11118: cp chkfont /usr/pkg/bin
11119: chmod 555 figlist showfigfonts
11120: cp figlist /usr/pkg/bin
11121: cp showfigfonts /usr/pkg/bin
11122: cp fonts/*.flf /usr/pkg/share/figlet
11123: cp fonts/*.flc /usr/pkg/share/figlet
11124: cp figlet.6 /usr/pkg/man/man6
11125: ===> Registering installation for figlet-2.2.1nb2
11126: <code class="prompt">#</code></pre>
11127: </div>
1.41 asau 11128: <div class="sect1">
1.1 dsieger 11129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11130: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
11131: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
11132: ===> Checking for vulnerabilities in figlet-2.2.1nb2
11133: ===> Packaging figlet-2.2.1nb2
11134: ===> Building binary package for figlet-2.2.1nb2
11135: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
11136: Using SrcDir value of /usr/pkg
11137: Registering depends:.
11138: <code class="prompt">#</code></pre>
11139: </div>
11140: </div>
1.41 asau 11141: <div class="appendix">
11142: <div class="titlepage"><div><div><h1 class="title">
11143: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1 dsieger 11144: <div class="toc">
11145: <p><b>Table of Contents</b></p>
11146: <dl>
1.23 wiz 11147: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
11148: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
11149: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
11150: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
11151: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
11152: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11153: source packages</a></span></dt>
11154: </dl>
11155: </div>
11156: <p>As in other big projects, the directory layout of pkgsrc
11157: is quite complex for newbies. This chapter explains where you
11158: find things on the FTP server. The base directory on
1.10 hubertf 11159: <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.1 dsieger 11160: On other servers it may be different, but inside this directory,
11161: everything should look the same, no matter on which server you
11162: are. This directory contains some subdirectories, which are
11163: explained below.</p>
1.41 asau 11164: <div class="sect1">
1.1 dsieger 11165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11166: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1 dsieger 11167: <p>The directory <code class="filename">distfiles</code> contains lots
11168: of archive files from all pkgsrc packages, which are mirrored
11169: here. The subdirectories are called after their package names
11170: and are used when the distributed files have names that don't
11171: explicitly contain a version number or are otherwise too generic
11172: (for example <code class="filename">release.tar.gz</code>).</p>
11173: </div>
1.41 asau 11174: <div class="sect1">
1.1 dsieger 11175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11176: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1 dsieger 11177: <p>This directory contains things that individual pkgsrc
11178: developers find worth publishing.</p>
11179: </div>
1.41 asau 11180: <div class="sect1">
1.1 dsieger 11181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11182: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3 rillig 11183: <p>This directory contains binary packages for the various
11184: platforms that are supported by pkgsrc.
11185: 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>
1.41 asau 11186: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11187: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9 rillig 11188: operating system for which the packages have been built. The
1.10 hubertf 11189: name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9 rillig 11190: command, so it may differ from the one you are used to
11191: hear.</p></li>
1.23 wiz 11192: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8 rillig 11193: architecture of the platform for which the packages have been
1.10 hubertf 11194: built. It also includes the <code class="varname">ABI</code> (Application
11195: Binary Interface) for platforms that have several of
11196: them.</p></li>
1.23 wiz 11197: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8 rillig 11198: the operating system. For version numbers that change often (for
11199: example NetBSD-current), the often-changing part should be
11200: replaced with an <code class="literal">x</code>, for example
11201: <code class="literal">4.99.x</code>.</p></li>
1.23 wiz 11202: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22 jakllsch 11203: <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8 rillig 11204: for a stable branch, or <code class="literal">head</code> for packages
11205: built from the HEAD branch. The latter should only be used when
11206: the packages are updated on a regular basis. Otherwise the date
11207: from checking out pkgsrc should be appended, for example
11208: <code class="literal">head_20071015</code>.</p></li>
1.3 rillig 11209: </ul></div>
11210: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
11211: can quickly click through the directories on the
11212: server and find the best binary packages for their machines. Since they
11213: usually know the operating system and the hardware architecture, OPSYS
11214: and ARCH are placed first. After these choices, they can select the
11215: best combination of OSVERSION and TAG together, since it is usually the
11216: case that packages stay compatible between different version of the
11217: operating system.</p>
11218: <p>In each of these directories, there is a
11219: whole binary packages collection for a specific platform. It has a directory called
1.1 dsieger 11220: <code class="filename">All</code> which contains all binary packages.
11221: Besides that, there are various category directories that
11222: contain symbolic links to the real binary packages.</p>
11223: </div>
1.41 asau 11224: <div class="sect1">
1.1 dsieger 11225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11226: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8 rillig 11227: <p>Here are the reports from bulk builds, for those who want
11228: to fix packages that didn't build on some of the platforms. The
1.23 wiz 11229: structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, “<code class="filename">packages</code>: Binary packages”</a>.</p>
1.8 rillig 11230: </div>
1.41 asau 11231: <div class="sect1">
1.8 rillig 11232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22 jakllsch 11233: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
11234: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1 dsieger 11235: source packages</h2></div></div></div>
1.23 wiz 11236: <p>These directories contain the <span class="quote">“<span class="quote">real</span>”</span> pkgsrc,
1.1 dsieger 11237: that is the files that define how to create binary packages from
11238: source archives.</p>
11239: <p>The directory <code class="filename">pkgsrc</code> contains a
11240: snapshot of the CVS repository, which is updated regularly. The
11241: file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11242: directory, ready to be downloaded as a whole.</p>
11243: <p>In the directories for the quarterly branches, there is an
11244: additional file called
1.22 jakllsch 11245: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1 dsieger 11246: which contains the state of pkgsrc when it was branched.</p>
11247: </div>
11248: </div>
1.41 asau 11249: <div class="appendix">
11250: <div class="titlepage"><div><div><h1 class="title">
11251: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1 dsieger 11252: <div class="toc">
11253: <p><b>Table of Contents</b></p>
11254: <dl>
11255: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11256: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11257: </dl>
11258: </div>
11259: <p>This section contains information on editing the pkgsrc
11260: guide itself.</p>
1.41 asau 11261: <div class="sect1">
1.1 dsieger 11262: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11263: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11264: <p>The pkgsrc guide's source code is stored in
11265: <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11266: are created from it:</p>
1.41 asau 11267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23 wiz 11268: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11269: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11270: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11271: <li class="listitem"><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.1 dsieger 11272: The PDF version of the pkgsrc guide.</p></li>
1.23 wiz 11273: <li class="listitem"><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.1 dsieger 11274: PostScript version of the pkgsrc guide.</p></li>
11275: </ul></div>
11276: </div>
1.41 asau 11277: <div class="sect1">
1.1 dsieger 11278: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11279: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11280: <p>The procedure to edit the pkgsrc guide is:</p>
1.23 wiz 11281: <div class="procedure"><ol class="procedure" type="1">
1.41 asau 11282: <li class="step"><p>Make sure you have the packages needed to
1.1 dsieger 11283: regenerate the pkgsrc guide (and other XML-based NetBSD
1.45 obache 11284: documentation) installed. These are automatically installed when
11285: you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41 asau 11286: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1 dsieger 11287: right directory. All further steps will take place
11288: here.</p></li>
1.41 asau 11289: <li class="step"><p>Edit the XML file(s) in
1.1 dsieger 11290: <code class="filename">files/</code>.</p></li>
1.41 asau 11291: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1 dsieger 11292: guide for valid XML and to build the final output files. If you
11293: get any errors at this stage, you can just edit the files, as
11294: there are only symbolic links in the working directory, pointing
11295: to the files in <code class="filename">files/</code>.</p></li>
1.41 asau 11296: <li class="step"><p><span class="command"><strong>(cd files && cvs
1.1 dsieger 11297: commit)</strong></span></p></li>
1.41 asau 11298: <li class="step"><p>Run <span class="command"><strong>bmake clean && bmake</strong></span> to
1.1 dsieger 11299: regenerate the output files with the proper RCS
11300: Ids.</p></li>
1.41 asau 11301: <li class="step">
1.10 hubertf 11302: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1 dsieger 11303: commit the files in both <code class="filename">pkgsrc/doc</code> and
11304: <code class="filename">htdocs</code>.</p>
1.41 asau 11305: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1 dsieger 11306: <h3 class="title">Note</h3>
11307: <p>If you have added, removed or renamed some chapters,
1.10 hubertf 11308: you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11309: <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1 dsieger 11310: directory.</p>
11311: </div>
11312: </li>
11313: </ol></div>
11314: </div>
11315: </div>
11316: </div></body>
11317: </html>
CVSweb <webmaster@jp.NetBSD.org>